annotate doc/INSTALL @ 1181:27b6f53331d5 bug_320

Close obsolete branch bug_320
author Chris Cannam
date Wed, 09 Nov 2011 14:19:49 +0000
parents cbce1fd3b1b7
children cbb26bc654de
rev   line source
Chris@0 1 == Redmine installation
Chris@0 2
Chris@0 3 Redmine - project management software
Chris@441 4 Copyright (C) 2006-2011 Jean-Philippe Lang
Chris@0 5 http://www.redmine.org/
Chris@0 6
Chris@0 7
Chris@0 8 == Requirements
Chris@0 9
Chris@0 10 * Ruby 1.8.6 or 1.8.7
Chris@0 11
Chris@441 12 * RubyGems 1.3.7
Chris@119 13
Chris@441 14 * Ruby on Rails 2.3.11 (official downloadable Redmine releases are packaged with
Chris@0 15 the appropriate Rails version)
Chris@0 16
Chris@441 17 * Rack 1.1.0 gem
Chris@0 18
Chris@119 19 * Rake 0.8.3 gem
Chris@0 20
Chris@119 21 * I18n 0.4.2 gem
Chris@0 22
Chris@0 23 * A database:
Chris@441 24 * MySQL (tested with MySQL 5.1)
Chris@441 25 * PostgreSQL (tested with PostgreSQL 8.4)
Chris@441 26 * SQLite3 (tested with SQLite 3.6)
Chris@0 27
Chris@0 28 Optional:
Chris@0 29 * SCM binaries (e.g. svn), for repository browsing (must be available in PATH)
Chris@0 30 * RMagick (to enable Gantt export to png images)
Chris@0 31 * Ruby OpenID Library >= version 2 (to enable OpenID support)
Chris@0 32
Chris@0 33 == Installation
Chris@0 34
Chris@0 35 1. Uncompress the program archive
Chris@0 36
Chris@0 37 2. Create an empty database: "redmine" for example
Chris@0 38
Chris@0 39 3. Configure the database parameters in config/database.yml
Chris@0 40 for the "production" environment (default database is MySQL)
Chris@0 41
Chris@0 42 4. Generate a session store secret
Chris@0 43
Chris@0 44 Redmine stores session data in cookies by default, which requires
Chris@0 45 a secret to be generated. Under the application main directory run:
Chris@0 46 rake generate_session_store
Chris@0 47
Chris@0 48 5. Create the database structure
Chris@0 49
Chris@0 50 Under the application main directory run:
Chris@0 51 rake db:migrate RAILS_ENV="production"
Chris@0 52
Chris@0 53 It will create all the tables and an administrator account.
Chris@0 54
Chris@0 55 6. Setting up permissions (Windows users have to skip this section)
Chris@0 56
Chris@0 57 The user who runs Redmine must have write permission on the following
Chris@0 58 subdirectories: files, log, tmp & public/plugin_assets (create the last
Chris@0 59 two if they are not yet present).
Chris@0 60
Chris@0 61 Assuming you run Redmine with a user named "redmine":
Chris@0 62 mkdir tmp public/plugin_assets
Chris@0 63 sudo chown -R redmine:redmine files log tmp public/plugin_assets
Chris@0 64 sudo chmod -R 755 files log tmp public/plugin_assets
Chris@0 65
Chris@0 66 7. Test the installation by running the WEBrick web server
Chris@0 67
Chris@0 68 Under the main application directory run:
Chris@0 69 ruby script/server -e production
Chris@0 70
Chris@0 71 Once WEBrick has started, point your browser to http://localhost:3000/
Chris@0 72 You should now see the application welcome page.
Chris@0 73
Chris@0 74 8. Use the default administrator account to log in:
Chris@0 75 login: admin
Chris@0 76 password: admin
Chris@0 77
Chris@0 78 Go to "Administration" to load the default configuration data (roles,
Chris@0 79 trackers, statuses, workflow) and to adjust the application settings
Chris@0 80
Chris@0 81 == SMTP server Configuration
Chris@0 82
Chris@210 83 Copy config/configuration.yml.example to config/configuration.yml and
Chris@210 84 edit this file to adjust your SMTP settings.
Chris@0 85 Do not forget to restart the application after any change to this file.
Chris@0 86
Chris@0 87 Please do not enter your SMTP settings in environment.rb.
Chris@0 88
Chris@0 89 == References
Chris@0 90
Chris@0 91 * http://www.redmine.org/wiki/redmine/RedmineInstall
Chris@0 92 * http://www.redmine.org/wiki/redmine/EmailConfiguration
Chris@0 93 * http://www.redmine.org/wiki/redmine/RedmineSettings
Chris@0 94 * http://www.redmine.org/wiki/redmine/RedmineRepositories
Chris@0 95 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
Chris@0 96 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
Chris@0 97 * http://www.redmine.org/wiki/redmine/RedmineLDAP