Project

General

Profile

Plugins » History » Version 28

Eric Davis, 2008-11-21 01:54
Adding PluginExceptionHandler

1 1 Jean-Philippe Lang
h1. Plugins
2
3 23 Thomas Lecavelier
Since version 0.6.0, Redmine provides basic support for plugins. Redmine plugins can 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 18 Jean-Philippe Lang
1. First, you need to install the Rails engines plugin if you're using a 0.7.x release (make sure to get the Rails 2.0.2 version): http://rails-engines.org/.
8 12 Eric Davis
9 14 Eric Davis
   ruby script/plugin install http://svn.rails-engines.org/engines/tags/rel_2.0.0/
10
   mv vendor/plugins/rel_2.0.0 vendor/plugins/engines
11 1 Jean-Philippe Lang
12
2. Then, copy your plugin directory into @#{RAILS_ROOT}/vendor/plugins@.
13
14
3. If the plugin requires a migration, run the following command to upgrade your database (make a db backup before):
15
16
  rake db:migrate_plugins
17
18
4. Start Redmine
19
20
You should now be able to see the plugin list in 'Admin -> Information' and configure the newly installed plugin (if the plugin requires to be configured).
21
22
h2. Plugin list
23
24 27 Eric Davis
* [[PluginBulkTimeEntry|Bulk Time Entry]] is a plugin to enter multiple time entries at one time.
25 21 Eric Davis
* [[PluginBudget|Budget]] is a plugin to manage the set of deliverables for each project, automatically calculating key performance indicators.
26 10 Eric Davis
* [[PluginCustomer|Customer]] is plugin to track basic customer information and to see which project belonged to a customer.
27 15 Jean-Philippe Lang
* [[PluginEmbedded|Embedded]] lets you embed HTML files (eg. auto generated documentation, test reports) in your projects.
28 28 Eric Davis
* [[PluginExceptionHandler|Exception Handler]] will allow Redmine to send emails when an exception or error occurs.
29 17 Chaoqun Zou
* [[PluginEzfaq|ezFAQ]] is a FAQ management plugin for Redmine.
30 24 Chaoqun Zou
* [[PluginEzlibrarian|ezLibrarian]] is a book shelf management plugin designed for use in company or department.
31 25 Eric Davis
* [[PluginGoogleAnalytics|Google Analytics]] is a simple plugin to include a Google Analytics tracking code within Redmine.
32 9 Eric Davis
* [[PluginGoogleCalendar|Google Calendar]] is a simple plugin to include Google Calendar iframe as a tab within Redmine projects.
33 6 Eric Davis
* [[PluginProjectScores|Project Scores]] is plugin which will let a user score a project on different criteria.
34 26 Jean-Philippe Lang
* "RD formatter":http://github.com/yugui/redmine_rd_formatter/tree/master adds Ruby Doc text formatting capability to Redmine (requires Redmine r1955 or above)
35 5 Jean-Philippe Lang
* [[PluginSimpleCI|Simple CI]] is a generic plugin for integrating per project RSS continuous integration feeds (eg. "Cruise Control":http://cruisecontrol.sourceforge.net/) in Redmine.
36
* [[PluginTimesheet|Timesheet]] is plugin to show and filter timelogs across all projects in Redmine.
37 16 Jean-Philippe Lang
38
h2. Writing plugins
39
40 22 Thomas Lecavelier
See the [[Plugin_Tutorial|Plugin API]].