Plugins » History » Revision 87

Revision 86 (Guido Heymann, 2012-05-22 15:50) → Revision 87/118 (Jean-Philippe Lang, 2012-05-28 09:45)

h1. Plugins 

 Redmine plugins rely on "Rails engines" to add functionalities to the application. 

 h2. Plugin list 

 A full list of available Redmine plugins can be found at the "Plugin Directory":/plugins. 

 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": 

 h2. Installing a plugin 

 1. Copy your plugin directory into @#{RAILS_ROOT}/vendor/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:// 

 2. If the plugin requires a migration, run the following command to upgrade your database (make a db backup before): 

   rake db:migrate_plugins RAILS_ENV=production 

 3. Restart Redmine 

 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). 

 h2. Uninstalling a plugin 

 1. If the plugin required a migration, run the following command to downgrade your database (make a db backup before): 

   rake db:migrate:plugin NAME=plugin_name VERSION=0 RAILS_ENV=production 

 2. Remove your plugin from @#{RAILS_ROOT}/vendor/plugins@. 

 3. Restart Redmine 

 h2. Writing plugins 

 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. 
 More (general) developer information can be found in the [[Guide#Developer-guide|Redmine Developer Guide]].