doc/INSTALL

   1 == Redmine installation
   2
   3 Redmine - project management software
   4 Copyright (C) 2006-2007  Jean-Philippe Lang
   5 http://www.redmine.org/
   6
   7
   8 == Requirements
   9
  10 * Ruby on Rails 1.2.2 or higher (this release won't work with Rails 2.0)
  11 * A database (see compatibility below)
  12
  13 Optional:
  14 * SVN binaries >= 1.3 (needed for repository browsing, must be available in PATH)
  15 * RMagick (gantt export to png)
  16
  17 Supported databases:
  18 * MySQL (tested with MySQL 5)
  19 * PostgreSQL (tested with PostgreSQL 8.1)
  20 * SQLite (tested with SQLite 3)
  21
  22
  23 == Installation
  24
  25 1. Uncompress the program archive
  26
  27 2. Create an empty database: "redmine" for example
  28
  29 3. Configure database parameters in config/database.yml
  30    for "production" environment (default database is MySQL)
  31
  32 4. Create the database structure. Under the application main directory:
  33    rake db:migrate RAILS_ENV="production"
  34    It will create tables and an administrator account.
  35
  36 5. Insert default configuration data in the database:
  37    rake redmine:load_default_data RAILS_ENV="production"
  38    It will load default roles, trackers, statuses, workflows and enumerations.
  39    This step is optional but *highly recommended*
  40
  41 6. Test the installation by running WEBrick web server:
  42    ruby script/server -e production
  43
  44    Once WEBrick has started, point your browser to http://localhost:3000/
  45    You should now see the application welcome page
  46
  47 7. Use default administrator account to log in:
  48    login: admin
  49    password: admin
  50
  51 8. You can go to "Admin -> Settings" to modify application settings.
  52
  53 9. Setup Apache or Lighttpd with fastcgi for best performance.
  54
  55
  56 == SMTP server Configuration
  57
  58 In config/environment.rb, you can set parameters for your SMTP server:
  59 config.action_mailer.smtp_settings: SMTP server configuration
  60 config.action_mailer.perform_deliveries: set to false to disable mail delivering
  61
  62 Don't forget to restart the application after any change to this file.