doc/INSTALL

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