Setting up the environment

Open a shell and navigate to the installation directory.

Create docker volumes

First we create two volumes which are used during the installation to provide configuration and license file to the docker container.

sudo docker volume create ktdocker0rw
sudo docker volume create ktdocker0rwshared

The ktdocker0rw volume will be mounted in the ktdocker0 container.

Note: It might be possible to create more ktdocker containers. At the moment, maximum 2 ktdocker containers are supported. The second container would be called ktdocker4 and would be assigned ktdocker4rw volume.

The ktdocker0rwshared volume will be mounted in all ktdocker containers (if there are multiple) and contains shared data, e.g. file blobs.

Configure the needed shell variables

Please configure your individual values and set all environment variables in your shell session. You can use the following template to create create a local rap.config.sh file, set your individual settings and source it into the shell session.

#!/bin/bash
# Provided by Rulemapping
# -----------------------
PREFIX=<prefix provided by Rulemapping>
LICENSE=<name of licence file provided by Rulemapping>
SECRET=<download secret provided by Rulemapping>


# Your settings
# -------------
# Domain settings
DOMAIN=<your domain>
ADMIN_EMAIL=<your RAP admin user email address>


# Database settings
DBHOST=127.0.0.1
DBPORT=5432

# Passwords for three database users used by the application.
# Please change passwords according to your information security policies. 
DB_SERVER_PASSWORD=server_mysecret
DB_ADMIN_PASSWORD=admin_mysecret
DB_RO_PASSWORD=ro_mysecret

# Configure your SMTP settings and 
# change password according to your information security policies.
SMTP_HOST=<your SMTP host>
SMTP_USER=<your SMTP user>
SMTP_PASSWORD=<your SMTP user's password>

# Email Addresses
FROM_ADDRESS=support@$DOMAIN
REPLY_ADDRESS=no-reply@$DOMAIN

# Docker RW volume path on the host
RW=/var/lib/docker/volumes/ktdocker0rw/_data

Note that on some systems the docker volumes are located elsewhere. In this case please check the docker volume Mountpoint on your system with docker volume inspect ktdocker0rw and replace the path in the RW variable.

Note make sure that these environment variables are always set in your shell session. Set them again if you open a new shell session - e.g. by sourcing the created config file:

source rap.config.sh

Find the following variables in the rap.config.sh file and set the values for your project.

Variable	Description
`PREFIX`	Project name. Provided by Rulemapping. Will contain only letters and digits.
`LICENSE`	Name of your license file which you have downloaded earlier from download center.
`SECRET`	Secret to download docker image. Provided by from Rulemapping.
`DOMAIN`	Your domain
`ADMIN_EMAIL`	The email address of the first admin user which will be created while installation process
`DBHOST`	The database host address
`DBPORT`	The database port
`DB_SERVER_PASSWORD`	Password for server_ database user.
`DB_ADMIN_PASSWORD`	Password for admin_ database user
`DB_RO_PASSWORD`	Password for ro_ database read-only user.
`SMTP_HOST`	The SMTP host for sending emails
`SMTP_USER`	The SMTP user for authentication
`SMTP_PASSWORD`	Password for SMTP authentication
`FROM_ADDRESS`	Email address to send emails from
`REPLY_ADDRESS`	Reply-to address in outgoing emails
`RW`	Docker RW volume path on the host