Getting Started with Groom Book

← Back to Home

Groom Book can be run on a single server with Docker Compose or in a production Kubernetes cluster. Choose the path that fits your needs.

Docker Compose (Recommended for Single Server)

The fastest way to get Groom Book running. This starts PostgreSQL, runs migrations, and serves both the API and web UI.

$ git clone https://github.com/groombook/groombook.git
$ cd groombook
$ docker compose up --build
Service URL
Web UI http://localhost:8080
API http://localhost:3000
⚠️ Security Note: The default docker-compose.yml sets AUTH_DISABLED=true so you can explore without configuring OIDC. Disable this in any internet-facing deployment.

Production Configuration

Copy .env.example to .env and configure:

Variable Description
DATABASE_URL PostgreSQL connection string
AUTH_DISABLED Set to false in production
OIDC_ISSUER Authentik issuer URL
OIDC_CLIENT_ID OIDC client ID
CORSI_ORIGIN Public URL of the web frontend

Kubernetes (Production-Grade)

For production deployments with high availability, see the groombook/infra repository for Kubernetes manifests and Flux GitOps configuration.

Groom Book is deployed using:

Quick Links