Installation

Please follow the prerequisites for the installation in advance.

This is the installation under Debian and Ubuntu.

For Red Hat Enterprise Linux (RHEL) see here.

For Windows Server see here.

Tested only with Debian 10 (“buster”) and only using bash as the shell for commands. With other Linux variants and shells please keep your eyes open for small adjustments.

Download the easydb software to your server

You will receive from us the username, password and the name of your “solution”. Here is an example:

KONTONAME=kunde1234
SOLUTION=base
docker login --username=$KONTONAME docker.easydb.de

The above command will request you to enter your password. $KONTONAME is a placeholder.

If login does not work and tries to connect to docker.io instead of docker.easydb.de, install the debian packages gnupg2 pass gpg and try again.

After login, the following commands will then be authorized:

docker pull docker.easydb.de/pf/server-$SOLUTION
docker pull docker.easydb.de/pf/webfrontend
docker pull docker.easydb.de/pf/elasticsearch
docker pull docker.easydb.de/pf/eas
docker pull docker.easydb.de/pf/postgresql-14
docker pull docker.easydb.de/pf/fylr

Between 4 to 10 gigabytes are thus downloaded. Please provide sufficient space. Under e.g. Debian and Ubuntu in /var/lib/docker.

Please note: Whenever you want to download easydb updates, repeat the above commands. To complete the update process, you then just need to re-create the containers. Creation of the containers is described below.

Take care: The storage requirement will quickly increase with updates if old container data and old container images are not cleaned up regularly.

Define the data store

In this example, we use the “/srv/easydb” directory for all data that is generated. Please adjust the first line to your requirements:

BASEDIR=/srv/easydb
mkdir -p $BASEDIR/config
cd $BASEDIR
mkdir -p webfrontend eas/{lib,log,tmp} elasticsearch/var pgsql/{etc,var,log,backup} easydb-server/{nginx-log,var} fylr/objectstore
chmod a+rwx easydb-server/nginx-log elasticsearch/var eas/tmp; chmod o+t eas/tmp
chmod a+rx pgsql/{etc,var,log,backup}
touch config/eas.yml config/fylr.yml config/elasticsearch.yml
chown 1000:1000 fylr/objectstore

Adjustments

Adjustments are made in the directory $BASEDIR/config. Please add at least the following lines to $BASEDIR/config/easydb-server.yml:

server:
  external_url: http://hostname.as.seen.in.browser.example.com
extension:
  external-user-schema: true

Please note: The last two lines are only valid for the “base” solution (documented here).

Completion of the installation

docker network create easy5net

This allows communication between the components.

Start

The components of the easydb are separated into one docker container each and are created with one command per container. Container start at boot is then done by the docker service (due to --restart=always):

BASEDIR=/srv/easydb
docker run -d \
    --name easydb-pgsql \
    --net easy5net \
    --restart=always \
    --volume=$BASEDIR/config:/config \
    --volume=$BASEDIR/pgsql/etc:/etc/postgresql \
    --volume=$BASEDIR/pgsql/log:/var/log/postgresql \
    --volume=$BASEDIR/pgsql/var:/var/lib/postgresql \
    --volume=$BASEDIR/pgsql/backup:/backup \
    docker.easydb.de/pf/postgresql-14

sysctl -w vm.max_map_count=262144
# ... can be added persistently via /etc/sysctl.conf instead.

BASEDIR=/srv/easydb
docker run -d \
    --name easydb-elasticsearch \
    --net easy5net \
    --restart=always \
    --volume=$BASEDIR/config:/config \
    --volume=$BASEDIR/elasticsearch/var:/var/lib/elasticsearch \
    docker.easydb.de/pf/elasticsearch

BASEDIR=/srv/easydb
docker run -d \
    --name easydb-eas \
    --net easy5net \
    --restart=always \
    --volume=$BASEDIR/config:/config \
    --volume=$BASEDIR/eas/lib:/var/opt/easydb/lib/eas \
    --volume=$BASEDIR/eas/log:/var/opt/easydb/log/eas \
    --volume=$BASEDIR/eas/tmp:/tmp \
    docker.easydb.de/pf/eas

BASEDIR=/srv/easydb
SOLUTION=base
docker run -d \
    --name easydb-server \
    --net easy5net \
    --restart=always \
    --security-opt seccomp=unconfined \
    --cap-add SYS_PTRACE \
    --volume=$BASEDIR/config:/config \
    --volume=$BASEDIR/easydb-server/var:/easydb-5/var \
    --volume=$BASEDIR/easydb-server/nginx-log:/var/log/nginx \
    docker.easydb.de/pf/server-$SOLUTION

BASEDIR=/srv/easydb
docker run -d \
    --name easydb-webfrontend \
    --net easy5net \
    --restart=always \
    --volume=$BASEDIR/config:/config \
    -p 80:80 \
    docker.easydb.de/pf/webfrontend

BASEDIR=/srv/easydb
docker run -d \
    --name easydb-fylr \
    --net easy5net \
    --restart=always \
    --volume=$BASEDIR/config:/config \
    --volume=$BASEDIR/fylr/objectstore:/objectstore \
    docker.easydb.de/pf/fylr

We recommend to put this code in seperate files, e.g. /srv/easydb/run-webfrontend.sh and make this files executable with ‘chmod’.

The option restart=always ensures that the containers are started together with the docker engine, e.g. during server start. This serves as integration into the linux init system.

Dependencies

These are the dependencies between containers:

easydb-eas depends on easydb-postgresql
easydb-server depends on easydb-postgresql, easydb-elasticsearch and easydb-eas
easydb-webfrontend depends on easydb-server

During their startup, the containers are waiting for their dependencies to come up. After the dependencies are up, this initial waiting is finished and will not be repeated if the dependencies go down again. Thus, if you e.g. restart easydb-postgresql you have to manually restart easydb-eas and easydb-server (with docker restart easydb-eas easydb-server).

Result

At port 80 of your server, the easydb is now ready for requests from web browsers.

After the installation you can log in with the following profile for the first time:

Login: root
Password: admin

We strongly recommend that you change your password immediately after you have logged in.

Log rotation

Put into e.g. /etc/logrotate.d/easydb something like:

/srv/easydb/easydb-server/var/imexporter.log /srv/easydb/easydb-server/nginx-log/error.log /srv/easydb/easydb-server/nginx-log/access.log /srv/easydb/pgsql/log/postgresql-*-main.log /srv/easydb/eas/log/eas-janitor.log /srv/easydb/eas/log/eas-exception.log /srv/easydb/eas/log/eas-job.log /srv/easydb/eas/log/eas-worker.log /srv/easydb/eas/log/apache.error.log /srv/easydb/eas/log/apache.access.log /var/log/easydb-update.log {
    copytruncate
    missingok
    size 20M
    dateext
    maxage 62
    rotate 62
    su root www-data
}