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