Using a Different System?
How to Install Redmine on Ubuntu 16.04
Redmine is a free and open source, web-based project management tool. It is written in Ruby on Rails and supports multiple database servers for storing the database. It is a feature-rich application supporting multiple projects, role based ACL and issue tracking system. It also has Gantt chart and calendar support, file management, per project wiki and forum, as well as many other features. It supports version control systems such as Git, SVN or CVS. It is also multilingual, supporting as many as 49 languages.
This guide was written for Redmine 3.4.4, but may apply to newer versions as well.
- A Vultr CentOS 7 server instance.
- A sudo user.
- A domain name pointed towards the server.
For this tutorial, we will use
192.168.1.1 as the public IP address and
redmine.example.com as the domain name pointed towards the Vultr instance. Please make sure to replace all occurrences of the example domain name and IP address with the actual one.
Update your base system using the guide How to Update CentOS 7. Once your system has been updated, proceed to install the dependencies.
Redmine is written in Ruby on Rails, thus we will require Phusion Passenger to integrate with the Apache web server to serve the application. Install Apache.
sudo yum -y install httpd httpd-devel libcurl-devel
To build the Redmine application, we will need some development tools as well. Install the required tools.
sudo yum -y install ImageMagick ImageMagick-devel git libxml2-devel libxslt-devel gcc bzip2 openssl-devel zlib-devel gdbm-devel ncurses-devel autoconf automake bison gcc-c++ libffi-devel libtool patch readline-devel sqlite-devel glibc-headers glibc-devel libyaml-devel libicu-devel libidn-devel
Redmine supports multiple types of database servers such as MySQL, PostgreSQL, and MSSQL. In this tutorial, we will use PostgreSQL to host the Redmine database server.
PostgreSQL is an object-relational database system. The default
yum repository contains an old version of PostgreSQL, so add the PostgreSQL repository to the system.
sudo yum -y install https://download.postgresql.org/pub/repos/yum/10/redhat/rhel-7-x86_64/pgdg-centos10-10-1.noarch.rpm
Install the PostgreSQL database server.
sudo yum -y install postgresql10-server postgresql10-contrib postgresql10
Initialize the database.
sudo /usr/pgsql-10/bin/postgresql-10-setup initdb
Start the PostgreSQL server and enable it to start automatically at boot time.
sudo systemctl start postgresql-10 sudo systemctl enable postgresql-10
Change the password for the default PostgreSQL user.
sudo passwd postgres
Log in as the PostgreSQL user.
sudo su - postgres
Create a new PostgreSQL user for Redmine.
You are allowed to use any username instead of
redmine. PostgreSQL provides the
psql shell to run queries on the database. Switch to the PostgreSQL shell.
Set a password for the newly created user for the Redmine database.
ALTER USER redmine WITH ENCRYPTED password 'DBPassword';
DBPassword with a secure password. Create a new database for the Redmine installation.
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
Exit from the
Switch to the
pg_hba.conf file to enable MD5 based authentication.
sudo nano /var/lib/pgsql/10/data/pg_hba.conf
Find the following lines and change the values
ident in the
METHOD column to
# TYPE DATABASE USER ADDRESS METHOD # "local" is for Unix domain socket connections only local all all peer # IPv4 local connections: host all all 127.0.0.1/32 ident # IPv6 local connections: host all all ::1/128 ident
Once updated, the configuration should look like this.
# TYPE DATABASE USER ADDRESS METHOD # "local" is for Unix domain socket connections only local all all trust # IPv4 local connections: host all all 127.0.0.1/32 md5 # IPv6 local connections: host all all ::1/128 md5
Restart PostgreSQL so that the changes can take effect.
sudo systemctl restart postgresql-10
Install a few more required PostgreSQL dependencies.
sudo yum -y install libpqxx-devel protobuf-devel
It is recommended to use an unprivileged user to run the application to keep it isolated from rest of the system. Create a new user for Redmine and switch to the newly created user.
sudo adduser redmine sudo su - redmine
We will install the latest version of Ruby using Ruby Version Manager, or RVM. It is used to install and manage multiple versions of Ruby.
Add the GPG key of RVM to your server.
gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
curl -sSL https://get.rvm.io | bash -s stable source ~/.rvm/scripts/rvm
Fetch the list of the available versions of Ruby.
rvm list known
You will see a long list of Ruby versions.
[redmine@vultr ~]$ rvm list known # MRI Rubies [ruby-]1.8.6[-p420] [ruby-]1.8.7[-head] # security released on head [ruby-]1.9.1[-p431] [ruby-]1.9.2[-p330] [ruby-]1.9.3[-p551] [ruby-]2.0.0[-p648] [ruby-]2.1[.10] [ruby-]2.2[.7] [ruby-]2.3[.4] [ruby-]2.4[.1] ruby-head ...
Install the latest version of Ruby from the list.
rvm install 2.4
Use the installed version of Ruby.
rvm use 2.4
You can verify its version.
You will see a similar output.
[redmine@vultr ~]$ ruby -v ruby 2.4.1p111 (2017-03-22 revision 58053) [x86_64-linux]
Install bundler, which is the dependency manager for the Ruby application.
gem install bundler
Ruby is now installed. Before we install Redmine, we will need to install Phusion Passenger.
Run the following command to install Passenger.
gem install passenger
Provide execution permission to the home directory of
redmine user. Passenger needs to execute the binaries in order to serve the application.
chmod o+x "/home/redmine"
Install the Apache module for Passenger.
The installer script will ask you some questions. First, it will provide you information about the installation process. Then it will ask you to select the language which you will be using. Since our application is written in Ruby on Rails, select Ruby from the menu and press “
Enter” to proceed further.
Which languages are you interested in? Use <space> to select. If the menu doesn't display correctly, press '!' ‣ ⬢ Ruby ⬡ Python ⬡ Node.js ⬡ Meteor
The installer will now check for requirements. The installer will not encounter any missing dependencies and will automatically proceed to compile and install the module.
Once the module is installed, it will prompt you to add the module into the Apache configuration file.
Almost there! Please edit your Apache configuration file, and add these lines: LoadModule passenger_module /home/redmine/.rvm/gems/ruby-2.4.1/gems/passenger-5.1.12/buildout/apache2/mod_passenger.so <IfModule mod_passenger.c> PassengerRoot /home/redmine/.rvm/gems/ruby-2.4.1/gems/passenger-5.1.12 PassengerDefaultRuby /home/redmine/.rvm/gems/ruby-2.4.1/wrappers/ruby </IfModule> After you restart Apache, you are ready to deploy any number of web applications on Apache, with a minimum amount of configuration! Press ENTER when you are done editing.
We will skip this for now and will complete it later in the tutorial as the user with which we are logged in now does not have
sudo permissions. Press “
Enter” to skip this step.
Finally, the installer script will validate the installation and you will see a warning saying the Passenger module is not specified in Apache configuration.
Validating installation... * Checking whether this Passenger install is in PATH... ✓ * Checking whether there are no other Passenger installations... ✓ * Checking whether Apache is installed... ✓ * Checking whether the Passenger module is correctly configured in Apache... (!) You did not specify 'LoadModule passenger_module' in any of your Apache configuration files. Please paste the configuration snippet that this installer printed earlier, into one of your Apache configuration files, such as /etc/httpd/conf/httpd.conf. Detected 0 error(s), 1 warning(s). Press ENTER to continue.
Now that we have installed the Passenger module for Apache, proceed to download and install Redmine.
Download the latest version of Redmine from the official Redmine download page.
cd ~ wget http://www.redmine.org/releases/redmine-3.4.4.tar.gz
Extract the archive and rename the directory for sake of convenience.
tar -xf redmine-*.tar.gz mv redmine-*/ redmine/
Copy the example configuration files to its production location.
cd redmine cp config/configuration.yml.example config/configuration.yml cp config/database.yml.example config/database.yml
Open the database configuration file we just copied to enter the database details.
By default, the database file is configured for MySQL. Find the configurations for production and development, and test which uses the MySQL adapter. Comment out all of these lines.
#production: # adapter: mysql2 # database: redmine # host: localhost # username: root # password: "" # encoding: utf8 #development: # adapter: mysql2 # database: redmine_development # host: localhost # username: root # password: "" # encoding: utf8 #test: # adapter: mysql2 # database: redmine_test # host: localhost # username: root # password: "" # encoding: utf8
Furthur, find the lines which are commented, having
production configuration for the
postgresql adapter. Uncomment those lines and update the database name and user credentials. Make sure to use the correct indentation, which is two spaces.
production: adapter: postgresql database: redmine host: localhost username: redmine password: "DBPassword"
Configure the application to use the PostgreSQL configuration.
bundle config build.pg --with-pg-config=/usr/pgsql-10/bin/pg_config
Install the application dependencies required by the application.
bundle install --without development test
You will see the following message at the end of the installation.
Installing roadie-rails 1.1.1 Bundle complete! 31 Gemfile dependencies, 55 gems now installed. Gems in the groups development and test were not installed. Use `bundle info [gemname]` to see where a bundled gem is installed.
The following command generates secret tokens that are used to encode the session data.
bundle exec rake generate_secret_token
Write the PostgreSQL database.
RAILS_ENV=production bundle exec rake db:migrate
Run the following command, which writes the default data into PostgreSQL database.
RAILS_ENV=production bundle exec rake redmine:load_default_data
The above command will ask you to choose the default language to be used with the application. The default choice is English; choose according to your preference.
[redmine@vultr redmine]$ RAILS_ENV=production bundle exec rake redmine:load_default_data Select language: ar, az, bg, bs, ca, cs, da, de, el, en, en-GB, es, es-PA, et, eu, fa, fi, fr, gl, he, hr, hu, id, it, ja, ko, lt, lv, mk, mn, nl, no, pl, pt, pt-BR, ro, ru, sk, sl, sq, sr, sr-YU, sv, th, tr, uk, vi, zh, zh-TW [en] ==================================== Default configuration data loaded.
Installation of the Redmine application is now finished. Change ownership and permissions of the directories and files.
mkdir -p tmp tmp/pdf public/plugin_assets chown -R redmine:redmine files log tmp public/plugin_assets chmod -R 755 files log tmp public/plugin_assets
We have configured everything we need from the non-privileged user. Switch back to the
sudo user by running
su - <username>.
Add the Passenger module for Apache into the Apache configuration file. This will automatically load the Passenger module.
echo "LoadModule passenger_module /home/redmine/.rvm/gems/ruby-2.4.1/gems/passenger-5.1.12/buildout/apache2/mod_passenger.so" | sudo tee -a /etc/httpd/conf.modules.d/00-base.conf
Create a new virtual host file for your Redmine application.
sudo nano /etc/httpd/conf.d/redmine.conf
Populate the file with the following content.
<VirtualHost *:80> ServerName redmine.example.com DocumentRoot /home/redmine/redmine/public PassengerRoot /home/redmine/.rvm/gems/ruby-2.4.1/gems/passenger-5.1.12 PassengerRuby /home/redmine/.rvm/gems/ruby-2.4.1/wrappers/ruby PassengerUser redmine <Directory /home/redmine/redmine/public> Allow from all Options -MultiViews Require all granted </Directory> </VirtualHost>
Make sure to replace
redmine.example.com with your actual domain name. Also, make sure that the path to the
PassengerRuby are correct. The path to the binaries may change when there is a new release of Ruby or Passenger. To find these paths, run the following command.
sudo su redmine -c "passenger-config about ruby-command"
You will get following output.
[user@vultr ~]$ sudo su redmine -c "passenger-config about ruby-command" passenger-config was invoked through the following Ruby interpreter: Command: /home/redmine/.rvm/gems/ruby-2.4.1/wrappers/ruby Version: ruby 2.4.1p111 (2017-03-22 revision 58053) [x86_64-linux] To use in Apache: PassengerRuby /home/redmine/.rvm/gems/ruby-2.4.1/wrappers/ruby To use in Nginx : passenger_ruby /home/redmine/.rvm/gems/ruby-2.4.1/wrappers/ruby To use with Standalone: /home/redmine/.rvm/gems/ruby-2.4.1/wrappers/ruby /home/redmine/.rvm/gems/ruby-2.4.1/gems/passenger-5.1.12/bin/passenger start
Once the Virtual host file is created, restart the Apache web server.
sudo systemctl restart httpd
Modify the firewall configuration to allow port
80 through the firewall.
sudo firewall-cmd --zone=public --add-service=http --permanent sudo firewall-cmd --reload
You can now access your Redmine interface on
http://redmine.example.com. Login with username
admin and password
admin. On your first login, Redmine will prompt you to update the password.
Securing Apache with Let’s Encrypt SSL
Since our Redmine installation is on a public facing server, it is recommended to use SSL to secure the exchange of the data from the server.
Install Certbot, which is the client application for Let’s Encrypt CA.
sudo yum -y install epel-release sudo yum -y install certbot mod_ssl
Before you can request for the certificates, you will need to allow port
443 or standard
HTTPS services through the firewall. Since we have already allowed port
80 earlier, let’s allow port
sudo firewall-cmd --zone=public --add-service=https --permanent sudo firewall-cmd --reload
Note: To obtain certificates from Let’s Encrypt CA, the domain for which the certificates are to be generated must be pointed towards the server. If not, make the necessary changes to the DNS records of the domain and wait for the DNS to propagate before making the certificate request again. Certbot checks the domain authority before providing the certificates.
Generate the SSL certificates.
sudo certbot certonly --webroot -w /home/redmine/redmine/public -d redmine.example.com
The generated certificates are likely to be stored in
/etc/letsencrypt/live/redmine.example.com/. The SSL certificate will be stored as
cert.pem and private key will be stored as
Let’s Encrypt certificates expire in 90 days, hence it is recommended to set up auto-renewal of the certificates using Cron jobs.
Open the Cron job file for the
sudo crontab -e
Add the following line at the end of the file.
30 5 * * * /usr/bin/certbot renew --quiet
The above Cron job will run every day at 5:30 AM. If the certificate is due for expiry, it will automatically be renewed.
Edit the virtual host file we created earlier for Redmine.
sudo nano /etc/httpd/conf.d/redmine.conf
Modify the Virtual host file to make look like the following.
<VirtualHost *:80> Redirect permanent / https://www.example.com/ ServerName redmine.example.com </VirtualHost> <VirtualHost *:443> ServerAdmin email@example.com ServerName redmine.example.com DocumentRoot "/home/redmine/redmine/public" <Directory "/home/redmine/redmine/public"> Options None Require all granted </Directory> PassengerAppEnv production PassengerRoot /home/redmine/.rvm/gems/ruby-2.4.1/gems/passenger-5.1.12 PassengerRuby /home/redmine/.rvm/gems/ruby-2.4.1/wrappers/ruby PassengerUser redmine PassengerHighPerformance on SSLEngine on SSLCertificateFile /etc/letsencrypt/live/redmine.example.com/cert.pem SSLCertificateKeyFile /etc/letsencrypt/live/redmine.example.com/privkey.pem SSLCertificateChainFile /etc/letsencrypt/live/redmine.example.com/chain.pem SSLProtocol all -SSLv2 -SSLv3 SSLHonorCipherOrder on SSLCipherSuite ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES256-SHA:ECDHE-ECDSA-DES-CBC3-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA:!DSS <IfModule headers_module> Header always edit Set-Cookie ^(.*)$ $1;HttpOnly;Secure Header always set Strict-Transport-Security "max-age=15768000; includeSubDomains" </IfModule> </VirtualHost>
Save the file and exit from the editor.
Restart Apache so that the changes can take effect.
sudo systemctl restart httpd
You can now access Redmine over
Congratulations, you have successfully installed Redmine on your CentOS 7 instance. Start developing your project either by creating or importing your project.
Want to contribute?
You could earn up to $300 by adding new articles
Suggest an update
Request an article