Project

General

Profile

Plugins » History » Version 43

Mischa The Evil, 2009-03-30 23:50
Added link to plugin internals wikipage

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 42 Jean-Philippe Lang
  rake db:migrate_plugins RAILS_ENV=production
19 1 Jean-Philippe Lang
20 32 Mischa The Evil
4. Restart Redmine
21 1 Jean-Philippe Lang
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 31 Mischa The Evil
The list below contains the plugins from authors who requested to add them here or who are having the contributer-role on the Redmine-project themself.
27
28 37 Jean-Philippe Lang
* [[BotsFilterPlugin]] prevents common bots from crawling various urls.
29 27 Eric Davis
* [[PluginBulkTimeEntry|Bulk Time Entry]] is a plugin to enter multiple time entries at one time.
30 21 Eric Davis
* [[PluginBudget|Budget]] is a plugin to manage the set of deliverables for each project, automatically calculating key performance indicators.
31 33 Mischa The Evil
* [[PluginCollapse|Collapse]] is a plugin which transforms the default Redmine sidebar into a collapsible sidebar.
32
* [[PluginCustomer|Customer]] is a plugin to track basic customer information and to see which project belonged to a customer.
33 15 Jean-Philippe Lang
* [[PluginEmbedded|Embedded]] lets you embed HTML files (eg. auto generated documentation, test reports) in your projects.
34 28 Eric Davis
* [[PluginExceptionHandler|Exception Handler]] will allow Redmine to send emails when an exception or error occurs.
35 17 Chaoqun Zou
* [[PluginEzfaq|ezFAQ]] is a FAQ management plugin for Redmine.
36 24 Chaoqun Zou
* [[PluginEzlibrarian|ezLibrarian]] is a book shelf management plugin designed for use in company or department.
37 1 Jean-Philippe Lang
* [[PluginGoogleAnalytics|Google Analytics]] is a simple plugin to include a Google Analytics tracking code within Redmine.
38 9 Eric Davis
* [[PluginGoogleCalendar|Google Calendar]] is a simple plugin to include Google Calendar iframe as a tab within Redmine projects.
39 41 Eric Davis
* [[PluginGraphs|Graphs]] is a simple plugin provides additional graphs for the system.
40 33 Mischa The Evil
* [[PluginProjectScores|Project Scores]] is a plugin which will let a user score a project on different criteria.
41 1 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)
42 39 Eric Davis
* [[PluginQuestion|Question]] is a plugin which will allow users to ask questions to each other in issue notes
43 40 Eric Davis
* [[PluginSchedules|Schedules]] is a plugin which will schedule users to assigned projects over time
44 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.
45 34 Eric Davis
* [[PluginStuffToDo|Stuff To Do]] allows a user to order and prioritize the issues they are doing into a specific order. It will also allow other privileged users to reorder the user's workload.
46 29 Eric Davis
* [[PluginSystemNotification|System Notification]] is a plugin that will allow an Administrator to send notification emails to recently logged in users.
47 33 Mischa The Evil
* [[PluginTimesheet|Timesheet]] is a plugin to show and filter timelogs across all projects in Redmine.
48 16 Jean-Philippe Lang
49 38 Mischa The Evil
More plugins (some in very early development), which are not listed above 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.
50 31 Mischa The Evil
51 16 Jean-Philippe Lang
h2. Writing plugins
52 1 Jean-Philippe Lang
53 43 Mischa The Evil
See the [[Plugin_Tutorial|plugin tutorial]] and the information provided in the [[Plugin_Internals|plugin internals]] page.