##// END OF EJS Templates
jro_apps » redmine
RSS
Doc updated for Rails 2.3.14....
Jean-Philippe Lang -
r7729:89ce0d0aea88
parent child
Show More
Side by Side Unified
Context file:
r7729:89ce0d0aea88 Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,97 +1,97
1 1 == Redmine installation
2 2
3 3 Redmine - project management software
4 4 Copyright (C) 2006-2011 Jean-Philippe Lang
5 5 http://www.redmine.org/
6 6
7 7
8 8 == Requirements
9 9
10 10 * Ruby 1.8.6 or 1.8.7
11 11
12 12 * RubyGems 1.3.7
13 13
14 * Ruby on Rails 2.3.11 (official downloadable Redmine releases are packaged with
14 * Ruby on Rails 2.3.14 (official downloadable Redmine releases are packaged with
15 15 the appropriate Rails version)
16 16
17 * Rack 1.1.0 gem
17 * Rack 1.1.2 gem
18 18
19 * Rake 0.8.3 gem
19 * Rake 0.9.2 gem
20 20
21 21 * I18n 0.4.2 gem
22 22
23 23 * A database:
24 24 * MySQL (tested with MySQL 5.1)
25 25 * PostgreSQL (tested with PostgreSQL 8.4)
26 26 * SQLite3 (tested with SQLite 3.6)
27 27
28 28 Optional:
29 29 * SCM binaries (e.g. svn), for repository browsing (must be available in PATH)
30 30 * RMagick (to enable Gantt export to png images)
31 31 * Ruby OpenID Library >= version 2 (to enable OpenID support)
32 32
33 33 == Installation
34 34
35 35 1. Uncompress the program archive
36 36
37 37 2. Create an empty database: "redmine" for example
38 38
39 39 3. Configure the database parameters in config/database.yml
40 40 for the "production" environment (default database is MySQL)
41 41
42 42 4. Generate a session store secret
43 43
44 44 Redmine stores session data in cookies by default, which requires
45 45 a secret to be generated. Under the application main directory run:
46 46 rake generate_session_store
47 47
48 48 5. Create the database structure
49 49
50 50 Under the application main directory run:
51 51 rake db:migrate RAILS_ENV="production"
52 52
53 53 It will create all the tables and an administrator account.
54 54
55 55 6. Setting up permissions (Windows users have to skip this section)
56 56
57 57 The user who runs Redmine must have write permission on the following
58 58 subdirectories: files, log, tmp & public/plugin_assets (create the last
59 59 two if they are not yet present).
60 60
61 61 Assuming you run Redmine with a user named "redmine":
62 62 mkdir tmp public/plugin_assets
63 63 sudo chown -R redmine:redmine files log tmp public/plugin_assets
64 64 sudo chmod -R 755 files log tmp public/plugin_assets
65 65
66 66 7. Test the installation by running the WEBrick web server
67 67
68 68 Under the main application directory run:
69 69 ruby script/server -e production
70 70
71 71 Once WEBrick has started, point your browser to http://localhost:3000/
72 72 You should now see the application welcome page.
73 73
74 74 8. Use the default administrator account to log in:
75 75 login: admin
76 76 password: admin
77 77
78 78 Go to "Administration" to load the default configuration data (roles,
79 79 trackers, statuses, workflow) and to adjust the application settings
80 80
81 81 == SMTP server Configuration
82 82
83 83 Copy config/configuration.yml.example to config/configuration.yml and
84 84 edit this file to adjust your SMTP settings.
85 85 Do not forget to restart the application after any change to this file.
86 86
87 87 Please do not enter your SMTP settings in environment.rb.
88 88
89 89 == References
90 90
91 91 * http://www.redmine.org/wiki/redmine/RedmineInstall
92 92 * http://www.redmine.org/wiki/redmine/EmailConfiguration
93 93 * http://www.redmine.org/wiki/redmine/RedmineSettings
94 94 * http://www.redmine.org/wiki/redmine/RedmineRepositories
95 95 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
96 96 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
97 97 * http://www.redmine.org/wiki/redmine/RedmineLDAP
Show file before | Show file after | Hide comments
@@ -1,63 +1,63
1 1 == Redmine upgrade
2 2
3 3 Redmine - project management software
4 4 Copyright (C) 2006-2011 Jean-Philippe Lang
5 5 http://www.redmine.org/
6 6
7 7
8 8 == Upgrading
9 9
10 10 1. Uncompress the program archive in a new directory
11 11
12 12 2. Copy your database settings (RAILS_ROOT/config/database.yml)
13 13 and your configuration file (RAILS_ROOT/config/configuration.yml)
14 14 into the new config directory
15 15 Note: before Redmine 1.2, SMTP configuration was stored in
16 16 config/email.yml. It should now be stored in config/configuration.yml.
17 17
18 18 3. Copy the RAILS_ROOT/files directory content into your new installation
19 19 This directory contains all the attached files.
20 20
21 21 4. Copy the folders of the installed plugins and themes into new installation
22 22
23 23 5. Generate a session store secret
24 24
25 25 Redmine stores session data in cookies by default, which requires
26 26 a secret to be generated. Under the new application directory run:
27 27 rake generate_session_store
28 28
29 29 DO NOT REPLACE OR EDIT ANY OTHER FILES.
30 30
31 31 6. Migrate your database
32 32
33 If you are upgrading to Rails 2.3.11 as part of this migration, you
33 If you are upgrading to Rails 2.3.14 as part of this migration, you
34 34 need to upgrade the plugin migrations before running the plugin migrations
35 35 using:
36 36 rake db:migrate:upgrade_plugin_migrations RAILS_ENV="production"
37 37
38 38 Please make a backup before doing this! Under the new application
39 39 directory run:
40 40 rake db:migrate RAILS_ENV="production"
41 41
42 42 If you have installed any plugins, you should also run their database
43 43 migrations using:
44 44 rake db:migrate_plugins RAILS_ENV="production"
45 45
46 46 7. Clean up
47 47
48 48 Clear the cache and the existing sessions by running:
49 49 rake tmp:cache:clear
50 50 rake tmp:sessions:clear
51 51
52 52 8. Restart the application server (e.g. mongrel, thin, passenger)
53 53
54 54 9. Finally go to "Administration -> Roles & permissions" to check/set permissions
55 55 for new features, if any
56 56
57 57 == Notes
58 58
59 * Rails 2.3.11 is required for versions 1.2.x.
59 * Rails 2.3.14 is required for versions 1.3.x.
60 60
61 61 == References
62 62
63 63 * http://www.redmine.org/wiki/redmine/RedmineUpgrade
General Comments 0
You need to be logged in to leave comments. Login now