Project

General

Profile

Plugins » History » Version 30

Jean-Philippe Lang, 2008-12-30 12:21

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 30 Jean-Philippe Lang
1. If you're using a 0.7.x release, you need to install the "Rails engines plugin":http://rails-engines.org/ (make sure to get the Rails 2.0.2 version). As of 0.8.0, Rails engines is included in Redmine, so skip this step unless you're using an older Redmine version.
8 1 Jean-Philippe Lang
9 30 Jean-Philippe Lang
<pre>
10
ruby script/plugin install http://svn.rails-engines.org/engines/tags/rel_2.0.0/
11
mv vendor/plugins/rel_2.0.0 vendor/plugins/engines
12
</pre>
13 1 Jean-Philippe Lang
14
2. Then, copy your plugin directory into @#{RAILS_ROOT}/vendor/plugins@.
15
16
3. If the plugin requires a migration, run the following command to upgrade your database (make a db backup before):
17
18
  rake db:migrate_plugins
19
20
4. Start Redmine
21
22 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).
23 1 Jean-Philippe Lang
24
h2. Plugin list
25
26 27 Eric Davis
* [[PluginBulkTimeEntry|Bulk Time Entry]] is a plugin to enter multiple time entries at one time.
27 21 Eric Davis
* [[PluginBudget|Budget]] is a plugin to manage the set of deliverables for each project, automatically calculating key performance indicators.
28 10 Eric Davis
* [[PluginCustomer|Customer]] is plugin to track basic customer information and to see which project belonged to a customer.
29 15 Jean-Philippe Lang
* [[PluginEmbedded|Embedded]] lets you embed HTML files (eg. auto generated documentation, test reports) in your projects.
30 28 Eric Davis
* [[PluginExceptionHandler|Exception Handler]] will allow Redmine to send emails when an exception or error occurs.
31 17 Chaoqun Zou
* [[PluginEzfaq|ezFAQ]] is a FAQ management plugin for Redmine.
32 24 Chaoqun Zou
* [[PluginEzlibrarian|ezLibrarian]] is a book shelf management plugin designed for use in company or department.
33 25 Eric Davis
* [[PluginGoogleAnalytics|Google Analytics]] is a simple plugin to include a Google Analytics tracking code within Redmine.
34 9 Eric Davis
* [[PluginGoogleCalendar|Google Calendar]] is a simple plugin to include Google Calendar iframe as a tab within Redmine projects.
35 6 Eric Davis
* [[PluginProjectScores|Project Scores]] is plugin which will let a user score a project on different criteria.
36 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)
37 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.
38 29 Eric Davis
* [[PluginSystemNotification|System Notification]] is a plugin that will allow an Administrator to send notification emails to recently logged in users.
39 5 Jean-Philippe Lang
* [[PluginTimesheet|Timesheet]] is plugin to show and filter timelogs across all projects in Redmine.
40 16 Jean-Philippe Lang
41
h2. Writing plugins
42
43 22 Thomas Lecavelier
See the [[Plugin_Tutorial|Plugin API]].