Install
Peculium is a classic self-hosted app, and installing it is pull-only: nothing is ever built on your machine. The official images are public on GitHub Container Registry — anonymous pulls, no login, no token — for linux/amd64and linux/arm64.
Prerequisites
- Podman (or Docker) with Compose support, on any Linux box, NAS or VM.
- A machine on amd64 orarm64 — the images are multi-arch.
The images are published on ghcr.io/alv67/peculium-*(frontend, backend, worker, python-service, secrets-init) starting with thev1.0.0 release.
Step 1 — Download the stack files
Grab the release compose file and the environment template:
curl -O https://raw.githubusercontent.com/alv67/peculium/main/docker-compose.yml
curl -O https://raw.githubusercontent.com/alv67/peculium/main/.env.example
cp .env.example .env # optionalStep 2 — Configure (optional)
Everything has sensible defaults: you can skip .enventirely and the stack boots with auto-generated secrets. Edit it only if you want to change something:
| Key | Default | Notes |
|---|---|---|
| PECULIUM_VERSION | latest | Image tag for every Peculium service — pin a release (e.g. v1.0.0) to keep the stack on a fixed version. |
| PECULIUM_HTTP_PORT | 3000 | Host port the web UI is published on. |
| POSTGRES_PASSWORD | (empty) | Leave empty to auto-generate a random one on first boot. |
| PECULIUM_JWT_SECRET | (empty) | Leave empty to auto-generate a random one on first boot. Changing it logs everyone out. |
Step 3 — Start
podman-compose up -dWeb UI, API, worker, price service, PostgreSQL and Redis come up together; the firstupalso generates and stores your secrets (see notes below).
Step 4 — Open Peculium
Point your browser to http://localhost:3000and create the first account. From there, add assets and portfolios and let Peculium pull quotes.
Good to know
- Back up the secrets volume.On first boot the database password and the JWT secret are auto-generated and persisted in the
peculium_secretsvolume, then reused on every restart — if you lose that volume you lose access to the database. - PostgreSQL and Redis are notexposed on the host; only the web UI port is published (the backend is reachable through the frontend's
/api/proxy). - To update, pull the new tag and restart in place:
PECULIUM_VERSION=vX.Y.Z podman-compose pull && podman-compose up -d
Something not working? Open an issue on GitHub.