Redmine Installation with Code Review Plugin in Ubuntu 20.04

Redmine is the popular open source project management system with code review feature. We can tarck the time spent by developers for a particular project. GIT and SVN can also be linked with redmine for code review. It is complete package for managing projects in a small team size.

Redmine URL

• Redmine is a project management web application.
• https://redmine.org/projects/redmine/wiki/HowTo_Install_Redmine_50x_on_Ubuntu_2004_with_Apache2

Installing dependencies

sudo apt-get update && sudo apt-get upgrade -y

Install required packages

sudo apt install -y apache2 ruby ruby-dev build-essential libapache2-mod-passenger libmysqlclient-dev
sudo apt-get install mysql-server`

Download & Extract Redmine

wget https://redmine.org/releases/redmine-5.0.1.tar.gz`
cd /opt
sudo tar -xvzf ~/redmine-5.0.1.tar.gz
sudo cp -r redmine /opt/

Symlink to remove version reference

sudo ln -s redmine-5.0.1 redmine

Configure database

Create a database and create a user for redmine. Example for localhost installation below:

sudo mysql
mysql> 
CREATE DATABASE redmine CHARACTER SET utf8mb4;
CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'your_password';
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'your_password';
FLUSH PRIVILEGES;

Edit database configuration file

• copy the example file

  cd /opt/redmine
  cp config/database.yml.example config/database.yml
  

Edit config file with your editor of choice (mine is vi)

• sudo vim config/database.yml
• Replace or update the production: block with your configuration. One example based on the mysql config above.

production:
  adapter: mysql2
  database: redmine
  host: localhost
  username: root
  password: "secretPassword" 
  # Use "utf8" instead of "utfmb4" for MySQL prior to 5.7.7
  encoding: utf8mb4

Install Ruby dependencies

• install bundler
  • sudo gem install bundler

Install redmine bundle (give sudo password when prompted)

• bundle install

Run Redmine scripts

• generate secret token
  • bundle exec rake generate_secret_token
• migrate database
  • RAILS_ENV=production bundle exec rake db:migrate
• load default data
  • RAILS_ENV=production bundle exec rake redmine:load_default_data

Configure Apache

• Create an apache configuration file in /etc/apache2/sites-available (e.g. redmine.conf) with the following content:

<VirtualHost *:80>
    ServerName redmine.example.com
    RailsEnv production
    DocumentRoot /opt/redmine/public

    <Directory "/opt/redmine/public">
            Allow from all
            Require all granted
    </Directory>

    ErrorLog ${APACHE_LOG_DIR}/redmine_error.log
        CustomLog ${APACHE_LOG_DIR}/redmine_access.log combined
</VirtualHost>

• If this is a new standalone installation, it will have created a default apache site. Disable it and enable the redmine config created above.

• disable default apache sites

  • sudo a2dissite 000-default.conf

• enable redmine

  • sudo a2ensite redmine.conf

• reload apache

  • sudo systemctl reload apache2

Test Redmine

• Point your browser to the IP/DNS Name of the server http://ipaddress and it should show the default Redmine screen.
• Login with admin/admin credential

Secret Key for Reference

• rake secret RAILS_ENV=production

Install Code Review Plugin

• Download from https://github.com/haru/redmine_code_review
• Copy the extracted folde into redmine plugins directory
• run the following command
  • rake redmine:plugins:migrate RAILS_ENV=production