Plugins » History » Version 100

Jan from Planio, 2012-08-10 21:00

1 1 Jean-Philippe Lang
h1. Plugins
3 85 Mischa The Evil
h2. Plugin list
A full list of available Redmine plugins can be found at the "Plugin Directory":/plugins.
7 89 Sergey Kolchenko
More plugins (some in very early development), which are not listed at the "Plugin Directory":/plugins but are publicly available on "GitHub":, can be found using a "search like this":
8 85 Mischa The Evil
9 1 Jean-Philippe Lang
h2. Installing a plugin
11 88 Jean-Philippe Lang
1. Copy your plugin directory into @#{RAILS_ROOT}/plugins@ (Redmine 2.x) or @#{RAILS_ROOT}/vendor/plugins@ (Redmine 1.x). 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://
12 1 Jean-Philippe Lang
13 99 Eduardo Machado
2. If the plugin requires a migration, run the following command to upgrade your database (make a db backup before).
14 1 Jean-Philippe Lang
15 99 Eduardo Machado
2.1. For Redmine 1.x:
17 1 Jean-Philippe Lang
  rake db:migrate_plugins RAILS_ENV=production
18 99 Eduardo Machado
2.2. For Redmine 2.x:
  rake redmine:plugins:migrate RAILS_ENV=production
22 1 Jean-Philippe Lang
23 81 Jean-Philippe Lang
3. Restart Redmine
24 1 Jean-Philippe Lang
25 30 Jean-Philippe Lang
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).
26 1 Jean-Philippe Lang
27 83 Tony Marschall
h2. Uninstalling a plugin
1. If the plugin required a migration, run the following command to downgrade your database (make a db backup before):
31 1 Jean-Philippe Lang
  rake db:migrate:plugin NAME=plugin_name VERSION=0 RAILS_ENV=production
33 88 Jean-Philippe Lang
2. Remove your plugin from the plugins folder: @#{RAILS_ROOT}/plugins@ (Redmine 2.x) or @#{RAILS_ROOT}/vendor/plugins@ (Redmine 1.x)..
34 61 Mischa The Evil
35 80 Jean-Philippe Lang
3. Restart Redmine
36 38 Mischa The Evil
37 16 Jean-Philippe Lang
h2. Writing plugins
38 1 Jean-Philippe Lang
39 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.
40 77 Felix Schäfer
More (general) developer information can be found in the [[Guide#Developer-guide|Redmine Developer Guide]].
41 92 Terence Mill
42 94 Terence Mill
h2. Migrating Plugins
43 92 Terence Mill
44 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.
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.
46 93 Terence Mill
47 95 Terence Mill
Consideration towards plugins which *overwrite views* completly 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.
48 93 Terence Mill
Let's start with..
51 96 Terence Mill
* "Redmine_blocks":/plugins/redmine_blocks
52 93 Terence Mill
54 92 Terence Mill
h3. Redmine 1.3 > 1.4
* routes.rb which defines url to controller (parameter, action) mapping must be created in <plugin>/config/routes.rb
* @ARCondition@ is gone with no replacement
* @TabularFormBuilder@ is now @Redmine::Views::LabelledFormBuilder@
* defining your own context menus now requires @helper :context_menus@ in the respective controller
* of course, @returning@ is deprecated in favor of @tap@
* if you're doing anything with repos check it twice, because there can be multiple repos now per project
62 97 Jan from Planio
* @Project#visible_by@ is deprecated and replaced by @Project#visible_condition@
63 92 Terence Mill
64 100 Jan from Planio
_For most of our "Redmine Hosting": Planio Enterprise clients, we have recently completed the "upgrade to Redmine 1.4.4": and have migrated a number of plugins. You can find our forks on "Github": If you still find bugs, please "let us know": and we'll have a look._
66 92 Terence Mill
h3. Redmine 1.4 > 2.x
67 98 Terence Mill
h3. "Writing plugins compatible with both Redmine 1.x and 2.x - some tips":/boards/3/topics/31445