Updated Jan 10, 2025

Scope:

The following instructions can be used to install a redmine instance on OpalStack using an OpalStack Rails Application

References:

Instructions:

Setup Ruby Application using Control Panel
1. Create an SSH user for this app
2. Create a Ruby On Rails application (e.g., RAILS_APP=redmine)
3. Create a Domain to point to Redmine (e.g., SITE=redmine.myuser.opalstacked.com)
4. Create a Site to point to Redmine
5. Create a MariaDB Database User
  
  Note: a password will automatically be created for you and available on the Notices page.
6. Create a MariaDB Database (e.g., DB_NAME=redmine)
  - select Unicode, 8-bit charset
  - no need to check external access
  - add the MariaDB user to this database
    
    Note: Although I haven't tried it you should be able to setup a Postgres or other database for use with Redmine. For postgres, make sure to edit PATH in $RAILS_APP/setenv to use /usr/pgsql-11/bin/, for example and also use the correct settings in redmine folder config/database.yml.

Login to your server via SSH

    ssh <USER>@<SERVER NAME/IP>

Modify app scripts

    # Run these commands
    export RAILS_APP=redmine
    export RAILS_APP_PATH=/home/$USER/apps/$RAILS_APP
    cd $RAILS_APP_PATH

    # Modify each of the following files to
    #    1. change PROJECTDIR to point to redmine/redmine-$REDMINE_VER
    #    2. change 'RAILS_ENV=development' to 'RAILS_ENV=production'
    vi ./setenv 
    vi ./start_puma
    vi ./stop_puma

    # Change these to match your setup. This just makes it easier to use the commands below
    source ./setenv
    export REDMINE_VER=6.0.2

Download and Untar Redmine

    cd $RAILS_APP_PATH
    wget https://www.redmine.org/releases/redmine-$REDMINE_VER.tar.gz
    tar -xvf redmine-$REDMINE_VER.tar.gz

Setup Redmine Database YML File

    cd $PROJECTDIR
    cp config/database.yml.example config/database.yml
    vi config/database.yml

    # Change the database.yml file to match your setup:
    #    a. Set the database name field
    #    b. Set the username and password fields
    #    c. make sure encoding is set to utf8mb4
    #    d. change the `transaction_isolation` field under `variables` to `tx_isolation` #       to avoid this error: 
    #       `ActiveRecord::StatementInvalid: Mysql2::Error: Unknown system #variable 'transaction_isolation' (ActiveRecord::StatementInvalid)`

    # When completed the database.yml file should look like this:

    production:
      adapter: mysql2
      database: <DB_NAME>
      host: localhost
      username: <DB_USER>
      password: "<DB_PASSWORD>"
      # Use "utf8" instead of "utfmb4" for MySQL prior to 5.7.7
      encoding: utf8mb4
      variables:
        # For MariaDB REPLACE transaction_isolation with tx_isolation
        # Recommended `transaction_isolation` for MySQL to avoid concurrency issues is
        # `READ-COMMITTED`.
        # In case of MySQL lower than 8, the variable name is `tx_isolation`.
        # See https://www.redmine.org/projects/redmine/wiki/MySQL_configuration
        tx_isolation: "READ-COMMITTED"

Edit the development / production ruby file

    vi $PROJECTDIR/config/environments/development.rb
    vi $PROJECTDIR/config/environments/production.rb

    # Add the following line right the line "config.active_support.deprecation..."
    # For example config.hosts << "redmine.myuser.opalstacked.com"
    config.hosts << "<SITE>"

Add puma to Gemfile

    vi $PROJECTDIR/Gemfile
        1. Add gem 'puma' near top of file
        2. Comment out gem 'puma' in test section near end of file

Setup Redmine and Database

    cd $RAILS_APP_PATH
    source ./setenv
    cd $PROJECTDIR
    bundle config set --local without 'development test'
    bundle install
    bundle exec rake generate_secret_token
    RAILS_ENV=production bundle exec rake db:migrate
    RAILS_ENV=production REDMINE_LANG=en bundle exec rake redmine:load_default_data

Setup PID and Sockets files

    cd $PROJECTDIR
    mkdir -p tmp/sockets
    mkdir -p tmp/pids
    cp $RAILS_APP_PATH/myproject/tmp/pids/* tmp/pids

Maintenance

Use the start/stop/restart scripts as needed

    cd $RAILS_APP_PATH
    ./stop
    ./start
    ./restart

Opalstack automatically creates a cronjob to run your start script once every 10mins.
This is helpful for making sure that your redmine app restarts in case it goes down for some reason.
If needed you can edit the cronjob using:

crontab -e