Files

Deployment

  1. Create the Influx token offline:
echo "apiv3_$(openssl rand -base64 64 | tr -d '+/=')" > secrets/admin-token.txt
  1. Copy .env.template to .env and change/add value if necessary:
cp .env.template .env
  1. Deploy the stack:
docker compose up -d

Development

Swagger Documentation

To ensure the Swagger documentation is always up to date, we use pre-commit. It runs swag init automatically before each commit if any Go files in db/src have changed.

To install the hooks:

pre-commit install

Alternatively, you can run it manually:

pre-commit run --all-files

or from db/src:

swag init

Traefik

A traefik config file is available on traefik.yml. It can be used with an OIDC provider (Authentik in our case) to control access to the database explorer.