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.
- 1 Prerequisites
- 2 Optional Prerequisites
- 3 Installation
- 4 Troubleshooting
- 5 Configure Redmine
- 6 Test server
- 7 Start redmine on boot
- 8 Resources
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).
|Redmine version||Supported Ruby versions||Rails version used||Supported RubyGems versions|
|2.3.0||ruby 1.8.7, 1.9.2, 1.9.3, 2.0.0||Rails 3.2.13||RubyGems <= 1.8|
|jruby 1.6.7, 1.7.2|
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
MySQL 5.0 or higher
To install MySQL.simply refer to
PostgreSQL 8.2 or higher
To install Postgresql.PostgreSQL simply refer to
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";
Microsoft SQL Server.
Not supported for multi-user production use. So, it will not be detailed how to install and configure it for use with Redmine..
Phusion Passenger (recommended)
SCM (Source Code Management)
TODO: list all scm supported and how to install them...
TODO: to enable Gantt export to png image. link: http://www.imagemagick.org/
Ruby OpenID Library
TODO: to enable OpenID support (version 2 or greater is required). link: http://openidenabled.com/ruby-openid/
Build and Installation
Download the package AUR.AUR from the
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.
To create the database, the user and set privileges (MariaDB and MySQL >= 5.0.2):
create database redmine character set utf8; create user 'redmine'@'localhost' identified by 'my_password'; grant all privileges on redmine.* to 'redmine'@'localhost';
For versions of MariaDB and MySQL prior to 5.0.2:
create database redmine character set utf8; grant all privileges on redmine.* to 'redmine'@'localhost' identified by 'my_password';
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity'; CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
Although the database, login and user can be created within SQL Server Management Studio with a few clicks, you can always use the command line with
USE [master] GO -- Very basic DB creation CREATE DATABASE [REDMINE] GO -- Creation of a login with SQL Server login/password authentication and no password expiration policy CREATE LOGIN [REDMINE] WITH PASSWORD=N'redminepassword', DEFAULT_DATABASE=[REDMINE], CHECK_EXPIRATION=OFF, CHECK_POLICY=OFF GO -- User creation using previously created login authentication USE [REDMINE] GO CREATE USER [REDMINE] FOR LOGIN [REDMINE] GO -- User permissions set via roles EXEC sp_addrolemember N'db_datareader', N'REDMINE' GO EXEC sp_addrolemember N'db_datawriter', N'REDMINE' GO
Now you need to configure Redmine to access the database we just created. To do that you have to copy
# cd /usr/share/webapps/redmine/config # cp database.yml.example database.yml
And then edit this file in order to configure your database settings for "production" environment (you can configure for the "development" and "test" environments too, just change the appropriate sections).
Example for MariaDB and MySQL database:
production: adapter: mysql2 database: redmine host: localhost port: 3307 #If your server is not running on the standard port (3306), set it here, otherwise this line is unnecessary. username: redmine password: my_password
Example for PostgreSQL database:
production: adapter: postgresql database: redmine host: localhost username: redmine password: my_password encoding: utf8 schema_search_path: <database_schema> (default - public)
Example for a SQL Server database:
production: adapter: sqlserver database: redmine host: localhost #Set not default host (localhost) here, otherwise this line is unnecessary. port: 1433 #Set not standard port (1433) here, otherwise this line is unnecessary. username: redmine password: my_password
Adding Additional Gems (Optional)
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
# nano Gemfile.local
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), use this command instead:
# bundle install --without development test postgresql sqlite
Although it is highly recommend to enjoy all the features of Redmine, if you really does not want to use
rmagick gem using:
# bundle install --without rmagick
Session Store Secret Generation
Now you must generate a random key that will be used by Rails to encode cookies that stores session data thus preventing their tampering:
# rake generate_secret_token
Database Structure Creation
With the database created and the access configured for Redmine, now it's time to create the database structure. This is done by running the following command under the application root directory:
# cd /usr/share/webapps/redmine # RAILS_ENV=production rake db:migrate
These command will create tables by running all migrations one by one then create the set of the permissions and the application administrator account, named admin.
Database Population with Default Data
Now you may want to insert the default configuration data in database, like basic types of task, task states, groups, etc. To do so execute the following:
# RAILS_ENV=production rake redmine:load_default_data
Redmine will prompt for the data set language that should be loaded; you can also define the REDMINE_LANG environment variable before running the command to a value which will be automatically and silently picked up by the task:
# RAILS_ENV=production REDMINE_LANG=pt-BR rake redmine:load_default_data
File System Permissions
The user account running the application must have write permission on the following subdirectories:
files: storage of attachments. log: application log file production.log. tmp and tmp/pdf: used to generate PDF documents among other things (create these ones if not present).
Assuming you run the application with a the default Apache user
# mkdir tmp tmp/pdf public/plugin_assets # chown -R http:http files log tmp public/plugin_assets # chmod -R 755 files log tmp tmp/pdf public/plugin_assets
Test the installation
To test your new installation using WEBrick web server run the following in the Redmine folder:
# ruby script/rails server webrick -e production
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page. Use default administrator account to log in: admin/admin. You can go to Administration menu and choose Settings to modify most of the application settings.
redmine user and append redmine2 to git group.
# useradd --user-group --shell /bin/bash --comment 'redmine2 system' --create-home --groups git redmine2
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
For rapid reference.
default: email_delivery: delivery_method: :sendmail attachments_storage_path: autologin_cookie_name: autologin_cookie_path: autologin_cookie_secure: scm_subversion_command: scm_mercurial_command: scm_git_command: scm_cvs_command: scm_bazaar_command: scm_darcs_command: database_cipher_key: production: development:
# 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"