Configuration

Candor can be configured with environment variables.

Dashboard

Under construction.

Service

Name	Default value	Description	Notes
DASHBOARD_ORIGIN		The origin to allow CORS (set this to the base URL of your public dashboard).
DASHBOARD_COOKIE_SECRET	legends never die	The secret used to encrypt cookies, make sure this is long and secure and not the default.
DASHBOARD_PORT	3000	The port of the dashboard.	When using Docker image: set to default value and cannot be changed.
DASHBOARD_PUBLIC		Where the built frontend of the runner is located.	When using Docker image: set to /opt/dashboard/public and cannot be changed.
DASHBOARD_LOGS	.	The directory where the dashboard logs will be stored.	When using Docker image: set to /var/log/candor/ and cannot be changed.
RUNNER_TOKEN		The secret token to communicate with the dashboard; required.

Database

Name	Default value	Description
PGHOST	localhost	The PostgreSQL server hostname (excl. port).
PGPORT	5432	The PostgreSQL server port.
PGDATABASE	candor	The PostgreSQL database.
PGUSER	candor	The PostgreSQL user.
PGPASSWORD		The PostgreSQL password for the user.

Runner

Docker Socket

In order to connect to the Docker socket, custom environment variables can be passed. These are prefixed with RUNNER_ such that they do not conflict with programs such as docker-compose when stored in a .env file.

Name	Name in container	Default value
RUNNER_DOCKER_HOST	DOCKER_HOST
RUNNER_DOCKER_TLS_VERIFY	DOCKER_TLS_VERIFY
RUNNER_DOCKER_CERT_PATH	DOCKER_CERT_PATH
RUNNER_DOCKER_CLIENT_TIMEOUT	DOCKER_CLIENT_TIMEOUT

By default, all custom configuration options are blank, which defaults to /var/run/docker.sock. For more information on how the different variables work, refer to the Docker Modem source code.

Service

Name	Default value	Description	Notes
RUNNER_TOKEN		The secret token to communicate with the dashboard; required.
RUNNER_PORT	3001	The port of the runner.	When using Docker image: set to default value and cannot be changed.
RUNNER_LOGS	/var/log/candor/	The directory in the runner container where logs are stored. It is recommended to create a bind mount to this to persist logs.	When using Docker image: set to default value and cannot be changed.
RUNNER_SHARED		A directory on the host that, when provided, gets read-only mounted to /srv/candor/ in the stage container. This can be used to e.g. provide SSH keys.

Stage Containers

Name	Default value	Description
RUNNER_CONTAINER_CONFIG_B		A base64 encoded JSON create container payload that will be deep-unioned with the payload Candor makes. This fine-tunes stages and can be used e.g. to impose resource limits on stages.
RUNNER_CONTAINER_TIMEOUT	3600	The maximum runtime in seconds for each stage.

S3 Archives

These environment variables must be specified both in the dashboard and runners.

Name	Default value	Description
S3_BUCKET		The S3 Bucket name.
S3_REGION	eu-west-1	The region.
S3_ENDPOINT		The endpoint.
S3_PORT		The port.
S3_ACCESS		The access key (username).
S3_SECRET		The secret key (password).
S3_SSL		Will force to use SSL if and only if set to true.

For more information on these variables, refer to MinIO.