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