From ArchWiki
Revision as of 18:10, 11 March 2013 by Mawcomw (talk | contribs) (Database Configuration)
Jump to navigation Jump to search

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary end

Redmine is a free and open source, web-based project management and bug-tracking tool. It includes a calendar and Gantt charts to aid visual representation of projects and their deadlines. It handles multiple projects. Redmine provides integrated project management features, issue tracking, and support for various version control systems.

Redmine is written using the Ruby on Rails framework. It is cross-platform and cross-database.


This document will guide you through the installation process of the Redmine and all of its prerequisites, including the optional ones. If desired, however, you may install Redmine and it's prerequisites separately, simply refering to the relevant sections below.

Although this guide will go through all the installation process, this isn't a one way path. So Redmine can use different versions of the other softwares (mariaDB, mySQL, postgreSQL, etc, as your database).

Note: At this time is important to note that this guide is an default suggestion, feel free to use other of the prerequisites mentioned on this wiki.


Redmine version Supported Ruby versions Rails version used Supported RubyGems versions
2.2.3 ruby 1.8.7, 1.9.2, 1.9.3 Rails 3.2.12 RubyGems <= 1.8

There are two simple ways to install Ruby: installing the ruby package as described in ruby or installing RVM as described in RVM (recommended).

Note: If you use RVM, pay attention to the single and multiple user differences! If you are not creating a hosting service, the multiple user (available for all users on the machine) should be the choice for simpler debuging.


MariaDB 5.0 or higher (recommended)

MariaDB is a drop-in replacement for MySQL, in fact it was a fork of it and maintain binarie compatibility.

To install mariadb simply refer to MariaDB.

And make sure to install the C bindings for Ruby that dramatically improve performance. You can get them by running:

# gem install mysql2

MySQL 5.0 or higher

To install mysql simply refer to MySQL.

And make sure to install the C bindings for Ruby that dramatically improve performance. You can get them by running:

# gem install mysql2

PostgreSQL 8.2 or higher

To install postgresql PostgreSQL simply refer to Postgresql.

Make sure your database datestyle is set to ISO (Postgresql default setting). You can set it using:

ALTER DATABASE "redmine_db" SET datestyle="ISO,MDY";
Note: Some bugs in PostgreSQL 8.4.0 and 8.4.1 affect Redmine behavior ([#4259], [#4314]), they are fixed in PostgreSQL 8.4.2

Microsoft SQL Server

Support is planned for 2.3.0 release (but is already available on trunk for early adopters).

SQLite 3

Not supported for multi-user production use. So, it will not be detailed how to install and configure it for use with Redmine.

Web Server

Phusion Passenger (recommended)








Apache Tomcat


Optional Prerequisites

SCM (Source Code Management)

TODO: list all scm supported and how to install them...


TODO: to enable Gantt export to png image. link:

Ruby OpenID Library

TODO: to enable OpenID support (version 2 or greater is required). link:


Build and Installation

Download the package redmineAUR from the AUR.

Note: It's HIGHLY recommended to read all the AUR page to understand what are you doing. Although nothing dangerous are being done, it doesn't hurt to read this.

Build the package as follow (more detailed build instructions at Arch User Repository#Build the package).

Enter the folder that you are using to build packages, unpack the file and enter the package folder:

$ cd ~/builds
$ tar -zxvf redmine-2.2.3.tar.gz
$ cd redmine-2.2.3

Inspect the PKGBUILD file, to certify that is everything ok:


And then, build the package:

$ makepkg -s
Warning: Never run the above command using the root user!

Then install the built package using pacman:

# pacman -U redmine-2.2.3-1-any.pkg.tar.xz

Gems Installation

Note: If you prefer, you can install all the gems as pacman packages. You have only to search for the gem package and install them as usual. As of using Ruby gem is simpler to mange and maintain up to date gems, this will be preferable and used as default bellow.

Redmine uses Bundler to manage gems dependencies. So, you need to install Bundler first:

# gem install bundler

Then you can install all the gems required by Redmine using the following command:

# cd /usr/share/webapps/redmine
# bundle install

To install without the ruby development and test environments use this instead of the last command:

# bundle install --without development test

To install only the gem of the database you are using (example, only using mariadb), use this command instead:

# bundle install --without development test postgresql sqlite
Note: You can include/exclude environments and databases using the above syntax.

Although it is highly recommend to enjoy all the features of Redmine, if you really does not want to use ImageMagick, you should skip the installation of the rmagick gem using:

# bundle install --without rmagick

Additional Gems

If you need to load gems that are not required by Redmine core (eg. Puma, fcgi), create a file named Gemfile.local at the root of your redmine directory. It will be loaded automatically when running bundle install:

# nano Gemfile.local
gem 'puma'

Database Configuration

Now, we will need to create the database that the Redmine will use to store your data. For now on, the database and its user will be named redmine. But this names can be changed to anything else.


User accounts

Add redmine user and append redmine2 to git group.

# useradd --user-group --shell /bin/bash --comment 'redmine2 system' --create-home --groups git redmine2

MySQL user and databases

Create redmine2 user in MySQL server.

# mysql -u root -p
GRANT ALL PRIVILEGES ON  `redmine2\_%`.* TO 'redmine2'@'%';
create database redmine2 character set utf8;
create database redmine2_production character set utf8;
create database redmine2_development character set utf8;
create database redmine2_test character set utf8;

Install gems

This could take a while as it installs all required libraries.

# sudo -u redmine2 -H sh -c 'echo "export PATH=$(ruby -rubygems -e "puts Gem.user_dir")/bin:$PATH" >> /home/redmine2/.bash_profile'
# sudo -u redmine2 -H gem install bundler
# cd /home/redmine2/redmine-2.2
# source /home/redmine2/.bash_profile
# sudo -u redmine2 -H bundle install 
Note: In order to install ruby bundle, you may be need add user redmine2 for /etc/sudoers. Another option is to first do export GEM_HOME=/home/redmine2/.gem/.

Configure Redmine

Application Settings

Copy default configuration and adjust settings for your needs.

# cd /home/redmine2/redmine-2.2/config
# sudo -u redmine2 cp configuration.yml.example configuration.yml
# sudo -u redmine2 cp database.yml.example database.yml

Minimal configuration.yml

For rapid reference.

    delivery_method: :sendmail







Minimal database.yml

For rapid reference. Remember to replace MY_PASSWORD for yours.

Note: Notice that adapter is mysql2 and not mysql.
  adapter: mysql2
  database: redmine2_production
  host: localhost
  username: redmine2
  password: MY_PASSWORD
  encoding: utf8

  adapter: mysql2
  database: redmine2_development
  host: localhost
  username: redmine2
  password: MY_PASSWORD
  encoding: utf8

  adapter: mysql2
  database: redmine2_test
  host: localhost
  username: redmine2
  password: MY_PASSWORD
  encoding: utf8


Set permissions for redmine directories.

# cd /home/redmine2/redmine-2.2
# mkdir -pv tmp tmp/pdf public/plugin/assets
# sudo chown -R redmine2:redmine2 files log tmp public/plugin/assets
# sudo chmod -R 755 files log tmp public/plugin/assets

Generate secret token

Generate new unique secret token

# sudo -u redmine2 rake generate_secret_token

Migrate/install database

Create/update database schemas

# sudo -u redmine2 RAILS_ENV=production rake db:migrate

Populate database with default data.

# sudo -u redmine2 RAILS_ENV=production rake redmine:load_default_data

Test server

Ruby on Rails embedded server

Using Ruby on Rails embedded server

# ruby script/rails server webrick -e production

Test it http://localhost:3000 Use login=admin and password=admin

Unicorn server

# sudo -u redmine2 unicorn -D -E production -c config/unicorn.rb

Start redmine on boot

Append follow command at end of your /etc/rc.local

# sudo -u redmine2 bash -c "source /home/redmine2/.bash_profile && cd /home/redmine2/redmine-2.2 && unicorn -D -E production -c config/unicorn.rb"