##// END OF EJS Templates
jro_apps » redmine
RSS
wrap lines less than 80 characters in doc/INSTALL (#20498)...
Toshi MARUYAMA -
r14103:d59ac02fe9cb
parent child
Show More
Side by Side Unified
Context file:
r14103:d59ac02fe9cb Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,106 +1,108
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.5.0
12 * Bundler >= 1.5.0
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
22 available in PATH)
22 * ImageMagick (to enable Gantt export to png images)
23 * ImageMagick (to enable Gantt export to png images)
23
24
24 == Installation
25 == Installation
25
26
26 1. Uncompress the program archive
27 1. Uncompress the program archive
27
28
28 2. Create an empty utf8 encoded database: "redmine" for example
29 2. Create an empty utf8 encoded database: "redmine" for example
29
30
30 3. Configure the database parameters in config/database.yml
31 3. Configure the database parameters in config/database.yml
31 for the "production" environment (default database is MySQL and ruby1.9)
32 for the "production" environment (default database is MySQL and ruby1.9)
32
33
33 4. Install the required gems by running:
34 4. Install the required gems by running:
34 bundle install --without development test
35 bundle install --without development test
35
36
36 If ImageMagick is not installed on your system, you should skip the installation
37 If ImageMagick is not installed on your system, you should skip the
37 of the rmagick gem using:
38 installation of the rmagick gem using:
38 bundle install --without development test rmagick
39 bundle install --without development test rmagick
39
40
40 Only the gems that are needed by the adapters you've specified in your database
41 Only the gems that are needed by the adapters you've specified in your
41 configuration file are actually installed (eg. if your config/database.yml
42 database configuration file are actually installed (eg. if your
42 uses the 'mysql2' adapter, then only the mysql2 gem will be installed). Don't
43 config/database.yml uses the 'mysql2' adapter, then only the mysql2 gem
43 forget to re-run `bundle install` when you change config/database.yml for using
44 will be installed). Don't forget to re-run `bundle install` when you
44 other database adapters.
45 change config/database.yml for using other database adapters.
45
46
46 If you need to load some gems that are not required by Redmine core (eg. fcgi),
47 If you need to load some gems that are not required by Redmine core
47 you can create a file named Gemfile.local at the root of your redmine directory.
48 (eg. fcgi), you can create a file named Gemfile.local at the root of
49 your redmine directory.
48 It will be loaded automatically when running `bundle install`.
50 It will be loaded automatically when running `bundle install`.
49
51
50 5. Generate a session store secret
52 5. Generate a session store secret
51
53
52 Redmine stores session data in cookies by default, which requires
54 Redmine stores session data in cookies by default, which requires
53 a secret to be generated. Under the application main directory run:
55 a secret to be generated. Under the application main directory run:
54 bundle exec rake generate_secret_token
56 bundle exec rake generate_secret_token
55
57
56 Alternatively, you can store this secret in config/secrets.yml:
58 Alternatively, you can store this secret in config/secrets.yml:
57 http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
59 http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
58
60
59 6. Create the database structure
61 6. Create the database structure
60
62
61 Under the application main directory run:
63 Under the application main directory run:
62 bundle exec rake db:migrate RAILS_ENV="production"
64 bundle exec rake db:migrate RAILS_ENV="production"
63
65
64 It will create all the tables and an administrator account.
66 It will create all the tables and an administrator account.
65
67
66 7. Setting up permissions (Windows users have to skip this section)
68 7. Setting up permissions (Windows users have to skip this section)
67
69
68 The user who runs Redmine must have write permission on the following
70 The user who runs Redmine must have write permission on the following
69 subdirectories: files, log, tmp & public/plugin_assets.
71 subdirectories: files, log, tmp & public/plugin_assets.
70
72
71 Assuming you run Redmine with a user named "redmine":
73 Assuming you run Redmine with a user named "redmine":
72 sudo chown -R redmine:redmine files log tmp public/plugin_assets
74 sudo chown -R redmine:redmine files log tmp public/plugin_assets
73 sudo chmod -R 755 files log tmp public/plugin_assets
75 sudo chmod -R 755 files log tmp public/plugin_assets
74
76
75 8. Test the installation by running the WEBrick web server
77 8. Test the installation by running the WEBrick web server
76
78
77 Under the main application directory run:
79 Under the main application directory run:
78 ruby bin/rails server -e production
80 ruby bin/rails server -e production
79
81
80 Once WEBrick has started, point your browser to http://localhost:3000/
82 Once WEBrick has started, point your browser to http://localhost:3000/
81 You should now see the application welcome page.
83 You should now see the application welcome page.
82
84
83 9. Use the default administrator account to log in:
85 9. Use the default administrator account to log in:
84 login: admin
86 login: admin
85 password: admin
87 password: admin
86
88
87 Go to "Administration" to load the default configuration data (roles,
89 Go to "Administration" to load the default configuration data (roles,
88 trackers, statuses, workflow) and to adjust the application settings
90 trackers, statuses, workflow) and to adjust the application settings
89
91
90 == SMTP server Configuration
92 == SMTP server Configuration
91
93
92 Copy config/configuration.yml.example to config/configuration.yml and
94 Copy config/configuration.yml.example to config/configuration.yml and
93 edit this file to adjust your SMTP settings.
95 edit this file to adjust your SMTP settings.
94 Do not forget to restart the application after any change to this file.
96 Do not forget to restart the application after any change to this file.
95
97
96 Please do not enter your SMTP settings in environment.rb.
98 Please do not enter your SMTP settings in environment.rb.
97
99
98 == References
100 == References
99
101
100 * http://www.redmine.org/wiki/redmine/RedmineInstall
102 * http://www.redmine.org/wiki/redmine/RedmineInstall
101 * http://www.redmine.org/wiki/redmine/EmailConfiguration
103 * http://www.redmine.org/wiki/redmine/EmailConfiguration
102 * http://www.redmine.org/wiki/redmine/RedmineSettings
104 * http://www.redmine.org/wiki/redmine/RedmineSettings
103 * http://www.redmine.org/wiki/redmine/RedmineRepositories
105 * http://www.redmine.org/wiki/redmine/RedmineRepositories
104 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
106 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
105 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
107 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
106 * http://www.redmine.org/wiki/redmine/RedmineLDAP
108 * http://www.redmine.org/wiki/redmine/RedmineLDAP
General Comments 0
You need to be logged in to leave comments. Login now