Redmine

h1. Step-by-step for Ubuntu 12.04  or Ubuntu 10.04 using Passenger

[[HowTo_Install_Redmine_on_Ubuntu_step_by_step|A step-by-step guide]] to getting Redmine running on a fresh installation of Ubuntu.

h2. Assumptions In This Document 

These instructions assume that you have a basic Ubuntu server installation with command line access.  they assume that you have the rights to install a web server (Apache2) and a database (PostgreSQL or MySQL).  They also assume that you have the ability to carry out sudo commands and that you have at least a passing familiarity with the linux OS and file system.  Lines you should type in will be on their own line and will be preceded by a vertical grey bar.

h2. Become root or be prepared to type sudo before every command.  

You can also save yourself a lot of time if you are doing a big install/configuration job by simply becoming 'real root' instead of typing sudo before everything by typing in either of these commands;

>sudo -s

 - OR - 

>sudo -i

Both will ask you to supply your password again and then you will get a # prompt which shows that you are "root" and no longer have to keep typing sudo. 

h2. Be sure to run your updates before you start.  

Be sure to check your /etc/apt/sources.list  You will probably want to comment out the "backports" and uncomment the extras and partners.  

>apt-get update

If you get any key errors for any of the repositories, you can fix them easily.  

A key error will look something like this:

W: GPG error: http://extras.ubuntu.com quantal Release: The following signatures couldn't be verified because the public key is not available: NO_PUBKEY 16126D3A3E5C1192

>gpg --keyserver hkp://subkeys.pgp.net --recv-keys 16126D3A3E5C1192

>gpg --export --armor 16126D3A3E5C1192 | sudo apt-key add - 

Note that the key (16126D3A3E5C1192) is the same in the error message, the key fetch request and the key import request.  What ever key you are missing can be fixed by through this process.  

>apt-get update && apt-get dist-upgrade

h2. Have your web server and data base installed

Installing Ubuntu's entire LAMP stack also installs PHP as well as the PHP connectors for apache, mysql, etc. If you are using RoR, installing all of that is probably unnecessary.  As a general rule of practice, it is best not to install anything you don't actually need.  That which isn't installed is not a potential security hole.  The statements below will install apache2 and the proper database.  

For MySQL: >apt-get install apache2 software-properties-common mysql-server mysql-client mysql-common 

For PostgreSQL:   >apt-get install apache2 software-properties-common postgresql

If you want to use another web server or data base, that is outside the scope of this document.

h2. You must install mod_passenger for Apache2. 

> apt-get install libapache2-mod-passenger

Wait for the install to complete then you must enable the module and restart Apache2.

>a2enmod passenger

>service apache2 restart

 - OR -

>/etc/init.d/apache2 restart

Mod_passenger should now be enabled and visible to apache.

h2.Turn off apparmor for a bit so that it doesn't complain while we're installing everything

> service apparmor stop

 - OR -

>/etc/init.d/apparmor stop

You can restart it once everything has been configured.

h2. Create your data base and your user for your redmine installation.

There are a great many GUI's out there for most databases.  It is strongly recommended never to run your application as your "root" user on your database (e.g. MySQL root for MySQL or 'postgres' user for PostgreSQL).  There are also any number of tutorials on the creation of databases and granting of rights on them, so that it is really outside the scope of this document. These are pretty trivial to find on Google and if you are going to administer database driven applications its very advisable for you to become at least passingly familiar with SQL statements.

For MySQL:  CREATE 'user'@'hostname' IDENTIFIED BY 'password';  CREATE DATABASE 'myredminedb'; GRANT ALL ON 'myredminedb'.* TO 'user'@'hostname'; FLUSH PRIVILEGES;

For PostgreSQL: CREATE USER user WITH PASSWORD 'password'; CREATE DATABASE myredminedb;GRANT ALL PRIVILEGES ON DATABASE myredminedb to user;

NOTE for PostgreSQL Users:  You will have to set the postgres user password before you can connect remotely.  MySQL will force you to set this during the installation but Postgres does not. To so do:

>su - postgres

>psql

This will take you to the postgres database prompt.  

>ALTER USER postgres with password 'my-secure-password';

This will set the password.  You can now proceed to editing the postgres configuration files so that you can connect remotely.

h2. Install Redmine.

---If you are happy with the packaged version, the you can use the packages from the Ubuntu repository.   The Ubuntu 10.04 package is stuck in the 0.9.x branch and the Ubuntu 12.04 package is stuck in the 1.3.x branch.

For MySQL: >apt-get install redmine redmine-mysql

For PostgreSQL: >apt-get install redmine redmine-pgsql

For SQLite: 

The PostgreSQL installation will ask for the postgres user password so that it can create its own user, password, database, etc.  

The installation process should prompt you for all the interesting details.

Redmine will now be installed in @/usr/share/redmine@ and the configuration files will be located in @/etc/redmine@

h2. Installing the latest Redmine

The package with Ubuntu 10.04 is stuck in the 0.9.x branch and Ubuntu 12.04 is stuck in the 1.3.x branch. A PPA exists that has the latest branch here: https://launchpad.net/~ondrej/+archive/redmine

To install redmine using the PPA:

> $ sudo add-apt-repository ppa:ondrej/redmine

> $ sudo apt-get update

> $ sudo apt-get install redmine redmine-mysql

Note: If your server is behind a firewall, you will need to export your firewall settings before running @add-apt-repository@. Otherwise, the command will hang.

Run the following <pre>export http_proxy="http://proxy.your.server:port" and export https_proxy="http:proxy.your.server:port".</pre>

h2. Configuration

Symlink @/usr/share/redmine/public@ to your desired web-accessible location. E.g.:

> $ sudo ln -s /usr/share/redmine/public /var/www/redmine

By default, passenger runs as 'nobody', so you'll need to fix that. In @/etc/apache2/mods-available/passenger.conf@, add:

<pre>PassengerDefaultUser www-data</pre>

You'll also need to configure the @/var/www/redmine@ location in @/etc/apache2/sites-available/default@ by adding:

<pre><Directory /var/www/redmine>

RailsBaseURI /redmine

PassengerResolveSymlinksInDocumentRoot on

</Directory>

</pre>

If you set your AppArmor mysqld profile to complain you ought to set it back to enforce:

> $ sudo aa-enforce /usr/sbin/mysqld

Enable passenger:

> $ sudo a2enmod passenger

Restart apache2

> $ sudo service apache2 restart

and you should be able to access Redmine at: http://redmine.server.ip.address/redmine

If you receive a "403: Forbidden" error after setting up Redmine, the Redmine 'public' folder may have incorrect permissions set. The executable bit on the public folder must be enabled or you will receive a "403: Forbidden" error when attempting to access Redmine.

> $ sudo chmod a+x /usr/share/redmine/public

h1. Ubuntu 10.04 or 12.04 using WEBrick

Using Passenger is recommended for the heavy load server. But WEBrick uses less memory.

Install Redmine: (See also _Installing the latest Redmine_ above)

> $ sudo apt-get install redmine redmine-mysql

Then, create this for /etc/init/redmine.conf

<pre>

# Redmine

description "Redmine"

start on runlevel [2345]

stop on runlevel [!2345]

expect daemon

exec ruby /usr/share/redmine/script/server webrick -e production -b 0.0.0.0 -d

</pre>

You can start Redmine by this. You can access by http://example.com:3000/

> $ sudo service redmine start

You can stop by this.

> $ sudo service redmine stop

h1. Ubuntu 10.04 using mod_cgi

The installation assumes that the web server and database are already in place, so you probably want to install the LAMP stack first if you don't already have it:

> $ sudo tasksel install lamp-server

Also, the default AppArmor configuration can get in the way, so you may need to set the mysqld profile to complain:

> $ sudo aa-complain /usr/sbin/mysqld

As of 10.04, Redmine is available through Ubuntu's package manager, and installation is simple:

> $ sudo apt-get install redmine redmine-mysql subversion

The second package, _redmine-mysql_, can be replaced by either _redmine-pgsql_ or _redmine-sqlite_ if you want to use either of those databases.

The installation process should prompt you for all the interesting details.

Redmine will now be installed in @/usr/share/redmine@ and @/etc/redmine@

If you set your AppArmor mysqld profile to complain you ought to set it back to enforce:

> $ sudo aa-enforce /usr/sbin/mysqld

h2. Configuration

> *Using Ubuntu Server 10.04.1, configuring Redmine via mod_cgi as described in this section does not seem to work. If you can successfully make this work, please update these instructions! Otherwise follow the instructions in the next section for installing on Ubuntu 10.04 using Passenger or WEBrick if mod_cgi does not work for you.*

Symlink @/usr/share/redmine/public@ to your desired web-accessible location. E.g.:

> $ sudo ln -s /usr/share/redmine/public /var/www/redmine

Also symlink @/var/cache/redmine/default/plugin_assets@ to your redmine directory. E.g.:

> $ sudo ln -s /var/cache/redmine/default/plugin_assets /usr/share/redmine/public/

This will ensure that any graphics or other resources are displayed in any installed add-ons.

The other files that you need to modify/create are as follows:

@/etc/redmine/default/database.yml@:

<pre>

production:

adapter: mysql

database: redmine

host: localhost

username: redmine

password: pa55w0rd

encoding: utf8

</pre>

@/usr/share/redmine/public/dispatch.cgi@:

<pre>

#!/usr/bin/ruby

require File.dirname(__FILE__) + "/../config/environment" unless defined?(RAILS_ROOT)

require "dispatcher"

ADDITIONAL_LOAD_PATHS.reverse.each { |dir| $:.unshift(dir) if File.directory?(dir) } if defined?(Apache::RubyRun)

Dispatcher.dispatch

</pre>

@/usr/share/redmine/public/.htaccess@:

<pre>

RewriteEngine On

RewriteBase /redmine

RewriteRule ^$ index.html [QSA]

RewriteRule ^([^.]+)$ $1.html [QSA]

RewriteCond %{REQUEST_FILENAME} !-f

RewriteRule ^(.*)$ dispatch.cgi [QSA,L]

</pre>

And that's it! If these instructions didn't work for you, please expand them to include whatever is needed.

h1. Redmine Installation on Virtual or Normal Ubuntu < 10.04

This page is a guide to installing Redmine on either a virtual or actual installation of the Ubuntu operating system. If you follow all instructions correctly you will have installed your Redmine server successfully in almost an hour.

h2. Step 1: Install Ubuntu

If you are installing on a non-virtual Ubuntu instance, please skip this section.

*Installing VirtualBox:*

1.Download the latest version of Sun VirtualBox (version 3.0.10 or newer).

2.Install VirtualBox by following the instructions.

*Installing Ubuntu on VirtualBox:*

1.Download the latest version of Ubuntu (version 9.10 or newer).

2.After installing VirtualBox you will create a new virtual operating which will be Linux type and Ubuntu subtype. If you don't know anything about VirtualBox and/or its usage please refer to Google.

3.While installing Ubuntu you should enter the following configuration:

(This suggested configuration is optional, you can enter any names you want.)

Q: What is your name? A: Redmine Server

Q: What name do you want to use to login? A: redmine

Q: Choose to password to keep your account safe? A: redmine

Q: What is the name of this computer? A: redmine-server

Choose “Log in automatically.” radio button.

4.When you've finished the installation, open up your new VirtualBox Ubuntu OS and open up a terminal (console) screen and issue these commands:

> sudo apt-get update

> sudo apt-get upgrade

*Configuring VirtualBox:*

1.If you want to reach your VirtualBox Ubuntu OS from a different machine, you have to configure VirtualBox Ubuntu OS's network settings to Bridged Adapter. So you can reach your VirtualBox Ubuntu from an internal IP address easily. Because it get's the same IP block as you from DHCP easily. I mean your guest and host computer is same IP block as different network client.

2.If you had assigned a static IP to your Network Consult by giving your static ethernet MAC address, you have to assign the unique MAC address your VirtualBox Ubuntu OS by Setting->Network->MAC address initialization box. By this MAC address, you can get a static IP easily or you can configure your Ubuntu system to not use DHCP, instead of that you can assign a static IP manually.

h2. Step 2: Install Redmine

Once you have a functioning Ubuntu operating system up and running, you can continue with installing Redmine.

h3. Install dependencies

The following packages are required to install and run Redmine. Please install them by running @apt-get@ as root:

>sudo apt-get install package-name

where @package-name@ is each of:

* apache2

* apache2-threaded-dev

* build-essential

* libapache-dbi-perl

* libapache2-mod-perl2

* libapache2-svn

* libdigest-sha1-perl

* libgemplugin-ruby

* libgemplugin-ruby1.8

* libruby-extras

* libruby1.8-extras

* mongrel

* mysql-server

* rails

* rake

* ruby

* rubygems

* rubygems1.8

* ruby1.8-dev

* subversion

_(Could someone please clean up this list?)_

h3. Package Installation and Setup

1.Once you’ve installed the VirtualBox Ubuntu OS and updated it, you need to install a bunch of packages that we will prepare the server for the Redmine installation. So, as root, install the following packages by issuing:

> sudo apt-get install

> sudo apt-get install

(_Surely some missing package names above?_)

The packages we’re installing above are MySQL, phpMyAdmin, Rails, Ruby Gems, Mongrel and Ruby Dev environment.

During the installation of the packages, when MySQL is installed, it will prompt you to create a password. Make sure you remember it. You will need it later to log in to phpMyAdmin. To make things simple you can set all passwords to “redmine”.

2.Create a new directory for Redmine. I put mine in /opt/redmine. And download the latest version of Redmine in to it with the wget command line downloader and extract it by issuing:

> sudo mkdir /opt/redmine

> sudo cd /opt/redmine

> sudo wget http://rubyforge.org/frs/download.php/66633/redmine-0.8.6.tar.gz

> tar -xvf redmine-0.8.6.tar.gz

h3. Database Setup

1.Now it’s time to create an empty database for Redmine. As you may have noticed, we installed phpMyAdmin earlier. phpMyAdmin will come in handy now. Head over to http://localhost/phpmyadmin. You should be presented with the phpMyAdmin login screen.

Type in “root” and the MySQL “password” you created when installing MySQL.

2.First, click on “Databases” then, at the bottom of the screen, in the “Create new database” text box create a new database called “redmine” and set “Collation” to “utf8_general_ci”.

3.Now, go back to the home screen and click on:

“Privileges”

“Add a new User”

Fill out the “Login Information” boxes. Call your user “redmine”. Make sure you remember password you create here. It will be used when you set up the database connection details in Redmine.

In the “Database for user” section, check “Create database with same name and grant all privileges” and click on the “Go” button.

4.Log out of phpMyAdmin.

h3. Redmine Database Connection Configuration

1.It’s time to configure the database connection. If you installed Redmine as I did above, then copy “config/database.yml.example” to “config/database.yml” and edit this file in order to configure your database settings for “production” environment. You’ll find the “database.yml.example” issuing:

> sudo cd /opt/redmine/redmine-0.8.6/config

2.So now, assuming you’re in the “/opt/redmine/redmine-0.8.6/config” directory, issue:

> sudo cp database.yml.example database.yml

3.Then, open the “database.yml” file, issue:

> sudo gedit database.yml

… and edit it as in the example for a MySQL database below:

production:

adapter: mysql

socket: /var/run/mysqld/mysqld.sock

database: redmine

host: localhost

username: redmine

password: [password]

Then save the “database.yml” file and exit to the command prompt.

On Ubuntu the “mysql.sock” is located in /var/run/mysqld/mysqld.sock, as noted in the “config” above.

(The standard Redmine installation assumes the socket is located in “/opt/redmine/redmine-0.8.6/tmp/mysqld.sock”.)

4.Create the database structure, by running the following command under the application root directory (I mean “/opt/redmine/redmine-0.8.6”):

> sudo rake db:migrate RAILS_ENV="production"

It will create the necessary tables in the redmine database you created earlier and an administrator account.

5.Insert the default configuration data in to the database, by issuing:

> sudo 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, work flows and enumerations. While loading default data command prompt wants to given language selection by you.)

h3. Setting up Permissions

1.The user who runs Redmine must have write permission on the following sub directories: “files”, “log”, “tmp” (create the last one if not present). You probably already have a “tmp” directory in /opt/redmine/redmine-0.8.6, but if you don’t, create one now by issuing:

> sudo mkdir /opt/redmine/redmine-0.8.6

2.If you haven’t created a Redmine user, do it now by issuing:

> sudo useradd redmine

3.Now, assuming you run Redmine with a redmine user, from your /opt/redmine/redmine-0.8.6 directory issue:

> sudo chown -R redmine:redmine files log tmp

> sudo chmod -R 755 files log tmp

h3. Testing the Installation

1.It should all be working now. Test the installation by running the WEBrick web server issue:

> sudo cd /opt/redmine/redmine-0.8.6

> sudo ruby script/server -e production

Once WEBrick has started, point your browser to http://localhost:3000/. Or, if you are using a browser on a computer other than the one you installed Redmine on, point your browser to http://192.168.1.10:3000/ (if that’s the IP address you gave your Redmine server). You should now see the application welcome page.

*Log in:*

1.Use default administrator account to log in:

Login : admin

Password : admin

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

h3. Setting Up Static IP

1.An easier method for configuring a static IP address is to use your local DHCP server to assign a permanent IP to the VirtualBox OS mac address. That way you will not have to do anything inside VBS. Consult your network administrator.

2.Or you should determine the configuration parameters given below, and then you can configure your system to have a static IP address:

The desired IP address

Network mask and broadcast address

Gateway address

Your local DNS server address(es)

h3. Assigning Host Name and Domain for VirtualBox OS

1.An easier method for adding your IP address - Host name pair configuration to your DNS server . Consult your network administrator.

h2. Configuring the Passenger Apache module

Passenger is a module for apache2 that allows Apache to run Ruby on Rails applications. Install it thus:

>$ sudo gem install passenger

Then go to the passenger apache2 module installation directory and run @passenger-install-apache2-module@

> $ cd /var/lib/gems/1.X/gems/passenger-X.X.X/

> $ sudo bin/passenger-install-apache2-module

Next, configure Apache:

In /etc/apache2/mods-available/passenger.load we will add next line

> LoadModule passenger_module /var/lib/gems/1.X/gems/passenger-X.X.X/ext/apache2/mod_passenger.so

We have to edit the conf of the passenger apache2 module in /etc/apache2/mods-available/passenger.conf

> PassengerRoot /var/lib/gems/1.X/gems/passenger-X.X.X

> PassengerRuby /usr/bin/ruby1.X

And now we activate the module

> $ sudo a2enmod passenger

Apache virtualhost for redmine web app

<pre>

<VirtualHost *:80>

ServerName redmine.server.com

DocumentRoot /var/www/redmine/public

ServerAdmin user@server.com

LogLevel warn

ErrorLog /var/log/apache2/redmine_error

CustomLog /var/log/apache2/redmine_access combined

<Directory /var/www/redmine/public>

Options Indexes FollowSymLinks MultiViews

AllowOverride None

Order allow,deny

allow from all

</Directory>

</VirtualHost>

</pre>

subversion server config in apache

<pre>

<VirtualHost *:80>

ServerName svn.server.com

ServerAdmin user@server.com

ErrorLog /var/log/apache2/svn_error

CustomLog /var/log/apache2/svn_access combined

<Location /project>

DAV svn

SVNPath /var/lib/svn/project

AuthType Basic

AuthName "Trac system for Server projects"

AuthUserFile "/var/lib/svn/.htpasswd"

Require valid-user

<LimitExcept GET PROPFIND OPTIONS REPORT>

Require valid-user

</LimitExcept>

</Location>

</Virtualhost>

</pre>

h2. Sendmail Server Configuration

1.Before configuring email support for Redmine, we should download the sendmail application for Ubuntu, issue:

> sudo apt-get install sendmail

> sudo sendmailconfig

(Answer Yes to all questions which you will be asked)

2.It’s time to configure the server connection. Copy “config/email.yml.example” to “config/email.yml” and edit this file in order to configure your database settings for “production” environment. You’ll find the “email.yml.example” issue:

> sudo cd /opt/redmine/redmine-0.8.6/config

3.So now, assuming you’re in the “/config” directory, issue:

> sudo cp email.yml.example email.yml

4.Then, open the “email.yml” file, issue:

> sudo gedit email.yml

… and edit it as in the example for sendmail configuration below:

production:

delivery_method: :sendmail

sendmail_settings:

location: /usr/sbin/sendmail

arguments: -i -t

address: smtp.example.net

port: 25

domain: example.net

authentication: :none

user_name: redmine@example.net

password: redmine

Then save “email.yml” file and exit to the command prompt.

5.It’s time to configure the “environmet.rb” configuration. Open up the “environment.rb” and change “config.action_mailer.perform_deliveries = false” to “config.action_mailer.perform_deliveries = true” then save and close the “environment.rb”.

h2. Email configuration for Ubuntu 12.04 with redmine >v1.4.3

1. Instead of creating an email.yml, edit config/configuration.yml and add a section

<pre>

production:

   email_delivery:

     delivery_method: :smtp

...</pre>

or

<pre>production:

   email_delivery:

     delivery_method: :sendmail

...</pre>

Please see http://www.redmine.org/projects/redmine/wiki/EmailConfiguration for the correct format of the full email block.

2. **DO NOT CHANGE** environment.rb config.action_mailer.perform_deliveries. The correct way is changing configuration.yml and leaving the default config.action_mailer.perform_deliveries setting to false:

@config.action_mailer.perform_deliveries = false@

h2. Subversion Installation and Configuration

1.Before configuring Subversion support for Redmine, we should download the Subversion application for Ubuntu, issue:

> sudo apt-get install subversion

2.If your Redmine can't find the “subversion” command you can help to find by issuing:

· > sudo cd /opt/redmine/redmine-0.8.6/config

· > sudo gedit environment.rb

· Add ENV['PATH'] = "#{ENV['PATH']}:/subversion/path" line in it.

· Save and close the “environment.rb”

h2. Start Application at Boot Time

1.To automatically start the application on booting your server you need to modify your “crontab”, issue:

> export EDITOR=gedit

> crontab -e

2.Your “crontab” file will be presented. This is the list of programs that start at certain times or at boot. Add the following to the “crontab” (all on one line):

@reboot cd /opt/redmine/redmine-0.8.6 ; rm -f log/mongrel.pid ; mongrel_rails start -e production -p 3000 -d

h2. Backup

1.Running backups is always a good idea. Redmine backups should include:

* data (stored in your redmine database)

/usr/bin/mysqldump -u -p | gzip > /path/to/redmine/backup/db/redmine_`date +%y_%m_%d`.gz

* attachments (stored in the files directory of your Redmine install)

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

2.Or you can use the bash shell to automate this kind of operation, issue:

> sudo cd /opt/redmine/redmine-0.8.6

> sudo mkdir backup

> sudo mkdir backup/db

> sudo mkdir backup/files

> sudo gedit backup/runRedmineBackup.bash

And after open “runRedmineBackup.bash” with gedit, write all commands below:

<pre>

#!/bin/bash

data=`date -I`

mysqldump --user=root --password="redmine" --all-databases | gzip > db/backup-$data.sql.gz

cd db

ftp -i -n << EOF

open ftpserver.example.net

user username password

bin

mput backup-$data.sql.gz

bye

EOF

</pre>

Then save the “runRedmineBackup.bash” file and exit to the command prompt. After creation of runRedmineBackup.bash you can add this bash script to run continually between specified periods. Issue:

> export EDITOR=gedit

> crontab -e

Add 0 0 * * 0 cd /opt/redmine/redmine-0.8.6/backup ; sh runRedmineBackup.bash commands to crontab to backup database weekly.

For this to work without any permission problems you have to change the permissions of the files to maximum, issue:

> sudo chmod -R 777 backup

> sudo chown -R redmine:redmine backup

That's all. Now we have completely installed Redmine on our virtual Ubuntu OS and can reach it from any machine in our network easily. Congratulations..!

h2. Sources & contributors.

* Ümit Uzun 06/11/2009.

* Some of the above material comes from Macada's wiki, licenced under the GNU Free Documentation License 1.2. See "Redmine in Ubuntu Jaunty 9.04":http://wiki.ousli.org/index.php/Redmine_in_Ubuntu_Jaunty_9.04 by David 'macada', last modified 2010-02-08, accessed 2010-05-26.

* Sam Wilson 2010-05-26, formatting changes.

* Allen Yeh 2010-09-08, Added apt-get install subversion into instructions for 10.04 otherwise once redmine is setup an error like this will result this error -> +*The entry or revision was not found in the repository.*+

h2. Additional Sources

* http://docs.oseems.com/general/web/redmine/install-in-ubuntu