Skip to content
Patrimoine
v9.1.0

Quick Start

Self-host Patrimoine in a few minutes with Podman or Docker Compose.

Prerequisites

Section titled “Prerequisites”
  • Podman 6+ (includes podman compose) or Docker with docker compose.
  • A backend/container/.env file copied from its template (see Environment Variables).

Install and start

Section titled “Install and start”
Terminal window
# 1. Create the data directory
mkdir -p ./data


# 2. Copy the backend environment template
cp backend/container/env.example backend/container/.env


# 3. Edit backend/container/.env — at minimum set JWT_SECRET
#    (generate one: python -c "import secrets; print(secrets.token_urlsafe(48))")


# 4. Build and start
podman compose --env-file backend/container/.env up --build

The frontend and website (docs) containers each have their own optional template (frontend/container/env.example, web/container/env.example) for changing the host ports; the defaults (8080 and 8082) work without them.

  • If you copy them, add one --env-file flag per file, for example --env-file backend/container/.env --env-file frontend/container/.env.
  • --env-file needs Compose 2.24 or later to be repeated; see Environment Variables for details.

The first build takes 2–5 minutes (backend + frontend images). Subsequent starts use cached layers and are near-instant.

First Run

Section titled “First Run”
  1. Open http://localhost:8080 in your browser. The website and manuals are at http://localhost:8082.
  2. If using local auth (OIDC_ENABLED unset or false) and REGISTRATION_ENABLED=true (it defaults to false: set it in backend/container/.env and restart before this step):
    • Click “Create account” and register your first user (this account becomes the admin).
    • Immediately disable registration by setting REGISTRATION_ENABLED=false in backend/container/.env and restarting:
      Terminal window
      podman compose down && podman compose --env-file backend/container/.env up -d
  3. If using OIDC, you will be redirected to your identity provider (e.g. Authentik) for authentication.

Next steps

Section titled “Next steps”