Redmine

h1. Plugins

Redmine plugins rely on "Rails engines":http://rails-engines.org/ to add functionalities to the application.

h2. Installing a plugin

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.

<pre>

ruby script/plugin install http://svn.rails-engines.org/engines/tags/rel_2.0.0/

mv vendor/plugins/rel_2.0.0 vendor/plugins/engines

</pre>

2. Then, copy your plugin directory into @#{RAILS_ROOT}/vendor/plugins@.

3. If the plugin requires a migration, run the following command to upgrade your database (make a db backup before):

  rake db:migrate_plugins

4. Restart Redmine

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).

h2. Plugin list

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.

* [[BotsFilterPlugin]] prevents common bots from crawling various urls.

* [[PluginBulkTimeEntry|Bulk Time Entry]] is a plugin to enter multiple time entries at one time.

* [[PluginBudget|Budget]] is a plugin to manage the set of deliverables for each project, automatically calculating key performance indicators.

* [[PluginCollapse|Collapse]] is a plugin which transforms the default Redmine sidebar into a collapsible sidebar.

* [[PluginCustomer|Customer]] is a plugin to track basic customer information and to see which project belonged to a customer.

* [[PluginEmbedded|Embedded]] lets you embed HTML files (eg. auto generated documentation, test reports) in your projects.

* [[PluginExceptionHandler|Exception Handler]] will allow Redmine to send emails when an exception or error occurs.

* [[PluginEzfaq|ezFAQ]] is a FAQ management plugin for Redmine.

* [[PluginEzlibrarian|ezLibrarian]] is a book shelf management plugin designed for use in company or department.

* [[PluginGoogleAnalytics|Google Analytics]] is a simple plugin to include a Google Analytics tracking code within Redmine.

* [[PluginGoogleCalendar|Google Calendar]] is a simple plugin to include Google Calendar iframe as a tab within Redmine projects.

* [[PluginProjectScores|Project Scores]] is a plugin which will let a user score a project on different criteria.

* "RD formatter":http://github.com/yugui/redmine_rd_formatter/tree/master adds Ruby Doc text formatting capability to Redmine (requires Redmine r1955 or above)

* [[PluginSimpleCI|Simple CI]] is a generic plugin for integrating per project RSS continuous integration feeds (eg. "Cruise Control":http://cruisecontrol.sourceforge.net/) in Redmine.

* [[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.

* [[PluginSystemNotification|System Notification]] is a plugin that will allow an Administrator to send notification emails to recently logged in users.

* [[PluginTimesheet|Timesheet]] is a plugin to show and filter timelogs across all projects in Redmine.

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.

h2. Writing plugins

See the [[Plugin_Tutorial|Plugin Tutorial]].