Chris@909: == Redmine installation
Chris@909: 
Chris@909: Redmine - project management software
Chris@909: Copyright (C) 2006-2011  Jean-Philippe Lang
Chris@909: http://www.redmine.org/
Chris@909: 
Chris@909: 
Chris@909: == Requirements
Chris@909: 
Chris@909: * Ruby 1.8.6 or 1.8.7
Chris@909: 
Chris@909: * RubyGems 1.3.7
Chris@909: 
Chris@909: * Ruby on Rails 2.3.14 (official downloadable Redmine releases are packaged with
Chris@909:   the appropriate Rails version)
Chris@909: 
Chris@909: * Rack 1.1.2 gem
Chris@909: 
Chris@909: * Rake 0.9.2 gem
Chris@909: 
Chris@909: * I18n 0.4.2 gem
Chris@909: 
Chris@909: * A database:
Chris@909:   * MySQL (tested with MySQL 5.1)
Chris@909:   * PostgreSQL (tested with PostgreSQL 8.4)
Chris@909:   * SQLite3 (tested with SQLite 3.6)
Chris@909: 
Chris@909: Optional:
Chris@909: * SCM binaries (e.g. svn), for repository browsing (must be available in PATH)
Chris@909: * RMagick (to enable Gantt export to png images)
Chris@909: * Ruby OpenID Library >= version 2 (to enable OpenID support)
Chris@909: 
Chris@909: == Installation
Chris@909: 
Chris@909: 1. Uncompress the program archive
Chris@909: 
Chris@909: 2. Create an empty database: "redmine" for example
Chris@909: 
Chris@909: 3. Configure the database parameters in config/database.yml
Chris@909:    for the "production" environment (default database is MySQL)
Chris@909: 
Chris@909: 4. Generate a session store secret
Chris@909:    
Chris@909:    Redmine stores session data in cookies by default, which requires
Chris@909:    a secret to be generated. Under the application main directory run:
Chris@909:      rake generate_session_store
Chris@909: 
Chris@909: 5. Create the database structure
Chris@909:    
Chris@909:    Under the application main directory run:
Chris@909:      rake db:migrate RAILS_ENV="production"
Chris@909:    
Chris@909:    It will create all the tables and an administrator account.
Chris@909: 
Chris@909: 6. Setting up permissions (Windows users have to skip this section)
Chris@909:    
Chris@909:    The user who runs Redmine must have write permission on the following
Chris@909:    subdirectories: files, log, tmp & public/plugin_assets (create the last
Chris@909:    two if they are not yet present).
Chris@909:    
Chris@909:    Assuming you run Redmine with a user named "redmine":
Chris@909:      mkdir tmp public/plugin_assets
Chris@909:      sudo chown -R redmine:redmine files log tmp public/plugin_assets
Chris@909:      sudo chmod -R 755 files log tmp public/plugin_assets
Chris@909: 
Chris@909: 7. Test the installation by running the WEBrick web server
Chris@909:    
Chris@909:    Under the main application directory run:
Chris@909:      ruby script/server -e production
Chris@909:    
Chris@909:    Once WEBrick has started, point your browser to http://localhost:3000/
Chris@909:    You should now see the application welcome page.
Chris@909: 
Chris@909: 8. Use the default administrator account to log in:
Chris@909:    login: admin
Chris@909:    password: admin
Chris@909:    
Chris@909:    Go to "Administration" to load the default configuration data (roles,
Chris@909:    trackers, statuses, workflow) and to adjust the application settings
Chris@909: 
Chris@909: == SMTP server Configuration
Chris@909: 
Chris@909: Copy config/configuration.yml.example to config/configuration.yml and
Chris@909: edit this file to adjust your SMTP settings.
Chris@909: Do not forget to restart the application after any change to this file.
Chris@909: 
Chris@909: Please do not enter your SMTP settings in environment.rb.
Chris@909: 
Chris@909: == References
Chris@909: 
Chris@909: * http://www.redmine.org/wiki/redmine/RedmineInstall
Chris@909: * http://www.redmine.org/wiki/redmine/EmailConfiguration
Chris@909: * http://www.redmine.org/wiki/redmine/RedmineSettings
Chris@909: * http://www.redmine.org/wiki/redmine/RedmineRepositories
Chris@909: * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
Chris@909: * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
Chris@909: * http://www.redmine.org/wiki/redmine/RedmineLDAP