##// END OF EJS Templates
Merged r14217 (#19185)....
Jean-Philippe Lang -
r13836:16516fb48a18
parent child
Show More
@@ -1,103 +1,106
1 == Redmine installation
1 == Redmine installation
2
2
3 Redmine - project management software
3 Redmine - project management software
4 Copyright (C) 2006-2015 Jean-Philippe Lang
4 Copyright (C) 2006-2015 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.9.3
10 * Ruby >= 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 9.1)
16 * PostgreSQL (tested with PostgreSQL 9.1)
17 * SQLite3 (tested with SQLite 3.7)
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 4. Install the required gems by running:
33 4. Install the required gems by running:
34 bundle install --without development test
34 bundle install --without development test
35
35
36 If ImageMagick is not installed on your system, you should skip the installation
36 If ImageMagick is not installed on your system, you should skip the installation
37 of the rmagick gem using:
37 of the rmagick gem using:
38 bundle install --without development test rmagick
38 bundle install --without development test rmagick
39
39
40 Only the gems that are needed by the adapters you've specified in your database
40 Only the gems that are needed by the adapters you've specified in your database
41 configuration file are actually installed (eg. if your config/database.yml
41 configuration file are actually installed (eg. if your config/database.yml
42 uses the 'mysql2' adapter, then only the mysql2 gem will be installed). Don't
42 uses the 'mysql2' adapter, then only the mysql2 gem will be installed). Don't
43 forget to re-run `bundle install` when you change config/database.yml for using
43 forget to re-run `bundle install` when you change config/database.yml for using
44 other database adapters.
44 other database adapters.
45
45
46 If you need to load some gems that are not required by Redmine core (eg. fcgi),
46 If you need to load some gems that are not required by Redmine core (eg. fcgi),
47 you can create a file named Gemfile.local at the root of your redmine directory.
47 you can create a file named Gemfile.local at the root of your redmine directory.
48 It will be loaded automatically when running `bundle install`.
48 It will be loaded automatically when running `bundle install`.
49
49
50 5. Generate a session store secret
50 5. Generate a session store secret
51
51
52 Redmine stores session data in cookies by default, which requires
52 Redmine stores session data in cookies by default, which requires
53 a secret to be generated. Under the application main directory run:
53 a secret to be generated. Under the application main directory run:
54 bundle exec rake generate_secret_token
54 bundle exec rake generate_secret_token
55
55
56 Alternatively, you can store this secret in config/secrets.yml:
57 http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
58
56 6. Create the database structure
59 6. Create the database structure
57
60
58 Under the application main directory run:
61 Under the application main directory run:
59 bundle exec rake db:migrate RAILS_ENV="production"
62 bundle exec rake db:migrate RAILS_ENV="production"
60
63
61 It will create all the tables and an administrator account.
64 It will create all the tables and an administrator account.
62
65
63 7. Setting up permissions (Windows users have to skip this section)
66 7. Setting up permissions (Windows users have to skip this section)
64
67
65 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
66 subdirectories: files, log, tmp & public/plugin_assets.
69 subdirectories: files, log, tmp & public/plugin_assets.
67
70
68 Assuming you run Redmine with a user named "redmine":
71 Assuming you run Redmine with a user named "redmine":
69 sudo chown -R redmine:redmine files log tmp public/plugin_assets
72 sudo chown -R redmine:redmine files log tmp public/plugin_assets
70 sudo chmod -R 755 files log tmp public/plugin_assets
73 sudo chmod -R 755 files log tmp public/plugin_assets
71
74
72 8. Test the installation by running the WEBrick web server
75 8. Test the installation by running the WEBrick web server
73
76
74 Under the main application directory run:
77 Under the main application directory run:
75 ruby bin/rails server -e production
78 ruby bin/rails server -e production
76
79
77 Once WEBrick has started, point your browser to http://localhost:3000/
80 Once WEBrick has started, point your browser to http://localhost:3000/
78 You should now see the application welcome page.
81 You should now see the application welcome page.
79
82
80 9. Use the default administrator account to log in:
83 9. Use the default administrator account to log in:
81 login: admin
84 login: admin
82 password: admin
85 password: admin
83
86
84 Go to "Administration" to load the default configuration data (roles,
87 Go to "Administration" to load the default configuration data (roles,
85 trackers, statuses, workflow) and to adjust the application settings
88 trackers, statuses, workflow) and to adjust the application settings
86
89
87 == SMTP server Configuration
90 == SMTP server Configuration
88
91
89 Copy config/configuration.yml.example to config/configuration.yml and
92 Copy config/configuration.yml.example to config/configuration.yml and
90 edit this file to adjust your SMTP settings.
93 edit this file to adjust your SMTP settings.
91 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.
92
95
93 Please do not enter your SMTP settings in environment.rb.
96 Please do not enter your SMTP settings in environment.rb.
94
97
95 == References
98 == References
96
99
97 * http://www.redmine.org/wiki/redmine/RedmineInstall
100 * http://www.redmine.org/wiki/redmine/RedmineInstall
98 * http://www.redmine.org/wiki/redmine/EmailConfiguration
101 * http://www.redmine.org/wiki/redmine/EmailConfiguration
99 * http://www.redmine.org/wiki/redmine/RedmineSettings
102 * http://www.redmine.org/wiki/redmine/RedmineSettings
100 * http://www.redmine.org/wiki/redmine/RedmineRepositories
103 * http://www.redmine.org/wiki/redmine/RedmineRepositories
101 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
104 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
102 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
105 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
103 * http://www.redmine.org/wiki/redmine/RedmineLDAP
106 * http://www.redmine.org/wiki/redmine/RedmineLDAP
@@ -1,78 +1,84
1 == Redmine upgrade
1 == Redmine upgrade
2
2
3 Redmine - project management software
3 Redmine - project management software
4 Copyright (C) 2006-2015 Jean-Philippe Lang
4 Copyright (C) 2006-2015 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
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
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
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
38 forget to re-run `bundle install` when you change config/database.yml for using
39 other database adapters.
39 other database adapters.
40
40
41 If you need to load some gems that are not required by Redmine core (eg. fcgi),
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.
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`.
43 It will be loaded automatically when running `bundle install`.
44
44
45 6. Generate a session store secret
45 6. Generate a session store secret
46
46
47 Redmine stores session data in cookies by default, which requires
47 If you're upgrading from Redmine 2.x or below, remove the following file
48 a secret to be generated. Under the new application directory run:
48 if it exists: config/initializers/secret_token.rb
49
50 Then generate a new secret by running the following command under the
51 application directory:
49 bundle exec rake generate_secret_token
52 bundle exec rake generate_secret_token
50
53
54 Alternatively, you can store this secret in config/secrets.yml:
55 http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
56
51 DO NOT REPLACE OR EDIT ANY OTHER FILES.
57 DO NOT REPLACE OR EDIT ANY OTHER FILES.
52
58
53 7. Migrate your database
59 7. Migrate your database
54
60
55 If you are upgrading to Rails 2.3.14 as part of this migration, you
61 If you are upgrading to Rails 2.3.14 as part of this migration, you
56 need to upgrade the plugin migrations before running the plugin migrations
62 need to upgrade the plugin migrations before running the plugin migrations
57 using:
63 using:
58 bundle exec rake db:migrate:upgrade_plugin_migrations RAILS_ENV="production"
64 bundle exec rake db:migrate:upgrade_plugin_migrations RAILS_ENV="production"
59
65
60 Please make a backup before doing this! Under the new application
66 Please make a backup before doing this! Under the new application
61 directory run:
67 directory run:
62 bundle exec rake db:migrate RAILS_ENV="production"
68 bundle exec rake db:migrate RAILS_ENV="production"
63
69
64 If you have installed any plugins, you should also run their database
70 If you have installed any plugins, you should also run their database
65 migrations using:
71 migrations using:
66 bundle exec rake db:migrate_plugins RAILS_ENV="production"
72 bundle exec rake db:migrate_plugins RAILS_ENV="production"
67
73
68 8. Clear the cache and the existing sessions by running:
74 8. Clear the cache and the existing sessions by running:
69 bundle exec rake tmp:cache:clear tmp:sessions:clear
75 bundle exec rake tmp:cache:clear tmp:sessions:clear
70
76
71 9. Restart the application server (e.g. mongrel, thin, passenger)
77 9. Restart the application server (e.g. mongrel, thin, passenger)
72
78
73 10. Finally go to "Administration -> Roles & permissions" to check/set permissions
79 10. Finally go to "Administration -> Roles & permissions" to check/set permissions
74 for new features, if any
80 for new features, if any
75
81
76 == References
82 == References
77
83
78 * http://www.redmine.org/wiki/redmine/RedmineUpgrade
84 * http://www.redmine.org/wiki/redmine/RedmineUpgrade
General Comments 0
You need to be logged in to leave comments. Login now