Chris@0: == Redmine installation
Chris@0: 
Chris@0: Redmine - project management software
Chris@1115: Copyright (C) 2006-2012  Jean-Philippe Lang
Chris@0: http://www.redmine.org/
Chris@0: 
Chris@0: 
Chris@0: == Requirements
Chris@0: 
Chris@1115: * Ruby 1.8.7, 1.9.2 or 1.9.3
Chris@1115: * RubyGems
Chris@1115: * Bundler >= 1.0.21
Chris@0: 
Chris@0: * A database:
Chris@441:   * MySQL (tested with MySQL 5.1)
Chris@1115:   * PostgreSQL (tested with PostgreSQL 9.1)
Chris@441:   * SQLite3 (tested with SQLite 3.6)
Chris@0: 
Chris@0: Optional:
Chris@1115: * SCM binaries (e.g. svn, git...), for repository browsing (must be available in PATH)
Chris@1115: * ImageMagick (to enable Gantt export to png images)
Chris@0: 
Chris@0: == Installation
Chris@0: 
Chris@0: 1. Uncompress the program archive
Chris@0: 
Chris@1115: 2. Install the required gems by running:
Chris@1115:      bundle install --without development test
Chris@0: 
Chris@1115:    If ImageMagick is not installed on your system, you should skip the installation
Chris@1115:    of the rmagick gem using:
Chris@1115:      bundle install --without development test rmagick
Chris@0: 
Chris@1115:    If you need to load some gems that are not required by Redmine core (eg. fcgi),
Chris@1115:    you can create a file named Gemfile.local at the root of your redmine directory.
Chris@1115:    It will be loaded automatically when running `bundle install`.
Chris@1115: 
Chris@1115: 3. Create an empty utf8 encoded database: "redmine" for example
Chris@1115: 
Chris@1115: 4. Configure the database parameters in config/database.yml
Chris@1115:    for the "production" environment (default database is MySQL and ruby1.8)
Chris@1115: 
Chris@1115:    If you're running Redmine with MySQL and ruby1.9, replace the adapter name
Chris@1115:    with `mysql2`
Chris@1115: 
Chris@1115: 5. Generate a session store secret
Chris@0:    
Chris@0:    Redmine stores session data in cookies by default, which requires
Chris@0:    a secret to be generated. Under the application main directory run:
Chris@1115:      rake generate_secret_token
Chris@0: 
Chris@1115: 6. Create the database structure
Chris@0:    
Chris@0:    Under the application main directory run:
Chris@0:      rake db:migrate RAILS_ENV="production"
Chris@0:    
Chris@0:    It will create all the tables and an administrator account.
Chris@0: 
Chris@1115: 7. Setting up permissions (Windows users have to skip this section)
Chris@0:    
Chris@0:    The user who runs Redmine must have write permission on the following
Chris@1115:    subdirectories: files, log, tmp & public/plugin_assets.
Chris@0:    
Chris@0:    Assuming you run Redmine with a user named "redmine":
Chris@0:      sudo chown -R redmine:redmine files log tmp public/plugin_assets
Chris@0:      sudo chmod -R 755 files log tmp public/plugin_assets
Chris@0: 
Chris@1115: 8. Test the installation by running the WEBrick web server
Chris@0:    
Chris@0:    Under the main application directory run:
Chris@1115:      ruby script/rails server -e production
Chris@0:    
Chris@0:    Once WEBrick has started, point your browser to http://localhost:3000/
Chris@0:    You should now see the application welcome page.
Chris@0: 
Chris@1115: 9. Use the default administrator account to log in:
Chris@0:    login: admin
Chris@0:    password: admin
Chris@0:    
Chris@0:    Go to "Administration" to load the default configuration data (roles,
Chris@0:    trackers, statuses, workflow) and to adjust the application settings
Chris@0: 
Chris@0: == SMTP server Configuration
Chris@0: 
Chris@210: Copy config/configuration.yml.example to config/configuration.yml and
Chris@210: edit this file to adjust your SMTP settings.
Chris@0: Do not forget to restart the application after any change to this file.
Chris@0: 
Chris@0: Please do not enter your SMTP settings in environment.rb.
Chris@0: 
Chris@0: == References
Chris@0: 
Chris@0: * http://www.redmine.org/wiki/redmine/RedmineInstall
Chris@0: * http://www.redmine.org/wiki/redmine/EmailConfiguration
Chris@0: * http://www.redmine.org/wiki/redmine/RedmineSettings
Chris@0: * http://www.redmine.org/wiki/redmine/RedmineRepositories
Chris@0: * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
Chris@0: * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
Chris@0: * http://www.redmine.org/wiki/redmine/RedmineLDAP