Project

General

Profile

Plugins » History » Version 83

Tony Marschall, 2011-11-16 19:12
Added uninstall

1 1 Jean-Philippe Lang
h1. Plugins
2
3 30 Jean-Philippe Lang
Redmine plugins rely on "Rails engines":http://rails-engines.org/ to add functionalities to the application.
4 1 Jean-Philippe Lang
5
h2. Installing a plugin
6
7 81 Jean-Philippe Lang
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://github.com/user_name/name_of_the_plugin.git@.
8 1 Jean-Philippe Lang
9 81 Jean-Philippe Lang
2. If the plugin requires a migration, run the following command to upgrade your database (make a db backup before):
10 1 Jean-Philippe Lang
11 82 Anton Hedström
  rake db:migrate_plugins RAILS_ENV=production
12 1 Jean-Philippe Lang
13 81 Jean-Philippe Lang
3. Restart Redmine
14 1 Jean-Philippe Lang
15 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).
16 1 Jean-Philippe Lang
17 83 Tony Marschall
h2. Uninstalling a plugin
18
19
1. If the plugin required a migration, run the following command to downgrade your database (make a db backup before):
20
21
  rake db:migrate:plugin NAME=plugin_name VERSION=0 RAILS_ENV=production
22
23
2. Remove your plugin from @#{RAILS_ROOT}/vendor/plugins@.
24
25
26 1 Jean-Philippe Lang
h2. Plugin list
27
28 80 Jean-Philippe Lang
A full list of available Redmine plugins can be found at the "Plugin Directory":/plugins.
29 61 Mischa The Evil
30 80 Jean-Philippe Lang
More plugins (some in very early development), which are not listed at the "Plugin Directory":/plugins but are publicly available on "GitHub":http://www.github.org, can be found using a "search like this":http://github.com/search?type=Repositories&language=&q=redmine&repo=&langOverride=&x=0&y=0&start_value=1.
31 38 Mischa The Evil
32 16 Jean-Philippe Lang
h2. Writing plugins
33 1 Jean-Philippe Lang
34 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.
35 77 Felix Schäfer
More (general) developer information can be found in the [[Guide#Developer-guide|Redmine Developer Guide]].