Project

General

Profile

Plugins » History » Version 53

Barbara Post, 2009-06-16 14:58

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 48 Jens Goldhammer
* "Blog Plugin":http://www.redmine.org/boards/3/topics/5782 is a plugin for having a blog within Redmine.
30 49 Jens Goldhammer
* "BugCloud":http://github.com/maedana/redmine_bugcloud/tree/master is a plugin that visualizes the tickets as a bug cloud.
31 1 Jean-Philippe Lang
* [[PluginBudget|Budget]] is a plugin to manage the set of deliverables for each project, automatically calculating key performance indicators.
32 49 Jens Goldhammer
* [[PluginBulkTimeEntry|Bulk Time Entry]] is a plugin to enter multiple time entries at one time.
33
* "Chat":http://github.com/jbrien/redmine-chat-plugin/tree/master is a plugin to chat within Redmine. Early state!
34
* "Code Book":http://github.com/sroegner/redmine_codebook/tree/master is a plugin that provides code snippet management.
35 48 Jens Goldhammer
* "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.
36
* "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.
37 33 Mischa The Evil
* [[PluginCollapse|Collapse]] is a plugin which transforms the default Redmine sidebar into a collapsible sidebar.
38 1 Jean-Philippe Lang
* [[PluginCustomer|Customer]] is a plugin to track basic customer information and to see which project belonged to a customer.
39 49 Jens Goldhammer
* "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.
40 15 Jean-Philippe Lang
* [[PluginEmbedded|Embedded]] lets you embed HTML files (eg. auto generated documentation, test reports) in your projects.
41 28 Eric Davis
* [[PluginExceptionHandler|Exception Handler]] will allow Redmine to send emails when an exception or error occurs.
42 17 Chaoqun Zou
* [[PluginEzfaq|ezFAQ]] is a FAQ management plugin for Redmine.
43 24 Chaoqun Zou
* [[PluginEzlibrarian|ezLibrarian]] is a book shelf management plugin designed for use in company or department.
44 47 Chaoqun Zou
* [[PluginEzSummary|ezSummary]] will send an issue status summary mail to the specified email-address.
45 1 Jean-Philippe Lang
* [[PluginGoogleAnalytics|Google Analytics]] is a simple plugin to include a Google Analytics tracking code within Redmine.
46 9 Eric Davis
* [[PluginGoogleCalendar|Google Calendar]] is a simple plugin to include Google Calendar iframe as a tab within Redmine projects.
47 41 Eric Davis
* [[PluginGraphs|Graphs]] is a simple plugin provides additional graphs for the system.
48 50 Toshiyuki Ando
* "Hudson Plugin":http://www.redmine.org/boards/3/topics/6650 is a plugin which integrates hudson jobs into redmine.
49 45 Andrew Chaika
* "IssuesGroup":http://www.redmine.org/boards/3/topics/4701 is a plugin implementation of issues grouping and query categorization.
50 1 Jean-Philippe Lang
* "LocalAvatars":http://www.redmine.org/boards/3/topics/5365 is a plugin implementation of local user avatars.
51 49 Jens Goldhammer
* "Messenger":http://github.com/mszczytowski/redmine_messenger/tree/master is a plugin to interact with Redmine via instant messenger.
52 1 Jean-Philippe Lang
* "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.
53 39 Eric Davis
* [[PluginProjectScores|Project Scores]] is a plugin which will let a user score a project on different criteria.
54 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)
55
* [[PluginQuestion|Question]] is a plugin which will allow users to ask questions to each other in issue notes
56 44 Eric Davis
* [[PluginRate|Rate]] is a plugin which will store billable rates for users.
57 49 Jens Goldhammer
* "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 purposes of this plugin, a resource is any external site that is useful for the understanding or completion of an issue.
58
* "Require Note":http://github.com/ajwalters/redmine_require_closing_note/tree/master is a plugin for allow users closing a ticket only by entering a comment.
59 48 Jens Goldhammer
* "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.
60 40 Eric Davis
* [[PluginSchedules|Schedules]] is a plugin which will schedule users to assigned projects over time
61 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.
62 51 Jens Goldhammer
* "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
63 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.
64 29 Eric Davis
* [[PluginSystemNotification|System Notification]] is a plugin that will allow an Administrator to send notification emails to recently logged in users.
65 33 Mischa The Evil
* [[PluginTimesheet|Timesheet]] is a plugin to show and filter timelogs across all projects in Redmine.
66 45 Andrew Chaika
* "Vote":http://www.redmine.org/boards/3/topics/5506 is a plugin for issues voting.
67 16 Jean-Philippe Lang
68 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.
69 31 Mischa The Evil
70 16 Jean-Philippe Lang
h2. Writing plugins
71 1 Jean-Philippe Lang
72 43 Mischa The Evil
See the [[Plugin_Tutorial|plugin tutorial]] and the information provided in the [[Plugin_Internals|plugin internals]] page.