Installation

Docker

Pull the image

The published image is getauditeddev/audited. Tags follow semver (1.2.3, 1.2, 1), so you can pin to whichever level of stability you need.

docker pull getauditeddev/audited:latest

Run the service

Run the container, passing your Clickhouse connection, bootstrap admin credentials, and JWT secret as environment variables. This example uses HMAC signing:

docker run -p 8080:8080 \
  -e ADT_CLICKHOUSE_HOSTS="clickhouse:9000" \
  -e ADT_CLICKHOUSE_DBNAME="default" \
  -e ADT_CLICKHOUSE_USERNAME="default" \
  -e ADT_CLICKHOUSE_PASSWORD="password" \
  -e ADT_HTTP_PORT=8080 \
  -e ADT_JWT_SECRET="a-long-random-secret" \
  -e ADT_ADMIN_EMAIL="admin@example.com" \
  -e ADT_ADMIN_PASSWORD="changeme" \
  getauditeddev/audited:latest

Replace the placeholder values with your own. Audited connects to Clickhouse, applies any pending migrations automatically, and starts serving on port 8080.

Kubernetes