Plugins » History » Version 117
Go MAEDA, 2018-10-15 04:39
Removed instructions for Redmine 1.x.
1 | 1 | Jean-Philippe Lang | h1. Plugins |
---|---|---|---|
2 | |||
3 | 85 | Mischa The Evil | h2. Plugin list |
4 | |||
5 | A full list of available Redmine plugins can be found at the "Plugin Directory":/plugins. |
||
6 | |||
7 | 115 | Seppe Stas | More plugins (some in very early development), which are not listed at the "Plugin Directory":/plugins but are publicly available on "GitHub":https://github.com can be found using a "search like this":https://github.com/search?type=Repositories&language=&q=redmine&repo=&langOverride=&x=0&y=0&start_value=1. |
8 | 85 | Mischa The Evil | |
9 | 1 | Jean-Philippe Lang | h2. Installing a plugin |
10 | |||
11 | 117 | Go MAEDA | 1. Copy your plugin directory into @#{RAILS_ROOT}/plugins@. If you are downloading the plugin directly from GitHub, you can do so by changing into your plugin directory and issuing a command like @git clone git://github.com/user_name/name_of_the_plugin.git@. |
12 | 1 | Jean-Philippe Lang | |
13 | 111 | Nicolas Rodriguez | 2. If the plugin requires a migration, run the following command in @#{RAILS_ROOT}@ to upgrade your database (make a db backup before). |
14 | 99 | Eduardo Machado | |
15 | 116 | Kenan Dervisevic | <pre><code class="ruby">bundle exec rake redmine:plugins:migrate RAILS_ENV=production</code></pre> |
16 | 1 | Jean-Philippe Lang | |
17 | 81 | Jean-Philippe Lang | 3. Restart Redmine |
18 | 1 | Jean-Philippe Lang | |
19 | You should now be able to see the plugin list in _Administration -> Plugins_ and configure the newly installed plugin (if the plugin requires to be configured). |
||
20 | 30 | Jean-Philippe Lang | |
21 | 1 | Jean-Philippe Lang | h2. Uninstalling a plugin |
22 | 83 | Tony Marschall | |
23 | 1. If the plugin required a migration, run the following command to downgrade your database (make a db backup before): |
||
24 | 102 | Anonymous | |
25 | <pre><code class="ruby">bundle exec rake redmine:plugins:migrate NAME=plugin_name VERSION=0 RAILS_ENV=production</code></pre> |
||
26 | 1 | Jean-Philippe Lang | |
27 | 117 | Go MAEDA | 2. Remove your plugin from the plugins folder: @#{RAILS_ROOT}/plugins@. |
28 | 61 | Mischa The Evil | |
29 | 80 | Jean-Philippe Lang | 3. Restart Redmine |
30 | 38 | Mischa The Evil | |
31 | 16 | Jean-Philippe Lang | h2. Writing plugins |
32 | 1 | Jean-Philippe Lang | |
33 | 73 | Mischa The Evil | There is a step-by-step [[Plugin_Tutorial|tutorial]] about writing a plugin. Some more (detailed) information is collected and stored in the "[[Plugin_Internals|plugin internals]]" page. |
34 | 77 | Felix Schäfer | More (general) developer information can be found in the [[Guide#Developer-guide|Redmine Developer Guide]]. |
35 | 92 | Terence Mill | |
36 | 94 | Terence Mill | h2. Migrating Plugins |
37 | 92 | Terence Mill | |
38 | 94 | Terence Mill | There are changes in Plugins API or new Rails requirements which need to be considered if you want to use plugin from prior version of redmine. |
39 | In any case it's proposed to update and migrate redmine core system first without plugins and then if stable try to drop in one by one, to know where problems come from if any. |
||
40 | 93 | Terence Mill | |
41 | 113 | Toshi MARUYAMA | Consideration towards plugins which *overwrite views* completely because of bad coding style or there is no "hook" available shall be made in any case. Maybe you can collect and write down plugin references here which are of this type. |
42 | 93 | Terence Mill | |
43 | Let's start with.. |
||
44 | |||
45 | 96 | Terence Mill | * "Redmine_blocks":/plugins/redmine_blocks |
46 | 93 | Terence Mill | |
47 | 92 | Terence Mill | h3. Redmine 1.3 > 1.4 |
48 | |||
49 | * routes.rb which defines url to controller (parameter, action) mapping must be created in <plugin>/config/routes.rb |
||
50 | * @ARCondition@ is gone with no replacement |
||
51 | * @TabularFormBuilder@ is now @Redmine::Views::LabelledFormBuilder@ |
||
52 | * defining your own context menus now requires @helper :context_menus@ in the respective controller |
||
53 | * of course, @returning@ is deprecated in favor of @tap@ |
||
54 | * if you're doing anything with repos check it twice, because there can be multiple repos now per project |
||
55 | 97 | Jan from Planio www.plan.io | * @Project#visible_by@ is deprecated and replaced by @Project#visible_condition@ |
56 | 1 | Jean-Philippe Lang | |
57 | 100 | Jan from Planio www.plan.io | |
58 | 92 | Terence Mill | h3. Redmine 1.4 > 2.x |
59 | 103 | Terence Mill | |
60 | * "Writing plugins compatible with both Redmine 1.x and 2.x - some tips":/boards/3/topics/31445 |
||
61 | |||
62 | h3. Writing Redmine 2.x plugins |
||
63 | |||
64 | * "Tutorial":http://www.gogolek.co.uk/blog/2012/09/writing-redmine-2-x-plugins-tutorial/ |