Skip to main content

From Docker

You can start the Assessment Module Manager and all available modules in this repository using Docker.

Build and start with local images​

docker-compose up --build

The assessment module manager API will be available at http://localhost:5100.

Start with remote images​

ATHENA_ENV_DIR=some-path \
ATHENA_DOMAIN=athena.example.com \
ATHENA_TLS_CERT_FILE=/path/to/server.fullchain.pem \
ATHENA_TLS_KEY_FILE=/path/to/server.privkey.pem \
docker compose -f docker-compose.prod.yml up

The ATHENA_ENV_DIR is expected to contain environment files assessment_module_manager.env and module_something.env. The ATHENA_DOMAIN environment variable is used to configure the domain name of the assessment module manager API. The assessment module manager API will be available at https://athena.example.com (depending on the ATHENA_DOMAIN environment variable).

The TLS variables must point to an existing full-chain certificate and its matching private key on the Docker host. Caddy mounts only these two files, read-only. They can also be set in the deployment directory's .env file instead of on the command line.

The TLS variables can point directly to pira-client's live/*.fullchain.pem and live/*.privkey.pem files, even when their names contain colons. The Compose bind mounts set create_host_path: false so Compose uses Docker's mount API for these paths. Both source files must already exist on the host.

When a certificate manager replaces a symlinked certificate, restart the Caddy container so Docker binds the new file (for example, docker restart athena-caddy-1 for the default Athena Compose project). Reloading Caddy alone does not refresh an individual file bind mount.