Installation

Candor should be installed with Docker. It is possible to run Candor on baremetal, but this method is not officially supported. This guide assumes installation and basic familiarity with Docker.

Networking & Security

Under construction.

Dashboard

Under construction.

Runner

docker container run --name runner1 \
  -e RUNNER_TOKEN=your_super_secret_token \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -p 127.0.0.1:3001:3001
  arraying/candor-runner

Archiving

To enable archiving, please provide the S3_* environment variables outlined in the Configuration page. These need to be provided to both the runner and dashboard.

A quick one-purpose S3 server can be created with cloudserver:

# Under construction.

Configuration

This installation provides Candor with the default settings. It is important to give the container access to the host machine's Docker, such that it can spin up containers. How this is achieved depends on the installation, for more information see the Configuration page.

More advanced configuration can be found in the [Configuration] page. The environment variables provided there need to be specified when creating the runner(s) or dashboard.