##// END OF EJS Templates
doc/INSTALL: update requirements Bundler >= 1.5.0 (#19172)...
Toshi MARUYAMA -
r14061:f64f8723d820
parent child
Show More
@@ -1,106 +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 * Bundler >= 1.0.21
12 * Bundler >= 1.5.0
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 56 Alternatively, you can store this secret in config/secrets.yml:
57 57 http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
58 58
59 59 6. Create the database structure
60 60
61 61 Under the application main directory run:
62 62 bundle exec rake db:migrate RAILS_ENV="production"
63 63
64 64 It will create all the tables and an administrator account.
65 65
66 66 7. Setting up permissions (Windows users have to skip this section)
67 67
68 68 The user who runs Redmine must have write permission on the following
69 69 subdirectories: files, log, tmp & public/plugin_assets.
70 70
71 71 Assuming you run Redmine with a user named "redmine":
72 72 sudo chown -R redmine:redmine files log tmp public/plugin_assets
73 73 sudo chmod -R 755 files log tmp public/plugin_assets
74 74
75 75 8. Test the installation by running the WEBrick web server
76 76
77 77 Under the main application directory run:
78 78 ruby bin/rails server -e production
79 79
80 80 Once WEBrick has started, point your browser to http://localhost:3000/
81 81 You should now see the application welcome page.
82 82
83 83 9. Use the default administrator account to log in:
84 84 login: admin
85 85 password: admin
86 86
87 87 Go to "Administration" to load the default configuration data (roles,
88 88 trackers, statuses, workflow) and to adjust the application settings
89 89
90 90 == SMTP server Configuration
91 91
92 92 Copy config/configuration.yml.example to config/configuration.yml and
93 93 edit this file to adjust your SMTP settings.
94 94 Do not forget to restart the application after any change to this file.
95 95
96 96 Please do not enter your SMTP settings in environment.rb.
97 97
98 98 == References
99 99
100 100 * http://www.redmine.org/wiki/redmine/RedmineInstall
101 101 * http://www.redmine.org/wiki/redmine/EmailConfiguration
102 102 * http://www.redmine.org/wiki/redmine/RedmineSettings
103 103 * http://www.redmine.org/wiki/redmine/RedmineRepositories
104 104 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
105 105 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
106 106 * http://www.redmine.org/wiki/redmine/RedmineLDAP
General Comments 0
You need to be logged in to leave comments. Login now