Project

General

Profile

Plugins » History » Version 113

Toshi MARUYAMA, 2016-08-08 06:10
fix typo

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 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":http://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.
8 85 Mischa The Evil
9 1 Jean-Philippe Lang
h2. Installing a plugin
10
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://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 1 Jean-Philippe Lang
15 99 Eduardo Machado
2.1. For Redmine 1.x:
16
17 112 Toshi MARUYAMA
  bundle exec rake db:migrate_plugins RAILS_ENV=production
18 99 Eduardo Machado
19
2.2. For Redmine 2.x:
20
21 112 Toshi MARUYAMA
  bundle exec 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
28
29
1. If the plugin required a migration, run the following command to downgrade your database (make a db backup before):
30
31 102 Anonymous
1.1. For Redmine 1.x: 
32
33 112 Toshi MARUYAMA
  bundle exec rake db:migrate:plugin NAME=plugin_name VERSION=0 RAILS_ENV=production
34 102 Anonymous
35
1.2. For Redmine 2.x:
36
37 112 Toshi MARUYAMA
  bundle exec rake redmine:plugins:migrate NAME=plugin_name VERSION=0 RAILS_ENV=production
38 1 Jean-Philippe Lang
39 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)..
40 61 Mischa The Evil
41 80 Jean-Philippe Lang
3. Restart Redmine
42 38 Mischa The Evil
43 16 Jean-Philippe Lang
h2. Writing plugins
44 1 Jean-Philippe Lang
45 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.
46 77 Felix Schäfer
More (general) developer information can be found in the [[Guide#Developer-guide|Redmine Developer Guide]].
47 92 Terence Mill
48 94 Terence Mill
h2. Migrating Plugins
49 92 Terence Mill
50 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.
51
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.
52 93 Terence Mill
53 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.
54 93 Terence Mill
55
Let's start with..
56
57 96 Terence Mill
* "Redmine_blocks":/plugins/redmine_blocks
58 93 Terence Mill
59 92 Terence Mill
h3. Redmine 1.3 > 1.4
60
61
* routes.rb which defines url to controller (parameter, action) mapping must be created in <plugin>/config/routes.rb
62
* @ARCondition@ is gone with no replacement
63
* @TabularFormBuilder@ is now @Redmine::Views::LabelledFormBuilder@
64
* defining your own context menus now requires @helper :context_menus@ in the respective controller
65
* of course, @returning@ is deprecated in favor of @tap@
66
* if you're doing anything with repos check it twice, because there can be multiple repos now per project
67 97 Jan from Planio www.plan.io
* @Project#visible_by@ is deprecated and replaced by @Project#visible_condition@
68 1 Jean-Philippe Lang
69 100 Jan from Planio www.plan.io
70 92 Terence Mill
h3. Redmine 1.4 > 2.x
71 103 Terence Mill
72
* "Writing plugins compatible with both Redmine 1.x and 2.x - some tips":/boards/3/topics/31445
73
74
h3. Writing Redmine 2.x plugins
75
76
* "Tutorial":http://www.gogolek.co.uk/blog/2012/09/writing-redmine-2-x-plugins-tutorial/