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