##// END OF EJS Templates
updated documentation...
Jean-Philippe Lang -
r250:1cc6dd871bc6
parent child
Show More
@@ -1,129 +1,138
1 == redMine changelog
1 == redMine changelog
2
2
3 redMine - project management software
3 redMine - project management software
4 Copyright (C) 2006-2007 Jean-Philippe Lang
4 Copyright (C) 2006-2007 Jean-Philippe Lang
5 http://redmine.rubyforge.org/
5 http://redmine.rubyforge.org/
6
6
7
7
8 == xx/xx/2006 v0.4.2
8 == xx/xx/2006 v0.4.2
9
9
10 * Rails 1.2 is now required
10 * Rails 1.2 is now required
11 * settings are now stored in the database and editable through the application in: Admin -> Settings (config_custom.rb is no longer used)
11 * settings are now stored in the database and editable through the application in: Admin -> Settings (config_custom.rb is no longer used)
12 * added project roadmap view
12 * mail notifications added when a document, a file or an attachment is added
13 * mail notifications added when a document, a file or an attachment is added
13 * tooltips added on Gantt chart and calender to view the details of the issues
14 * tooltips added on Gantt chart and calender to view the details of the issues
14 * ability to set the sort order for roles, trackers, issue statuses
15 * ability to set the sort order for roles, trackers, issue statuses
15 * added missing fields to csv export: priority, start date, due date, done ratio
16 * added missing fields to csv export: priority, start date, due date, done ratio
17 * added total number of issues per tracker on project overview
16 * all icons replaced (new icons are based on GPL icon set: "KDE Crystal Diamond 2.5" -by paolino- and "kNeu! Alpha v0.1" -by Pablo Fabregat-)
18 * all icons replaced (new icons are based on GPL icon set: "KDE Crystal Diamond 2.5" -by paolino- and "kNeu! Alpha v0.1" -by Pablo Fabregat-)
17 * added back "fixed version" field on issue screen and in filters
19 * added back "fixed version" field on issue screen and in filters
18 * project settings screen split in 4 tabs
20 * project settings screen split in 4 tabs
21 * custom fields screen split in 3 tabs (one for each kind of custom field)
22 * multiple issues pdf export now rendered as a table
23 * added a button on users/list to manually activate an account
24 * added a setting option to disable "password lost" functionality
25 * added a setting option to set max number of issues in csv/pdf exports
19 * fixed: subprojects count is always 0 on projects list
26 * fixed: subprojects count is always 0 on projects list
27 * fixed: locked users are proposed when adding a member to a project
20 * fixed: setting an issue status as default status leads to an sql error with SQLite
28 * fixed: setting an issue status as default status leads to an sql error with SQLite
21 * fixed: unable to delete an issue status even if it's not used yet
29 * fixed: unable to delete an issue status even if it's not used yet
22 * fixed: filters ignored when exporting a predefined query to csv/pdf
30 * fixed: filters ignored when exporting a predefined query to csv/pdf
31 * fixed: crash when french "issue_edit" email notification is sent
23
32
24
33
25 == 01/03/2006 v0.4.1
34 == 01/03/2006 v0.4.1
26
35
27 * fixed: emails have no recipient when one of the project members has notifications disabled
36 * fixed: emails have no recipient when one of the project members has notifications disabled
28
37
29
38
30 == 01/02/2006 v0.4.0
39 == 01/02/2006 v0.4.0
31
40
32 * simple SVN browser added (just needs svn binaries in PATH)
41 * simple SVN browser added (just needs svn binaries in PATH)
33 * comments can now be added on news
42 * comments can now be added on news
34 * "my page" is now customizable
43 * "my page" is now customizable
35 * more powerfull and savable filters for issues lists
44 * more powerfull and savable filters for issues lists
36 * improved issues change history
45 * improved issues change history
37 * new functionality: move an issue to another project or tracker
46 * new functionality: move an issue to another project or tracker
38 * new functionality: add a note to an issue
47 * new functionality: add a note to an issue
39 * new report: project activity
48 * new report: project activity
40 * "start date" and "% done" fields added on issues
49 * "start date" and "% done" fields added on issues
41 * project calendar added
50 * project calendar added
42 * gantt chart added (exportable to pdf)
51 * gantt chart added (exportable to pdf)
43 * single/multiple issues pdf export added
52 * single/multiple issues pdf export added
44 * issues reports improvements
53 * issues reports improvements
45 * multiple file upload for issues, documents and files
54 * multiple file upload for issues, documents and files
46 * option to set maximum size of uploaded files
55 * option to set maximum size of uploaded files
47 * textile formating of issue and news descritions (RedCloth required)
56 * textile formating of issue and news descritions (RedCloth required)
48 * integration of DotClear jstoolbar for textile formatting
57 * integration of DotClear jstoolbar for textile formatting
49 * calendar date picker for date fields (LGPL DHTML Calendar http://sourceforge.net/projects/jscalendar)
58 * calendar date picker for date fields (LGPL DHTML Calendar http://sourceforge.net/projects/jscalendar)
50 * new filter in issues list: Author
59 * new filter in issues list: Author
51 * ajaxified paginators
60 * ajaxified paginators
52 * news rss feed added
61 * news rss feed added
53 * option to set number of results per page on issues list
62 * option to set number of results per page on issues list
54 * localized csv separator (comma/semicolon)
63 * localized csv separator (comma/semicolon)
55 * csv output encoded to ISO-8859-1
64 * csv output encoded to ISO-8859-1
56 * user custom field displayed on account/show
65 * user custom field displayed on account/show
57 * default configuration improved (default roles, trackers, status, permissions and workflows)
66 * default configuration improved (default roles, trackers, status, permissions and workflows)
58 * language for default configuration data can now be chosen when running 'load_default_data' task
67 * language for default configuration data can now be chosen when running 'load_default_data' task
59 * javascript added on custom field form to show/hide fields according to the format of custom field
68 * javascript added on custom field form to show/hide fields according to the format of custom field
60 * fixed: custom fields not in csv exports
69 * fixed: custom fields not in csv exports
61 * fixed: project settings now displayed according to user's permissions
70 * fixed: project settings now displayed according to user's permissions
62 * fixed: application error when no version is selected on projects/add_file
71 * fixed: application error when no version is selected on projects/add_file
63 * fixed: public actions not authorized for members of non public projects
72 * fixed: public actions not authorized for members of non public projects
64 * fixed: non public projects were shown on welcome screen even if current user is not a member
73 * fixed: non public projects were shown on welcome screen even if current user is not a member
65
74
66
75
67 == 10/08/2006 v0.3.0
76 == 10/08/2006 v0.3.0
68
77
69 * user authentication against multiple LDAP (optional)
78 * user authentication against multiple LDAP (optional)
70 * token based "lost password" functionality
79 * token based "lost password" functionality
71 * user self-registration functionality (optional)
80 * user self-registration functionality (optional)
72 * custom fields now available for issues, users and projects
81 * custom fields now available for issues, users and projects
73 * new custom field format "text" (displayed as a textarea field)
82 * new custom field format "text" (displayed as a textarea field)
74 * project & administration drop down menus in navigation bar for quicker access
83 * project & administration drop down menus in navigation bar for quicker access
75 * text formatting is preserved for long text fields (issues, projects and news descriptions)
84 * text formatting is preserved for long text fields (issues, projects and news descriptions)
76 * urls and emails are turned into clickable links in long text fields
85 * urls and emails are turned into clickable links in long text fields
77 * "due date" field added on issues
86 * "due date" field added on issues
78 * tracker selection filter added on change log
87 * tracker selection filter added on change log
79 * Localization plugin replaced with GLoc 1.1.0 (iconv required)
88 * Localization plugin replaced with GLoc 1.1.0 (iconv required)
80 * error messages internationalization
89 * error messages internationalization
81 * german translation added (thanks to Karim Trott)
90 * german translation added (thanks to Karim Trott)
82 * data locking for issues to prevent update conflicts (using ActiveRecord builtin optimistic locking)
91 * data locking for issues to prevent update conflicts (using ActiveRecord builtin optimistic locking)
83 * new filter in issues list: "Fixed version"
92 * new filter in issues list: "Fixed version"
84 * active filters are displayed with colored background on issues list
93 * active filters are displayed with colored background on issues list
85 * custom configuration is now defined in config/config_custom.rb
94 * custom configuration is now defined in config/config_custom.rb
86 * user object no more stored in session (only user_id)
95 * user object no more stored in session (only user_id)
87 * news summary field is no longer required
96 * news summary field is no longer required
88 * tables and forms redesign
97 * tables and forms redesign
89 * Fixed: boolean custom field not working
98 * Fixed: boolean custom field not working
90 * Fixed: error messages for custom fields are not displayed
99 * Fixed: error messages for custom fields are not displayed
91 * Fixed: invalid custom fields should have a red border
100 * Fixed: invalid custom fields should have a red border
92 * Fixed: custom fields values are not validated on issue update
101 * Fixed: custom fields values are not validated on issue update
93 * Fixed: unable to choose an empty value for 'List' custom fields
102 * Fixed: unable to choose an empty value for 'List' custom fields
94 * Fixed: no issue categories sorting
103 * Fixed: no issue categories sorting
95 * Fixed: incorrect versions sorting
104 * Fixed: incorrect versions sorting
96
105
97
106
98 == 07/12/2006 - v0.2.2
107 == 07/12/2006 - v0.2.2
99
108
100 * Fixed: bug in "issues list"
109 * Fixed: bug in "issues list"
101
110
102
111
103 == 07/09/2006 - v0.2.1
112 == 07/09/2006 - v0.2.1
104
113
105 * new databases supported: Oracle, PostgreSQL, SQL Server
114 * new databases supported: Oracle, PostgreSQL, SQL Server
106 * projects/subprojects hierarchy (1 level of subprojects only)
115 * projects/subprojects hierarchy (1 level of subprojects only)
107 * environment information display in admin/info
116 * environment information display in admin/info
108 * more filter options in issues list (rev6)
117 * more filter options in issues list (rev6)
109 * default language based on browser settings (Accept-Language HTTP header)
118 * default language based on browser settings (Accept-Language HTTP header)
110 * issues list exportable to CSV (rev6)
119 * issues list exportable to CSV (rev6)
111 * simple_format and auto_link on long text fields
120 * simple_format and auto_link on long text fields
112 * more data validations
121 * more data validations
113 * Fixed: error when all mail notifications are unchecked in admin/mail_options
122 * Fixed: error when all mail notifications are unchecked in admin/mail_options
114 * Fixed: all project news are displayed on project summary
123 * Fixed: all project news are displayed on project summary
115 * Fixed: Can't change user password in users/edit
124 * Fixed: Can't change user password in users/edit
116 * Fixed: Error on tables creation with PostgreSQL (rev5)
125 * Fixed: Error on tables creation with PostgreSQL (rev5)
117 * Fixed: SQL error in "issue reports" view with PostgreSQL (rev5)
126 * Fixed: SQL error in "issue reports" view with PostgreSQL (rev5)
118
127
119
128
120 == 06/25/2006 - v0.1.0
129 == 06/25/2006 - v0.1.0
121
130
122 * multiple users/multiple projects
131 * multiple users/multiple projects
123 * role based access control
132 * role based access control
124 * issue tracking system
133 * issue tracking system
125 * fully customizable workflow
134 * fully customizable workflow
126 * documents/files repository
135 * documents/files repository
127 * email notifications on issue creation and update
136 * email notifications on issue creation and update
128 * multilanguage support (except for error messages):english, french, spanish
137 * multilanguage support (except for error messages):english, french, spanish
129 * online manual in french (unfinished) No newline at end of file
138 * online manual in french (unfinished)
@@ -1,70 +1,72
1 == redMine installation
1 == redMine installation
2
2
3 redMine - project management software
3 redMine - project management software
4 Copyright (C) 2006-2007 Jean-Philippe Lang
4 Copyright (C) 2006-2007 Jean-Philippe Lang
5 http://redmine.rubyforge.org/
5 http://redmine.rubyforge.org/
6
6
7
7
8 == Requirements
8 == Requirements
9
9
10 * Ruby on Rails 1.2
10 * Ruby on Rails 1.2.2
11 * Iconv
11 * Iconv
12 * A database (see compatibility below)
12 * A database (see compatibility below)
13
13
14 Optional:
14 Optional:
15 * RedCloth (to enable textile formatting)
15 * RedCloth (to enable textile formatting)
16 * SVN binaries (needed for repository browsing, must be available in PATH)
16 * SVN binaries (needed for repository browsing, must be available in PATH)
17
17
18 Supported databases:
18 Supported databases:
19 * MySQL (tested with MySQL 5)
19 * MySQL (tested with MySQL 5)
20 * PostgreSQL (tested with PostgreSQL 8.1)
20 * PostgreSQL (tested with PostgreSQL 8.1)
21 * Oracle (tested with Oracle 10g)
21 * Oracle (tested with Oracle 10g)
22 * SQL Server (tested with SQL Server 2005)
22 * SQL Server (tested with SQL Server 2005)
23 * SQLite (tested with SQLite 3)
23 * SQLite (tested with SQLite 3)
24
24
25
25
26 == Installation
26 == Installation
27
27
28 1. Uncompress program archive:
28 1. Uncompress program archive:
29 tar zxvf <filename>
29 tar zxvf <filename>
30
30
31 2. Create an empty database: "redmine" for example
31 2. Create an empty database: "redmine" for example
32
32
33 3. Configure database parameters in config/database.yml
33 3. Configure database parameters in config/database.yml
34 for "production" environment (default database is MySQL)
34 for "production" environment (default database is MySQL)
35
35
36 4. Create the database structure. Under the application main directory:
36 4. Create the database structure. Under the application main directory:
37 rake migrate RAILS_ENV="production"
37 rake migrate RAILS_ENV="production"
38 It will create tables and an administrator account.
38 It will create tables and an administrator account.
39
39
40 5. Insert default configuration data in database:
40 5. Insert default configuration data in database:
41 rake load_default_data RAILS_ENV="production"
41 rake load_default_data RAILS_ENV="production"
42 It will load default roles, trackers, statuses, workflows and enumerations.
42 It will load default roles, trackers, statuses, workflows and enumerations.
43 This step is optional (but recommended), as you can define your
43 This step is optional (but recommended), as you can define your
44 own configuration from sratch.
44 own configuration from sratch.
45
45
46 6. Test the installation by running WEBrick web server:
46 6. Test the installation by running WEBrick web server:
47 ruby script/server -e production
47 ruby script/server -e production
48
48
49 Once WEBrick has started, point your browser to http://localhost:3000/
49 Once WEBrick has started, point your browser to http://localhost:3000/
50 You should now see the application welcome page
50 You should now see the application welcome page
51
51
52 7. Use default administrator account to log in:
52 7. Use default administrator account to log in:
53 login: admin
53 login: admin
54 password: admin
54 password: admin
55
56 8. You can go to "Admin -> Settings" to modify application settings.
55
57
56 8. Setup Apache or Lighttpd with fastcgi for best performance.
58 9. Setup Apache or Lighttpd with fastcgi for best performance.
57
59
58
60
59 == Configuration
61 == SMTP server Configuration
60
62
61 In config/environment.rb, you can set parameters for your SMTP server:
63 In config/environment.rb, you can set parameters for your SMTP server:
62 config.action_mailer.server_settings: SMTP server configuration
64 config.action_mailer.smtp_settings: SMTP server configuration
63 config.action_mailer.perform_deliveries: set to false to disable mail delivering
65 config.action_mailer.perform_deliveries: set to false to disable mail delivering
64
66
65 Don't forget to restart the application after any change.
67 Don't forget to restart the application after any change.
66
68
67
69
68 == Upgrading
70 == Upgrading
69
71
70 See UPGRADING
72 See UPGRADING
@@ -1,24 +1,24
1 == redMine upgrade procedure
1 == redMine upgrade procedure
2
2
3 redMine - project management software
3 redMine - project management software
4 Copyright (C) 2006-2007 Jean-Philippe Lang
4 Copyright (C) 2006-2007 Jean-Philippe Lang
5 http://redmine.rubyforge.org/
5 http://redmine.rubyforge.org/
6
6
7
7
8 Note that Rails 1.2 is required for version 0.4.2 and later
8 Note that Rails 1.2.2 is required for version 0.4.2 and later
9
9
10 == Upgrading from 0.3.0 and above
10 == Upgrading from 0.3.0 and above
11
11
12 1. Uncompress program archive in a new directory:
12 1. Uncompress program archive in a new directory:
13 tar zxvf <filename>
13 tar zxvf <filename>
14
14
15 3. Copy your database settings (database.yml) into the new config directory
15 3. Copy your database settings (database.yml) into the new config directory
16
16
17 4. Migrate your database:
17 4. Migrate your database:
18 rake migrate RAILS_ENV="production"
18 rake migrate RAILS_ENV="production"
19
19
20
20
21 == From 0.2.x and below
21 == From 0.2.x and below
22
22
23 Due to major database changes since 0.2.x, there is no migration support
23 Due to major database changes since 0.2.x, there is no migration support
24 from 0.2.x and previous versions.
24 from 0.2.x and previous versions.
General Comments 0
You need to be logged in to leave comments. Login now