PluginRedmine2mite » History » Version 4

Thomas Klein, 2009-11-17 01:08
Added forced toc

1 1 Thomas Klein
h1. Redmine2mite plugin
2 2 Thomas Klein
3 4 Thomas Klein
{{>toc}}
4 4 Thomas Klein
5 3 Thomas Klein
Please check out the "Github repository":http://github.com/thomasklein/Redmine2mite to get always the latest version.
6 3 Thomas Klein
7 3 Thomas Klein
<code>Redmine2mite</code> connects your Redmine account with your _mite_.account. Track your time easily on issues within Redmine and get them automatically send to _mite_.
8 3 Thomas Klein
9 3 Thomas Klein
"_mite_":http://mite.yo.lk/en is a sleek time tracking tool for teams and freelancers.
10 3 Thomas Klein
11 3 Thomas Klein
Projects from Redmine can be bundled with _mite_.projects. Furthermore, you can specify which _mite_.services should be available in Redmine on a per-project basis.
12 3 Thomas Klein
13 3 Thomas Klein
h2. Requirements
14 3 Thomas Klein
15 3 Thomas Klein
* "Redmine":http://www.redmine.org/ >= 0.8
16 3 Thomas Klein
* "Ruby on Rails":rubyonrails.org >= 2.1.2
17 3 Thomas Klein
* a _mite_.account (you can easily signup for a "free 30 days trial account":https://signup.mite.yo.lk/signup/en )
18 3 Thomas Klein
19 3 Thomas Klein
h2. Installation
20 3 Thomas Klein
21 3 Thomas Klein
# Move the <code>redmine2mite</code> directory into the <code>/vendor/plugins</code> directory of your Redmine installation
22 3 Thomas Klein
# Install the plugin schema by calling <code>rake db:migrate_plugins</code> via console
23 3 Thomas Klein
# Restart your Redmine web server (e.g. Mongrel, Thin, WEBrick) 
24 3 Thomas Klein
# Voilá!
25 3 Thomas Klein
26 3 Thomas Klein
h2. Setup
27 3 Thomas Klein
28 3 Thomas Klein
Login to Redmine. You should now see on the top right corner the link "mite". Click on it. 
29 3 Thomas Klein
30 3 Thomas Klein
After providing your account data you can now interconnect your _mite_.projects and _mite_.services with a specific Redmine project. The selected values will appear on top of the list, if you create a new time entry in the respective project.
31 3 Thomas Klein
32 3 Thomas Klein
Precondition is having Redmine projects assigned to your user, of course :-)
33 3 Thomas Klein
34 3 Thomas Klein
h2. Usage
35 3 Thomas Klein
36 3 Thomas Klein
Once the connection to your _mite_.account was verified, sending your time entries to _mite_ is very easy. The two fields _mite_.project and _mite_.service have been added to the time logging mask. When creating or updating a time entry the plugin sends those values to your _mite_.account.
37 3 Thomas Klein
38 3 Thomas Klein
h2. Known issues
39 3 Thomas Klein
40 3 Thomas Klein
h3. How do i uninstall the plugin?
41 3 Thomas Klein
42 3 Thomas Klein
Well, currently "there is no easy way doing this":http://www.redmine.org/boards/2/topics/2820. 
43 3 Thomas Klein
* remove the directory <code>redmine2mite</code> out of the <code>/vendor/plugins</code> directory. 
44 3 Thomas Klein
* manually delete all of the plugins database tables and newly added fields to existing tables
45 3 Thomas Klein
** tables: <code>mite_bindings</code>, <code>mite_rsrcs</code>
46 3 Thomas Klein
** added fields in table <code>user_preferences</code>: <code>mite_account_name</code>, <code>mite_api_key</code>, <code>mite_note_pattern</code>, <code>mite_connection_updated_on</code>
47 3 Thomas Klein
** added fields in table <code>time_entries</code>: <code>mite_time_entry_id</code>, <code>mite_project_id</code>, <code>mite_service_id</code>, <code>mite_time_entry_updated_on</code>
48 3 Thomas Klein
* entry "redmine_mite" in table <code>plugin_schema_info</code>
49 3 Thomas Klein
50 3 Thomas Klein
h2. License
51 3 Thomas Klein
52 3 Thomas Klein
<code>Redmine2mite</code> is licensed under the terms of the MIT License, see the included MIT-LICENSE file.
53 3 Thomas Klein
54 3 Thomas Klein
h2. Screenshots
55 3 Thomas Klein
56 2 Thomas Klein
|=. *User account settings*  |
57 2 Thomas Klein
| !redmine2mite_screenshot1_thumb.png!:http://www.redmine.org/attachments/2775/redmine2mite_screenshot1.png |
58 2 Thomas Klein
59 2 Thomas Klein
|=. *Added options for a time entry*  |
60 2 Thomas Klein
| !redmine2mite_screenshot2_thumb.png!:http://www.redmine.org/attachments/2776/redmine2mite_screenshot2.png |
61 2 Thomas Klein
62 2 Thomas Klein
|=. *New time entry in users mite.account*  |
63 2 Thomas Klein
| !redmine2mite_screenshot3_thumb.png!:http://www.redmine.org/attachments/2776/redmine2mite_screenshot3.png |