Installation

The recommended deployment uses Docker Compose with PostgreSQL and Redis.

Requirements

Docker Engine, Docker Compose, persistent storage, and an HTTPS reverse proxy for public installations.

Quick start

git clone https://github.com/cheinisch/fahrtenbuch.git
cd fahrtenbuch
cp .env.example .env

Edit .env before starting. Configure POSTGRES_PASSWORD, JWT_SECRET, TOTP_ENCRYPTION_KEY, DEFAULT_ADMIN_USERNAME, DEFAULT_ADMIN_EMAIL, DEFAULT_ADMIN_PASSWORD, PUBLIC_BASE_URL, CORS_ORIGIN, WEBAUTHN_RP_ID, and WEBAUTHN_ORIGIN. Choose IMAGE_TAG as appropriate.

Use the current environment template as the definitive configuration reference.

docker compose up -d
docker compose ps

The application listens on port 3000 by default. Open http://localhost:3000 locally, or use your public HTTPS domain.

Docker Compose creates named volumes automatically. Never run docker compose down -v for a routine restart: it can delete persistent data.