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