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