Difference between revisions of "Redmine"

From ArchWiki
Jump to: navigation, search
(Redirected page to Redmine setup)
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
#REDIRECT [[Redmine setup]]
+
[[Category:Version Control System]]
 +
{{Article summary start}}
 +
{{Article summary text|This page gives guidelines for the installation and configuration of Redmine on Archlinux.}}
 +
{{Article summary heading|Related}}
 +
{{Article summary wiki|Ruby on Rails}}
 +
{{Article summary wiki|RVM}}
 +
{{Article summary wiki|MariaDB}}
 +
{{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.
 +
 
 +
==Prerequisites==
 +
 
 +
This document will guide you through the installation process of the Redmine software and all of it's prerequisites, including the optional ones. If desired however, you may install all softwares and it's prerequisites separately and simply refer to the relevant sections below.
 +
 
 +
===Ruby===
 +
 
 +
<table border="1">
 +
<tr>
 +
<th>Redmine version</th>
 +
<th>Supported Ruby versions</th>
 +
<th>Rails version used</th>
 +
<th>Supported RubyGems versions</th>
 +
</tr>
 +
<tr>
 +
<td rowspan="2">2.2.2</td>
 +
<td>ruby 1.8.7, 1.9.2, 1.9.3</td>
 +
<td rowspan="2">Rails 3.2.11</td>
 +
<td rowspan="2">RubyGems <= 1.8</td>
 +
</tr>
 +
<tr>
 +
<td>jruby-1.6.7</td>
 +
</tr>
 +
</table>
 +
 
 +
# pacman -Syu --needed sudo git wget curl checkinstall libxml2 libxslt mysql++ base-devel zlib icu redis openssh python2 python2-pygments python2-pip libyaml ruby subversion imagemagick postgresql-libs
 +
 
 +
===User accounts===
 +
Add {{ic|redmine2}} 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 {{ic|redmine2}} user in MySQL server.
 +
 
 +
# mysql -u root -p
 +
CREATE USER 'redmine2'@'%' IDENTIFIED BY  'MY_PASSWORD';
 +
GRANT USAGE ON *.* TO  'redmine2'@'%' IDENTIFIED BY  'MY_PASSWORD';
 +
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;
 +
 
 +
==Get lastest stable Redmine==
 +
 
 +
===Download===
 +
Checkout lastest from Redmine repository.
 +
# cd /home/redmine2
 +
# sudo -H -u redmine2 svn co http://svn.redmine.org/redmine/branches/2.2-stable redmine-2.2
 +
 
 +
===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|1= In order to install ruby bundle, you may be need add user redmine2 for /etc/sudoers }}
 +
 
 +
==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.
 +
 
 +
<pre>
 +
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:
 +
</pre>
 +
 
 +
====Minimal database.yml====
 +
For rapid reference. Remember to replace MY_PASSWORD for yours.
 +
 
 +
{{Note|1= Notice that adapter is mysql2 and not mysql.}}
 +
 
 +
<pre>
 +
production:
 +
  adapter: mysql2
 +
  database: redmine2_production
 +
  host: localhost
 +
  username: redmine2
 +
  password: MY_PASSWORD
 +
  encoding: utf8
 +
 
 +
development:
 +
  adapter: mysql2
 +
  database: redmine2_development
 +
  host: localhost
 +
  username: redmine2
 +
  password: MY_PASSWORD
 +
  encoding: utf8
 +
 
 +
test:
 +
  adapter: mysql2
 +
  database: redmine2_test
 +
  host: localhost
 +
  username: redmine2
 +
  password: MY_PASSWORD
 +
  encoding: utf8
 +
</pre>
 +
 
 +
===Permissions===
 +
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"
 +
 
 +
== Resources ==
 +
* [http://www.redmine.org/projects/redmine/wiki/RedmineInstall  Official install guide from Redmine Wiki]

Revision as of 12:46, 1 February 2013

Summary help replacing me
This page gives guidelines for the installation and configuration of Redmine on Archlinux.
Related
Ruby on Rails
RVM
MariaDB

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.

Prerequisites

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

Ruby

Redmine version Supported Ruby versions Rails version used Supported RubyGems versions
2.2.2 ruby 1.8.7, 1.9.2, 1.9.3 Rails 3.2.11 RubyGems <= 1.8
jruby-1.6.7
# pacman -Syu --needed sudo git wget curl checkinstall libxml2 libxslt mysql++ base-devel zlib icu redis openssh python2 python2-pygments python2-pip libyaml ruby subversion imagemagick postgresql-libs

User accounts

Add redmine2 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
CREATE USER 'redmine2'@'%' IDENTIFIED BY  'MY_PASSWORD';
GRANT USAGE ON *.* TO  'redmine2'@'%' IDENTIFIED BY  'MY_PASSWORD';
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;

Get lastest stable Redmine

Download

Checkout lastest from Redmine repository.

# cd /home/redmine2
# sudo -H -u redmine2 svn co http://svn.redmine.org/redmine/branches/2.2-stable redmine-2.2

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

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.

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:

Minimal database.yml

For rapid reference. Remember to replace MY_PASSWORD for yours.

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

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

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

Permissions

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"

Resources