|
Chris@0
|
1 == Redmine installation
|
|
Chris@0
|
2
|
|
Chris@0
|
3 Redmine - project management software
|
|
Chris@1494
|
4 Copyright (C) 2006-2014 Jean-Philippe Lang
|
|
Chris@0
|
5 http://www.redmine.org/
|
|
Chris@0
|
6
|
|
Chris@0
|
7
|
|
Chris@0
|
8 == Requirements
|
|
Chris@0
|
9
|
|
Chris@1464
|
10 * Ruby 1.8.7, 1.9.2, 1.9.3 or 2.0.0
|
|
Chris@1115
|
11 * RubyGems
|
|
Chris@1115
|
12 * Bundler >= 1.0.21
|
|
Chris@0
|
13
|
|
Chris@0
|
14 * A database:
|
|
Chris@441
|
15 * MySQL (tested with MySQL 5.1)
|
|
Chris@1115
|
16 * PostgreSQL (tested with PostgreSQL 9.1)
|
|
Chris@1464
|
17 * SQLite3 (tested with SQLite 3.7)
|
|
Chris@1464
|
18 * SQLServer (tested with SQLServer 2012)
|
|
Chris@0
|
19
|
|
Chris@0
|
20 Optional:
|
|
Chris@1115
|
21 * SCM binaries (e.g. svn, git...), for repository browsing (must be available in PATH)
|
|
Chris@1115
|
22 * ImageMagick (to enable Gantt export to png images)
|
|
Chris@0
|
23
|
|
Chris@0
|
24 == Installation
|
|
Chris@0
|
25
|
|
Chris@0
|
26 1. Uncompress the program archive
|
|
Chris@0
|
27
|
|
Chris@1464
|
28 2. Create an empty utf8 encoded database: "redmine" for example
|
|
Chris@1464
|
29
|
|
Chris@1464
|
30 3. Configure the database parameters in config/database.yml
|
|
Chris@1464
|
31 for the "production" environment (default database is MySQL and ruby1.9)
|
|
Chris@1464
|
32
|
|
Chris@1464
|
33 If you're running Redmine with MySQL and ruby1.8, replace the adapter name
|
|
Chris@1464
|
34 with `mysql`
|
|
Chris@1464
|
35
|
|
Chris@1464
|
36 4. Install the required gems by running:
|
|
Chris@1115
|
37 bundle install --without development test
|
|
Chris@0
|
38
|
|
Chris@1115
|
39 If ImageMagick is not installed on your system, you should skip the installation
|
|
Chris@1115
|
40 of the rmagick gem using:
|
|
Chris@1115
|
41 bundle install --without development test rmagick
|
|
Chris@0
|
42
|
|
Chris@1464
|
43 Only the gems that are needed by the adapters you've specified in your database
|
|
Chris@1464
|
44 configuration file are actually installed (eg. if your config/database.yml
|
|
Chris@1464
|
45 uses the 'mysql2' adapter, then only the mysql2 gem will be installed). Don't
|
|
Chris@1464
|
46 forget to re-run `bundle install` when you change config/database.yml for using
|
|
Chris@1464
|
47 other database adapters.
|
|
Chris@1464
|
48
|
|
Chris@1115
|
49 If you need to load some gems that are not required by Redmine core (eg. fcgi),
|
|
Chris@1115
|
50 you can create a file named Gemfile.local at the root of your redmine directory.
|
|
Chris@1115
|
51 It will be loaded automatically when running `bundle install`.
|
|
Chris@1115
|
52
|
|
Chris@1115
|
53 5. Generate a session store secret
|
|
Chris@0
|
54
|
|
Chris@0
|
55 Redmine stores session data in cookies by default, which requires
|
|
Chris@0
|
56 a secret to be generated. Under the application main directory run:
|
|
Chris@1115
|
57 rake generate_secret_token
|
|
Chris@0
|
58
|
|
Chris@1115
|
59 6. Create the database structure
|
|
Chris@0
|
60
|
|
Chris@0
|
61 Under the application main directory run:
|
|
Chris@0
|
62 rake db:migrate RAILS_ENV="production"
|
|
Chris@0
|
63
|
|
Chris@0
|
64 It will create all the tables and an administrator account.
|
|
Chris@0
|
65
|
|
Chris@1115
|
66 7. Setting up permissions (Windows users have to skip this section)
|
|
Chris@0
|
67
|
|
Chris@0
|
68 The user who runs Redmine must have write permission on the following
|
|
Chris@1115
|
69 subdirectories: files, log, tmp & public/plugin_assets.
|
|
Chris@0
|
70
|
|
Chris@0
|
71 Assuming you run Redmine with a user named "redmine":
|
|
Chris@0
|
72 sudo chown -R redmine:redmine files log tmp public/plugin_assets
|
|
Chris@0
|
73 sudo chmod -R 755 files log tmp public/plugin_assets
|
|
Chris@0
|
74
|
|
Chris@1115
|
75 8. Test the installation by running the WEBrick web server
|
|
Chris@0
|
76
|
|
Chris@0
|
77 Under the main application directory run:
|
|
Chris@1115
|
78 ruby script/rails server -e production
|
|
Chris@0
|
79
|
|
Chris@0
|
80 Once WEBrick has started, point your browser to http://localhost:3000/
|
|
Chris@0
|
81 You should now see the application welcome page.
|
|
Chris@0
|
82
|
|
Chris@1115
|
83 9. Use the default administrator account to log in:
|
|
Chris@0
|
84 login: admin
|
|
Chris@0
|
85 password: admin
|
|
Chris@0
|
86
|
|
Chris@0
|
87 Go to "Administration" to load the default configuration data (roles,
|
|
Chris@0
|
88 trackers, statuses, workflow) and to adjust the application settings
|
|
Chris@0
|
89
|
|
Chris@0
|
90 == SMTP server Configuration
|
|
Chris@0
|
91
|
|
Chris@210
|
92 Copy config/configuration.yml.example to config/configuration.yml and
|
|
Chris@210
|
93 edit this file to adjust your SMTP settings.
|
|
Chris@0
|
94 Do not forget to restart the application after any change to this file.
|
|
Chris@0
|
95
|
|
Chris@0
|
96 Please do not enter your SMTP settings in environment.rb.
|
|
Chris@0
|
97
|
|
Chris@0
|
98 == References
|
|
Chris@0
|
99
|
|
Chris@0
|
100 * http://www.redmine.org/wiki/redmine/RedmineInstall
|
|
Chris@0
|
101 * http://www.redmine.org/wiki/redmine/EmailConfiguration
|
|
Chris@0
|
102 * http://www.redmine.org/wiki/redmine/RedmineSettings
|
|
Chris@0
|
103 * http://www.redmine.org/wiki/redmine/RedmineRepositories
|
|
Chris@0
|
104 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
|
|
Chris@0
|
105 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
|
|
Chris@0
|
106 * http://www.redmine.org/wiki/redmine/RedmineLDAP
|
