How to configure the sedex Client Docker Container¶

In many cases, the default configuration of the sedex Client Docker container should work "out-of-box" without users having to adjust configuration parameters. In specific cases, however, it may be necessary to adjust configuration parameters of the sedex Client or the Docker Container. This page describes the different ways to set specific configuration parameters for the sedex Client Docker Container.

Default configuration¶

During the very first start of the sedex Client container, the initial configuration takes place. This creates a default configuration, which can be used unchanged in most cases. Setting custom configuration parameters should rarely be necessary, but can be done as described on this page.

Custom Configuration¶

The sedex Client can be configured by setting configuration parameters in the form of specific key-value pairs. These configurations parameters can be set in two ways:

in the sedex Client's central configuration file
as environment variables of the Docker container

Both configuration types are described in more detail in the following.

Environment variables have a higher priority

If the same key is defined both in the central configuration file and as an environment variable, the environment variable value has a higher priority and will be used. This means that environment variables can override values in the configuration file.

Setting parameters in the central sedex Client configuration file¶

Custom configuration parameters can be set in the central sedex Client configuration file ("sedex-client-configuration.properties) as follows:

With a text editor (e.g. "nano" or "notepad") open the central sedex Client configuration file named "sedex-client-configuration.properties" located in the subdirectory "sedex-data/conf":
```
$ nano /path/to/sedex-data/conf/sedex-Client-configuration.properties
```
Add the necessary configuration parameter(s) to the configuration file and save it.
```
key_name_1=value_1
key_name_2=value_2
```
Restart the sedex Client container in order to activate the new configuration (maybe you have to adjust the name of the container).
```
$ docker restart sedex-client
```

Setting parameters as Environment Variables of the Docker Container¶

Custom configuration parameters can be set via environment variables of the Docker container as follows:

Stop and delete the current sedex Client container (maybe you have to adjust the name of the container).
```
$ docker stop sedex-client
$ docker rm sedex-client
```

Run the new sedex Client container and add the necessary configuration parameter(s) as environment variables.

$ docker pull sedexch/sedex-client:container-1.1

$ docker run \
  --name sedex-client \
  --mount type=bind,source=/path/to/sedex-interface,destination=/sedex-interface/ \
  --mount type=bind,source=/path/to/sedex-data,destination=/sedex-data/ \
  --publish YOUR_MONITORING_PORT:8000 \
  --publish YOUR_WS_PROXY_HTTP_PORT:8080 \
  --publish YOUR_WS_PROXY_HTTPS_PORT:8443 \
  --stop-timeout 65 \
  --restart unless-stopped \
  --read-only \
  -d \
  --env KEY_NAME_1=VALUE_1 \
  --env KEY_NAME_2=VALUE_2 \
  sedexch/sedex-client:container-1.1