##// END OF EJS Templates
Merged r11592 from trunk....
Jean-Philippe Lang -
r11526:5fa087a79221
parent child
Show More
@@ -1,99 +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 or 1.9.3
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.7)
17 * SQLite3 (tested with SQLite 3.7)
18 * SQLServer (tested with SQLServer 2012)
18
19
19 Optional:
20 Optional:
20 * 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)
21 * ImageMagick (to enable Gantt export to png images)
22 * ImageMagick (to enable Gantt export to png images)
22
23
23 == Installation
24 == Installation
24
25
25 1. Uncompress the program archive
26 1. Uncompress the program archive
26
27
27 2. Create an empty utf8 encoded database: "redmine" for example
28 2. Create an empty utf8 encoded database: "redmine" for example
28
29
29 3. Configure the database parameters in config/database.yml
30 3. Configure the database parameters in config/database.yml
30 for the "production" environment (default database is MySQL and ruby1.9)
31 for the "production" environment (default database is MySQL and ruby1.9)
31
32
32 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
33 with `mysql`
34 with `mysql`
34
35
35 4. Install the required gems by running:
36 4. Install the required gems by running:
36 bundle install --without development test
37 bundle install --without development test
37
38
38 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
39 of the rmagick gem using:
40 of the rmagick gem using:
40 bundle install --without development test rmagick
41 bundle install --without development test rmagick
41
42
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
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
47 other database adapters.
48
42 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),
43 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.
44 It will be loaded automatically when running `bundle install`.
51 It will be loaded automatically when running `bundle install`.
45
52
46 5. Generate a session store secret
53 5. Generate a session store secret
47
54
48 Redmine stores session data in cookies by default, which requires
55 Redmine stores session data in cookies by default, which requires
49 a secret to be generated. Under the application main directory run:
56 a secret to be generated. Under the application main directory run:
50 rake generate_secret_token
57 rake generate_secret_token
51
58
52 6. Create the database structure
59 6. Create the database structure
53
60
54 Under the application main directory run:
61 Under the application main directory run:
55 rake db:migrate RAILS_ENV="production"
62 rake db:migrate RAILS_ENV="production"
56
63
57 It will create all the tables and an administrator account.
64 It will create all the tables and an administrator account.
58
65
59 7. Setting up permissions (Windows users have to skip this section)
66 7. Setting up permissions (Windows users have to skip this section)
60
67
61 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
62 subdirectories: files, log, tmp & public/plugin_assets.
69 subdirectories: files, log, tmp & public/plugin_assets.
63
70
64 Assuming you run Redmine with a user named "redmine":
71 Assuming you run Redmine with a user named "redmine":
65 sudo chown -R redmine:redmine files log tmp public/plugin_assets
72 sudo chown -R redmine:redmine files log tmp public/plugin_assets
66 sudo chmod -R 755 files log tmp public/plugin_assets
73 sudo chmod -R 755 files log tmp public/plugin_assets
67
74
68 8. Test the installation by running the WEBrick web server
75 8. Test the installation by running the WEBrick web server
69
76
70 Under the main application directory run:
77 Under the main application directory run:
71 ruby script/rails server -e production
78 ruby script/rails server -e production
72
79
73 Once WEBrick has started, point your browser to http://localhost:3000/
80 Once WEBrick has started, point your browser to http://localhost:3000/
74 You should now see the application welcome page.
81 You should now see the application welcome page.
75
82
76 9. Use the default administrator account to log in:
83 9. Use the default administrator account to log in:
77 login: admin
84 login: admin
78 password: admin
85 password: admin
79
86
80 Go to "Administration" to load the default configuration data (roles,
87 Go to "Administration" to load the default configuration data (roles,
81 trackers, statuses, workflow) and to adjust the application settings
88 trackers, statuses, workflow) and to adjust the application settings
82
89
83 == SMTP server Configuration
90 == SMTP server Configuration
84
91
85 Copy config/configuration.yml.example to config/configuration.yml and
92 Copy config/configuration.yml.example to config/configuration.yml and
86 edit this file to adjust your SMTP settings.
93 edit this file to adjust your SMTP settings.
87 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.
88
95
89 Please do not enter your SMTP settings in environment.rb.
96 Please do not enter your SMTP settings in environment.rb.
90
97
91 == References
98 == References
92
99
93 * http://www.redmine.org/wiki/redmine/RedmineInstall
100 * http://www.redmine.org/wiki/redmine/RedmineInstall
94 * http://www.redmine.org/wiki/redmine/EmailConfiguration
101 * http://www.redmine.org/wiki/redmine/EmailConfiguration
95 * http://www.redmine.org/wiki/redmine/RedmineSettings
102 * http://www.redmine.org/wiki/redmine/RedmineSettings
96 * http://www.redmine.org/wiki/redmine/RedmineRepositories
103 * http://www.redmine.org/wiki/redmine/RedmineRepositories
97 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
104 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
98 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
105 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
99 * http://www.redmine.org/wiki/redmine/RedmineLDAP
106 * http://www.redmine.org/wiki/redmine/RedmineLDAP
General Comments 0
You need to be logged in to leave comments. Login now