Installing Redmine¶

• Table of contents
• Installing Redmine
  • Requirements
  • Installation
  • SMTP server Configuration
  • Backups

Requirements¶

• Ruby on Rails:
  • Redmine 0.7.x requires Rails 2.0.2
  • Redmine devel r1623 and above is compatible with Rails 2.1

• A database:
  • MySQL 4 or higher (recommended)
  • PostgreSQL 8
  • SQLite 3 (please read this: http://weblog.rubyonrails.org/2007/1/29/using-sqlite3-with-rails)

Optional:

• SVN binaries (>= 1.3), for repository browsing (must be available in your PATH)
• RMagick (Gantt export to a png image)

Note that Rails has some compatibility issues with ruby 1.8.7. The recommended ruby version is 1.8.6.

Installation¶

1. Download and extract the archive or checkout Redmine.

2. Create an empty database named redmine for example.

For MySQL:

create database redmine character set utf8;

3. Copy config/database.yml.example to config/database.yml and edit this file in order to configure your database settings for "production" environment.

Example for a MySQL database:

production:
  adapter: mysql
  database: redmine
  host: localhost
  username: bduser
  password: bdpasswd

4. Create the database structure, by running the following command under the application root directory:

rake db:migrate RAILS_ENV="production"

It will create tables and an administrator account.

5. Insert default configuration data in database, by running the following command:

rake redmine:load_default_data RAILS_ENV="production"

This step is optional but highly recommended, as you can define your own configuration from scratch. It will load default roles, trackers, statuses, workflows and enumerations.

6. Setting up permissions

NB: Windows users have to skip this section.

The user who runs Redmine must have write permission on the following subdirectories: files, log, tmp (create the last one if not present).

Assuming you run Redmine with a redmine user:

mkdir tmp
sudo chown -R redmine:redmine files log tmp
sudo chmod -R 755 files log tmp

7. Test the installation by running WEBrick web server:

ruby script/server -e production

Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.

8. Use default administrator account to log in:

• login: admin
• password: admin

You can go to Admin & Settings to modify application settings.

SMTP server Configuration¶

In config/environment.rb, you can set parameters for your SMTP server:

• config.action_mailer.smtp_settings: SMTP server configuration
• config.action_mailer.perform_deliveries: set to false to disable mail delivering

Don't forget to restart the application after any change.

Backups¶

Redmine backups should include:

• data (stored in your redmine database)
• attachments (stored in the files directory of your Redmine install)

Here is a simple shell script that can be used for daily backups (assuming you're using a mysql database):

# Database
/usr/bin/mysqldump -u <username> -p <password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz

# Attachments
rsync -a /path/to/redmine/files /path/to/backup/files