⚙️ Options

⚙️ Options#

The Olvid daemon is distributed in the form of a Docker image.

The behavior of the created Docker container can be configured using two mechanisms:

  • environment variables

  • command line options

We strongly advise you to use environment variables.

There are two ways to pass an environment variable, depending on whether you are using a docker-compose.yaml file or the docker run command.

docker-compose.yaml
services:
  daemon:
    image: olvid/bot-daemon:2.0.1
    environment:
      - KEY=VALUE
docker run
docker run -e KEY_VALUE olvid/bot-daemon:2.0.1

To add command line options, you need to modify your file or command as follows.

docker-compose.yaml
services:
  daemon:
    image: olvid/bot-daemon:2.0.1
    command: --key mySuperSecretKey
docker run
docker run -e KEY_VALUE olvid/bot-daemon:2.0.1 --key mySuperSecretKey

Options#

gRPC#

Change the listening gRPC port.

(default: 50051)

Environment
DAEMON_PORT=8080
CLI
-p, --port 8080

Logs#

Change logs verbosity.

(default: INFO)

Environment
DAEMON_LOG_LEVEL=DEBUG|INFO|WARNING|ERROR  # daemon logs
ENGINE_LOG_LEVEL=DEBUG|INFO|WARNING|ERROR  # cryptographic engine logs

Admin Client Keys#

Create#

It is possible to set up a temporary administrator client key (not saved in the database).

This is necessary at least for the first connection to the daemon.

Environment

It is possible to create several keys by adding a suffix to the variable OLVID_ADMIN_CLIENT_KEY.

OLVID_ADMIN_CLIENT_KEY=random-uuid
OLVID_ADMIN_CLIENT_KEY_OTHER=other-random-uuid
CLI
-k, --key 00000000-0000-0000-0000-000000000000

List#

It is also possible to list the available client keys. In this case, the daemon displays the keys and then exits.

CLI
-l, --list

TLS#

For more information on using TLS with the daemon, visit our section TLS Configuration.

TLS with server authentication#

Both elements are necessary.

Environment
DAEMON_CERTIFICATE_FILE=server.pem
DAEMON_KEY_FILE=server.key
CLI
--certificate-file server.pem
--key-file server.key

TLS with client authentication#

Three elements are necessary for setting up client authentication.

Environment
--certificate-file server.pem
--key-file server.key
--root-file ca.pem
CLI
DAEMON_CERTIFICATE_FILE=server.pem
DAEMON_KEY_FILE=server.key
DAEMON_ROOT_CERTIFICATE_FILE=ca.pem

Backup#

Restore a backup#

To restore a backup, go to the following section: Backups

CLI

Restoring a backup can be initiated with the option:

-r, --restore-backup backup-file-path.bytes