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