audited

README

Audited - Audit log management for cloud-native applications.

Website | Documentation

Audit log management for cloud-native applications.

Installation

Docker Hub

The published image is getauditeddev/audited. Tags follow semver (1.2.3, 1.2, 1).

docker pull getauditeddev/audited:latest

Run the service (requires external Clickhouse):

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_PUBLIC_KEY="-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----" \
  -e ADT_JWT_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----" \
  -e ADT_ADMIN_EMAIL="admin@example.com" \
  -e ADT_ADMIN_PASSWORD="changeme" \
  getauditeddev/audited:latest

Variable	Required	Description
ADT_CLICKHOUSE_HOSTS	Yes	Comma-separated list of Clickhouse hosts (e.g. clickhouse:9000)
ADT_CLICKHOUSE_DBNAME	Yes	Clickhouse database name
ADT_CLICKHOUSE_USERNAME	Yes	Clickhouse username
ADT_CLICKHOUSE_PASSWORD	Yes	Clickhouse password
ADT_JWT_PUBLIC_KEY	Yes	ECDSA public key (PEM) for JWT verification
ADT_JWT_PRIVATE_KEY	Yes	ECDSA private key (PEM) for JWT signing
ADT_ADMIN_EMAIL	Yes	Email for the bootstrap admin user
ADT_ADMIN_PASSWORD	Yes	Password for the bootstrap admin user
ADT_HTTP_PORT	No	HTTP listen port (default 8080)
ADT_ALLOWED_CORS_ORIGIN	No	Comma-separated list of allowed CORS origins
ADT_LOG_LEVEL	No	Log verbosity (DEBUG, INFO, WARN, ERROR). Defaults to INFO

The service auto-applies migrations on startup, so no separate migration step is needed.

Client library overview

Language	Officially supported	API support
Go	⚠️	⚠️
Rust	⚠️	⚠️
Typescript	⚠️	⚠️
Java	⚠️	⚠️
PHP	⚠️	⚠️
C# (dotnet)	⚠️	⚠️
Python	⚠️	⚠️

License

Distributed under the AGPLv3 license. See LICENSE for more information.