Plugins » History » Revision 70
Revision 69 (Mischa The Evil, 2009-07-11 04:17) → Revision 70/118 (Mischa The Evil, 2009-07-27 02:20)
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 RAILS_ENV=production
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
A full 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.
* "Blog Plugin":http://www.redmine.org/boards/3/topics/5782 is a plugin for having a blog within Redmine.
* "BugCloud":http://github.com/maedana/redmine_bugcloud/tree/master is a plugin that visualizes the tickets as a bug cloud.
* [[PluginBudget|Budget]] is a plugin to manage the set of available deliverables for each project, automatically calculating key performance indicators.
* [[PluginBulkTimeEntry|Bulk Time Entry]] is a plugin to enter multiple time entries at one time.
* "Chat":http://github.com/jbrien/redmine-chat-plugin/tree/master is a plugin to chat within Redmine. Early state!
* "Code Book":http://github.com/sroegner/redmine_codebook/tree/master is a plugin that provides code snippet management.
* "Code Review Plugin":http://www.redmine.org/boards/3/topics/5878 is a plugin for Redmine which lets you annotate source code within the repository browser.
* "Charts Plugin":http://github.com/mszczytowski/redmine_charts/tree/master is a plugin for Redmine which integrates some nice project charts like a burndown chart.
* [[PluginCollapse|Collapse]] is a plugin which moves the Redmine sidebar to the left side and makes it collapsible.
* [[PluginCustomer|Customer]] is a plugin to track basic customer information and to see which project belonged to a customer.
* "Diff Email":http://github.com/Lamar/redmine_diff_email/tree/master is a plugin which sends diff mails of the code changes of last changeset to other users.
* [[PluginEmbedded|Embedded]] lets you embed HTML files (eg. auto generated documentation, test reports) in your projects.
* "Estimer Redmine":http://forge.isotrol.org/projects/show/org00002-estimer is a plugin to estimate a software project. It is based on Function Point and Use case Point method.
* [[PluginExceptionHandler|Exception Handler]] will allow Redmine to send emails when an exception or error occurs.
* [[PluginEzfaq|ezFAQ]] is a FAQ management plugin for Redmine.
* [[PluginEzftpsearch|ezFtpSearch]] is a Ftp files search plugin for Redmine, with a ftp spider.
* [[PluginEzlibrarian|ezLibrarian]] is a book shelf management plugin designed for use in company or department.
* [[PluginEzsidebar|ezSidebar]] is a simple plugin to make it easy to add content(like google ads) to redmine's sidebar.
* [[PluginEzSummary|ezSummary]] will send an issue status summary mail to the specified email-address.
* [[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.
* [[PluginGraphs|Graphs]] provides additional graphs for the issue tracker.
* [[PluginHoptoadServer|HoptoadServer]] transforms your Redmine into a hub for Rails exception handling, similar to "Hoptoad":http://hoptoadapp.com/welcome or "Exceptional":http://getexceptional.com/. An issue will be created or updated for every exception which is thrown in your live applications.
* "Hudson Plugin":http://www.redmine.org/boards/3/topics/6650 is a plugin which integrates hudson jobs into redmine.
* "IssuesGroup":http://www.redmine.org/boards/3/topics/4701 is a plugin implementation of issues grouping, query categorization and subissues feature.
* "LocalAvatars":http://www.redmine.org/boards/3/topics/5365 is a plugin implementation of local user avatars.
* "Markdown formatter":http://github.com/bitherder/redmine_markdown_formatter/tree/master adds Markdown text formatting capability to Redmine.
* "Markdown Extra formatter":http://github.com/juno/redmine_markdown_extra_formatter/tree/master adds Markdown Extra text formatting capability to Redmine.
* "Messenger":http://github.com/mszczytowski/redmine_messenger/tree/master is a plugin to interact with Redmine via instant messenger.
* "My Widgets":http://github.com/bradbeattie/redmine-my-widgets-plugin/tree/master is a plugin that provides additional blocks for "the my page portal":/my/page.
* [[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)
* [[PluginQuestion|Question]] is a plugin which will allow users to ask questions to each other in issue notes
* [[PluginRate|Rate]] is a plugin which will store billable rates for users.
* "Projects Tree View Plugin":http://www.redmine.org/boards/3/topics/4645 is a plugin which turns the projects index view into a tree view that can be found at expanded and collapsed.
* "Resources Plugin":http://github.com/dvandersluis/redmine_resources/tree/master is a plugin which allows links to resources to be added to an issue. For the [[PluginList|Redmine purposes of this plugin, a resource is any external site that is useful for the understanding or completion of an issue.
* "Require Note":http://github.com/ajwalters/redmine_require_closing_note/tree/master is a plugin list]]. which forces users to enter a comment when closing a ticket.
* "Redmine Subtasks":http://github.com/hron/redmine_subtasks/tree/master provides advanced aubtasking functionality in Redmine.
* "Redmine Tab":http://github.com/jamtur01/redmine_tab/tree/master is a plugin to create a new Redmine tab to embed content from an iframe on a per-project base.
* "Repo Pygments":http://www.redmine.org/boards/3/topics/6890 allows using Pygments as highlight tool for repository files.
* [[PluginSchedules|Schedules]] is a plugin which will schedule users to assigned projects over time
* "Scrumdashboard Plugin":http://www.redmine.org/boards/3/topics/5808 is a plugin which provides a scrum dashboard to Redmine and which can be used on a per project base. 0.8.x only!
* [[PluginSimpleCI|Simple CI]] is a generic plugin for integrating per project RSS continuous integration feeds (eg. "Cruise Control":http://cruisecontrol.sourceforge.net/) in Redmine.
* "Status Updates":http://www.redmine.org/boards/1/topics/1483 is a plugin that allows users to create small status updates about what they’re currently working on. You can think of it as Twitter on a per-project basis, within Redmine. source is available "here":http://github.com/bterlson/redmine-status-updates/tree/master
* [[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 work queue.
* [[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.
* "Todo Lists Plugin":http://www.redmine.org/boards/3/topics/4070 is a plugin for Redmine to create and manage agile-esque todo lists on a per project basis.
* "Vote":http://www.redmine.org/boards/3/topics/5506 allows users to vote on which issues are important to them.
* "Wiki Extensions Plugin":http://www.redmine.org/boards/3/topics/7130 is a plugin for Redmine which adds several usefull wiki macros to your redmine.
More plugins (some in very early development), which are not listed at the [[PluginList|Redmine plugin list]] 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]] and the information provided in the [[Plugin_Internals|plugin internals]] page. More references can be found in the [[Guide#Developer-guide|Redmine Developer Guide]].