doc/INSTALL

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