The requested changes are too big and content was truncated. Show full diff
1 | NO CONTENT: modified file |
|
NO CONTENT: modified file | ||
The requested commit or file is too big and content was truncated. Show full diff |
@@ -1,106 +1,106 | |||||
1 | == Redmine installation |
|
1 | == Redmine installation | |
2 |
|
2 | |||
3 | Redmine - project management software |
|
3 | Redmine - project management software | |
4 | Copyright (C) 2006-2013 Jean-Philippe Lang |
|
4 | Copyright (C) 2006-2013 Jean-Philippe Lang | |
5 | http://www.redmine.org/ |
|
5 | http://www.redmine.org/ | |
6 |
|
6 | |||
7 |
|
7 | |||
8 | == Requirements |
|
8 | == Requirements | |
9 |
|
9 | |||
10 | * Ruby 1.8.7, 1.9.2, 1.9.3 or 2.0.0 |
|
10 | * Ruby 1.8.7, 1.9.2, 1.9.3 or 2.0.0 | |
11 | * RubyGems |
|
11 | * RubyGems | |
12 | * Bundler >= 1.0.21 |
|
12 | * Bundler >= 1.0.21 | |
13 |
|
13 | |||
14 | * A database: |
|
14 | * A database: | |
15 | * MySQL (tested with MySQL 5.1) |
|
15 | * MySQL (tested with MySQL 5.1) | |
16 | * PostgreSQL (tested with PostgreSQL 9.1) |
|
16 | * PostgreSQL (tested with PostgreSQL 9.1) | |
17 |
* SQLite3 (tested with SQLite 3. |
|
17 | * SQLite3 (tested with SQLite 3.7) | |
18 | * SQLServer (tested with SQLServer 2012) |
|
18 | * SQLServer (tested with SQLServer 2012) | |
19 |
|
19 | |||
20 | Optional: |
|
20 | Optional: | |
21 | * SCM binaries (e.g. svn, git...), for repository browsing (must be available in PATH) |
|
21 | * SCM binaries (e.g. svn, git...), for repository browsing (must be available in PATH) | |
22 | * ImageMagick (to enable Gantt export to png images) |
|
22 | * ImageMagick (to enable Gantt export to png images) | |
23 |
|
23 | |||
24 | == Installation |
|
24 | == Installation | |
25 |
|
25 | |||
26 | 1. Uncompress the program archive |
|
26 | 1. Uncompress the program archive | |
27 |
|
27 | |||
28 | 2. Create an empty utf8 encoded database: "redmine" for example |
|
28 | 2. Create an empty utf8 encoded database: "redmine" for example | |
29 |
|
29 | |||
30 | 3. Configure the database parameters in config/database.yml |
|
30 | 3. Configure the database parameters in config/database.yml | |
31 | for the "production" environment (default database is MySQL and ruby1.9) |
|
31 | for the "production" environment (default database is MySQL and ruby1.9) | |
32 |
|
32 | |||
33 | If you're running Redmine with MySQL and ruby1.8, replace the adapter name |
|
33 | If you're running Redmine with MySQL and ruby1.8, replace the adapter name | |
34 | with `mysql` |
|
34 | with `mysql` | |
35 |
|
35 | |||
36 | 4. Install the required gems by running: |
|
36 | 4. Install the required gems by running: | |
37 | bundle install --without development test |
|
37 | bundle install --without development test | |
38 |
|
38 | |||
39 | If ImageMagick is not installed on your system, you should skip the installation |
|
39 | If ImageMagick is not installed on your system, you should skip the installation | |
40 | of the rmagick gem using: |
|
40 | of the rmagick gem using: | |
41 | bundle install --without development test rmagick |
|
41 | bundle install --without development test rmagick | |
42 |
|
42 | |||
43 | Only the gems that are needed by the adapters you've specified in your database |
|
43 | Only the gems that are needed by the adapters you've specified in your database | |
44 | configuration file are actually installed (eg. if your config/database.yml |
|
44 | configuration file are actually installed (eg. if your config/database.yml | |
45 | uses the 'mysql2' adapter, then only the mysql2 gem will be installed). Don't |
|
45 | uses the 'mysql2' adapter, then only the mysql2 gem will be installed). Don't | |
46 | forget to re-run `bundle install` when you change config/database.yml for using |
|
46 | forget to re-run `bundle install` when you change config/database.yml for using | |
47 | other database adapters. |
|
47 | other database adapters. | |
48 |
|
48 | |||
49 | If you need to load some gems that are not required by Redmine core (eg. fcgi), |
|
49 | If you need to load some gems that are not required by Redmine core (eg. fcgi), | |
50 | you can create a file named Gemfile.local at the root of your redmine directory. |
|
50 | you can create a file named Gemfile.local at the root of your redmine directory. | |
51 | It will be loaded automatically when running `bundle install`. |
|
51 | It will be loaded automatically when running `bundle install`. | |
52 |
|
52 | |||
53 | 5. Generate a session store secret |
|
53 | 5. Generate a session store secret | |
54 |
|
54 | |||
55 | Redmine stores session data in cookies by default, which requires |
|
55 | Redmine stores session data in cookies by default, which requires | |
56 | a secret to be generated. Under the application main directory run: |
|
56 | a secret to be generated. Under the application main directory run: | |
57 | rake generate_secret_token |
|
57 | rake generate_secret_token | |
58 |
|
58 | |||
59 | 6. Create the database structure |
|
59 | 6. Create the database structure | |
60 |
|
60 | |||
61 | Under the application main directory run: |
|
61 | Under the application main directory run: | |
62 | rake db:migrate RAILS_ENV="production" |
|
62 | rake db:migrate RAILS_ENV="production" | |
63 |
|
63 | |||
64 | It will create all the tables and an administrator account. |
|
64 | It will create all the tables and an administrator account. | |
65 |
|
65 | |||
66 | 7. Setting up permissions (Windows users have to skip this section) |
|
66 | 7. Setting up permissions (Windows users have to skip this section) | |
67 |
|
67 | |||
68 | The user who runs Redmine must have write permission on the following |
|
68 | The user who runs Redmine must have write permission on the following | |
69 | subdirectories: files, log, tmp & public/plugin_assets. |
|
69 | subdirectories: files, log, tmp & public/plugin_assets. | |
70 |
|
70 | |||
71 | Assuming you run Redmine with a user named "redmine": |
|
71 | Assuming you run Redmine with a user named "redmine": | |
72 | sudo chown -R redmine:redmine files log tmp public/plugin_assets |
|
72 | sudo chown -R redmine:redmine files log tmp public/plugin_assets | |
73 | sudo chmod -R 755 files log tmp public/plugin_assets |
|
73 | sudo chmod -R 755 files log tmp public/plugin_assets | |
74 |
|
74 | |||
75 | 8. Test the installation by running the WEBrick web server |
|
75 | 8. Test the installation by running the WEBrick web server | |
76 |
|
76 | |||
77 | Under the main application directory run: |
|
77 | Under the main application directory run: | |
78 | ruby script/rails server -e production |
|
78 | ruby script/rails server -e production | |
79 |
|
79 | |||
80 | Once WEBrick has started, point your browser to http://localhost:3000/ |
|
80 | Once WEBrick has started, point your browser to http://localhost:3000/ | |
81 | You should now see the application welcome page. |
|
81 | You should now see the application welcome page. | |
82 |
|
82 | |||
83 | 9. Use the default administrator account to log in: |
|
83 | 9. Use the default administrator account to log in: | |
84 | login: admin |
|
84 | login: admin | |
85 | password: admin |
|
85 | password: admin | |
86 |
|
86 | |||
87 | Go to "Administration" to load the default configuration data (roles, |
|
87 | Go to "Administration" to load the default configuration data (roles, | |
88 | trackers, statuses, workflow) and to adjust the application settings |
|
88 | trackers, statuses, workflow) and to adjust the application settings | |
89 |
|
89 | |||
90 | == SMTP server Configuration |
|
90 | == SMTP server Configuration | |
91 |
|
91 | |||
92 | Copy config/configuration.yml.example to config/configuration.yml and |
|
92 | Copy config/configuration.yml.example to config/configuration.yml and | |
93 | edit this file to adjust your SMTP settings. |
|
93 | edit this file to adjust your SMTP settings. | |
94 | Do not forget to restart the application after any change to this file. |
|
94 | Do not forget to restart the application after any change to this file. | |
95 |
|
95 | |||
96 | Please do not enter your SMTP settings in environment.rb. |
|
96 | Please do not enter your SMTP settings in environment.rb. | |
97 |
|
97 | |||
98 | == References |
|
98 | == References | |
99 |
|
99 | |||
100 | * http://www.redmine.org/wiki/redmine/RedmineInstall |
|
100 | * http://www.redmine.org/wiki/redmine/RedmineInstall | |
101 | * http://www.redmine.org/wiki/redmine/EmailConfiguration |
|
101 | * http://www.redmine.org/wiki/redmine/EmailConfiguration | |
102 | * http://www.redmine.org/wiki/redmine/RedmineSettings |
|
102 | * http://www.redmine.org/wiki/redmine/RedmineSettings | |
103 | * http://www.redmine.org/wiki/redmine/RedmineRepositories |
|
103 | * http://www.redmine.org/wiki/redmine/RedmineRepositories | |
104 | * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails |
|
104 | * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails | |
105 | * http://www.redmine.org/wiki/redmine/RedmineReminderEmails |
|
105 | * http://www.redmine.org/wiki/redmine/RedmineReminderEmails | |
106 | * http://www.redmine.org/wiki/redmine/RedmineLDAP |
|
106 | * http://www.redmine.org/wiki/redmine/RedmineLDAP |
@@ -1,69 +1,79 | |||||
1 | == Redmine upgrade |
|
1 | == Redmine upgrade | |
2 |
|
2 | |||
3 | Redmine - project management software |
|
3 | Redmine - project management software | |
4 | Copyright (C) 2006-2013 Jean-Philippe Lang |
|
4 | Copyright (C) 2006-2013 Jean-Philippe Lang | |
5 | http://www.redmine.org/ |
|
5 | http://www.redmine.org/ | |
6 |
|
6 | |||
7 |
|
7 | |||
8 | == Upgrading |
|
8 | == Upgrading | |
9 |
|
9 | |||
10 | 1. Uncompress the program archive in a new directory |
|
10 | 1. Uncompress the program archive in a new directory | |
11 |
|
11 | |||
12 | 2. Copy your database settings (RAILS_ROOT/config/database.yml) |
|
12 | 2. Copy your database settings (RAILS_ROOT/config/database.yml) | |
13 | and your configuration file (RAILS_ROOT/config/configuration.yml) |
|
13 | and your configuration file (RAILS_ROOT/config/configuration.yml) | |
14 | into the new config directory |
|
14 | into the new config directory | |
15 | Note: before Redmine 1.2, SMTP configuration was stored in |
|
15 | Note: before Redmine 1.2, SMTP configuration was stored in | |
16 | config/email.yml. It should now be stored in config/configuration.yml. |
|
16 | config/email.yml. It should now be stored in config/configuration.yml. | |
17 |
|
17 | |||
18 | 3. Copy the RAILS_ROOT/files directory content into your new installation |
|
18 | 3. Copy the RAILS_ROOT/files directory content into your new installation | |
19 | This directory contains all the attached files. |
|
19 | This directory contains all the attached files. | |
20 |
|
20 | |||
21 | 4. Copy the folders of the installed plugins and themes into new installation |
|
21 | 4. Copy the folders of the installed plugins and themes into new installation | |
22 | Plugins must be stored in the [redmine_root]/plugins directory |
|
22 | Plugins must be stored in the [redmine_root]/plugins directory | |
23 | Themes must be stored in the [redmine_root]/public/themes directory |
|
23 | Themes must be stored in the [redmine_root]/public/themes directory | |
24 |
|
24 | |||
25 | WARNING: plugins from your previous Redmine version may not be compatible |
|
25 | WARNING: plugins from your previous Redmine version may not be compatible | |
26 | with the Redmine version you're upgrading to. |
|
26 | with the Redmine version you're upgrading to. | |
27 |
|
27 | |||
28 | 5. Install the required gems by running: |
|
28 | 5. Install the required gems by running: | |
29 | bundle install --without development test |
|
29 | bundle install --without development test | |
30 |
|
30 | |||
31 | If ImageMagick is not installed on your system, you should skip the installation |
|
31 | If ImageMagick is not installed on your system, you should skip the installation | |
32 | of the rmagick gem using: |
|
32 | of the rmagick gem using: | |
33 | bundle install --without development test rmagick |
|
33 | bundle install --without development test rmagick | |
34 |
|
34 | |||
|
35 | Only the gems that are needed by the adapters you've specified in your database | |||
|
36 | configuration file are actually installed (eg. if your config/database.yml | |||
|
37 | uses the 'mysql2' adapter, then only the mysql2 gem will be installed). Don't | |||
|
38 | forget to re-run `bundle install` when you change config/database.yml for using | |||
|
39 | other database adapters. | |||
|
40 | ||||
|
41 | If you need to load some gems that are not required by Redmine core (eg. fcgi), | |||
|
42 | you can create a file named Gemfile.local at the root of your redmine directory. | |||
|
43 | It will be loaded automatically when running `bundle install`. | |||
|
44 | ||||
35 | 6. Generate a session store secret |
|
45 | 6. Generate a session store secret | |
36 |
|
46 | |||
37 | Redmine stores session data in cookies by default, which requires |
|
47 | Redmine stores session data in cookies by default, which requires | |
38 | a secret to be generated. Under the new application directory run: |
|
48 | a secret to be generated. Under the new application directory run: | |
39 | rake generate_secret_token |
|
49 | rake generate_secret_token | |
40 |
|
50 | |||
41 | DO NOT REPLACE OR EDIT ANY OTHER FILES. |
|
51 | DO NOT REPLACE OR EDIT ANY OTHER FILES. | |
42 |
|
52 | |||
43 | 7. Migrate your database |
|
53 | 7. Migrate your database | |
44 |
|
54 | |||
45 | If you are upgrading to Rails 2.3.14 as part of this migration, you |
|
55 | If you are upgrading to Rails 2.3.14 as part of this migration, you | |
46 | need to upgrade the plugin migrations before running the plugin migrations |
|
56 | need to upgrade the plugin migrations before running the plugin migrations | |
47 | using: |
|
57 | using: | |
48 | rake db:migrate:upgrade_plugin_migrations RAILS_ENV="production" |
|
58 | rake db:migrate:upgrade_plugin_migrations RAILS_ENV="production" | |
49 |
|
59 | |||
50 | Please make a backup before doing this! Under the new application |
|
60 | Please make a backup before doing this! Under the new application | |
51 | directory run: |
|
61 | directory run: | |
52 | rake db:migrate RAILS_ENV="production" |
|
62 | rake db:migrate RAILS_ENV="production" | |
53 |
|
63 | |||
54 | If you have installed any plugins, you should also run their database |
|
64 | If you have installed any plugins, you should also run their database | |
55 | migrations using: |
|
65 | migrations using: | |
56 | rake db:migrate_plugins RAILS_ENV="production" |
|
66 | rake db:migrate_plugins RAILS_ENV="production" | |
57 |
|
67 | |||
58 | 8. Clear the cache and the existing sessions by running: |
|
68 | 8. Clear the cache and the existing sessions by running: | |
59 | rake tmp:cache:clear |
|
69 | rake tmp:cache:clear | |
60 | rake tmp:sessions:clear |
|
70 | rake tmp:sessions:clear | |
61 |
|
71 | |||
62 | 9. Restart the application server (e.g. mongrel, thin, passenger) |
|
72 | 9. Restart the application server (e.g. mongrel, thin, passenger) | |
63 |
|
73 | |||
64 | 10. Finally go to "Administration -> Roles & permissions" to check/set permissions |
|
74 | 10. Finally go to "Administration -> Roles & permissions" to check/set permissions | |
65 | for new features, if any |
|
75 | for new features, if any | |
66 |
|
76 | |||
67 | == References |
|
77 | == References | |
68 |
|
78 | |||
69 | * http://www.redmine.org/wiki/redmine/RedmineUpgrade |
|
79 | * http://www.redmine.org/wiki/redmine/RedmineUpgrade |
General Comments 0
You need to be logged in to leave comments.
Login now