annotate doc/INSTALL @ 45:65d9e2cabaa3 luisf

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