Skip to content

Configuration

Datero is a containerized application that is shipped as a single Docker image. When you run it, you can provide configuration parameters to customize its behavior. This document describes the configuration options available for Datero.

Environment variables

Datero database engine is based on the official PostgreSQL database. More specifically, it is actually a PostgreSQL database with added set of FDW extensions. It supports all the environment variables that are supported by the PostgreSQL docker image .

While all the environment variables supported by the PostgreSQL image are available and will act as expected, only a few of them are relevant to Datero.

  • POSTGRES_USER
    • This optional environment variable is used in conjunction with POSTGRES_PASSWORD to set a user and its password. This variable will create the specified user with superuser power and a database with the same name. If it is not specified, then the default user of postgres will be used.
  • POSTGRES_PASSWORD - required
    • The only mandatory variable. It must not be empty or undefined. This environment variable sets the superuser password for PostgreSQL. The default superuser name is defined by the POSTGRES_USER environment variable listed above.
  • POSTGRES_DB
    • This optional environment variable can be used to define a different name for the default database that is created when the image is first started. If it is not specified, then the value of POSTGRES_USER will be used.

In most cases, if you want to have standard "out of the box" behavior, you will only need to set the POSTGRES_PASSWORD environment variable. That will provide you with a PostgreSQL instance with the default superuser name of postgres and the default database name of postgres.

Folders structure

Datero layout is spread over two directories: /home and /data. The /home directory contains the application code and instance runtime data. The /data directory is used for file-based data sources.

Datero root directory

Datero root directory is located in the /home directory. Do not mount anything to it. By doing so, you might overwrite its content and the application will not work as expected.

The only exception is the /home/instance/config.yaml file, which is application configuration file. You can mount your own configuration file to it. In such case, it will be used instead of the default one.

O/S layout:

/home               # app code. DO NOT mount anything to this directory.
    /instance       # app runtime data. DO NOT mount anything to this directory.
        config.yaml # app configuration file, can be mounted from the host
/data               # directory for file-based data, can be mounted from the host

Application launch

The Datero instance creation is described in details in the installation guide. A minimum and full formats of the docker run command with some explanations are shown below:

1
2
3
4
docker run -d --name datero \
    -p 80:80 -p 5432:5432 \
    -e POSTGRES_PASSWORD=postgres \
    chumaky/datero

1
2
3
4
5
6
docker run -d --name datero \
    -p 80:80 -p 5432:5432 \
    -e POSTGRES_PASSWORD=postgres \
    -v "$(pwd)/data:/data" \
    -v "$(pwd)/config.yaml:/home/instance/config.yaml" \
    chumaky/datero

1
2
3
4
5
6
docker run -d --name datero \
    -p 80:80 -p 5432:5432 \
    -e POSTGRES_PASSWORD=postgres \
    -v "$(pwd)/data:/data" \
    -v "$(pwd)/config.yaml:/home/instance/config.yaml" \
    chumaky/datero

1
2
3
4
5
6
docker run -d --name datero \
    -p 80:80 -p 5432:5432 \
    -e POSTGRES_PASSWORD=postgres \
    -v "$(pwd)/data:/data" \
    -v "$(pwd)/config.yaml:/home/instance/config.yaml" \
    chumaky/datero

1
2
3
4
5
6
docker run -d --name datero \
    -p 80:80 -p 5432:5432 \
    -e POSTGRES_PASSWORD=postgres \
    -v "$(pwd)/data:/data" \
    -v "$(pwd)/config.yaml:/home/instance/config.yaml" \
    chumaky/datero

1
2
3
4
5
6
docker run -d --name datero \
    -p 80:80 -p 5432:5432 \
    -e POSTGRES_PASSWORD=postgres \
    -v "$(pwd)/data:/data" \
    -v "$(pwd)/config.yaml:/home/instance/config.yaml" \
    chumaky/datero

Configuration file

TBD