Project

General

Profile

Plugins » History » Revision 29

Revision 28 (Eric Davis, 2008-11-21 01:54) → Revision 29/118 (Eric Davis, 2008-12-30 00:30)

h1. Plugins 

 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. 

 h2. Installing a plugin 

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

    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 

 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. Start Redmine 

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

 h2. Plugin list 

 * [[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. 
 * [[PluginCustomer|Customer]] is 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 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. 
 * [[PluginSystemNotification|System Notification]] is a plugin that will allow an Administrator to send notification emails to recently logged in users. 
 * [[PluginTimesheet|Timesheet]] is plugin to show and filter timelogs across all projects in Redmine. 

 h2. Writing plugins 

 See the [[Plugin_Tutorial|Plugin API]].