Docs

INSTALL.md

INSTALL

Requirements

  • Docker Engine + Docker Compose plugin
  • 2 GB RAM minimum (4 GB recommended)

Linux (minimal: web + Postgres)

cp .env.example .env
docker compose up -d --build

Tip: set DJANGO_DEBUG=true in .env when running the minimal profile so Django serves static files without Caddy.

Windows (PowerShell, minimal)

Copy-Item .env.example .env
.\scripts\dev.ps1

Full stack (adds Redis, worker, Caddy TLS)

docker compose --profile full up -d --build

First run

  • Visit /setup if no users exist
  • First created account becomes admin and user id=1
  • The email on user id=1 is shown publicly on the Terms, Privacy, and Cookies pages by default
  • Choose theme preset (default or dekcx) in setup
  • Configure branding, theme colors, legal docs, and footer links in /admin
  • In admin, Site Branding has an Apply Preset Palette checkbox to load preset colors quickly while keeping manual color control

Backups

Linux:

./scripts/backup.sh
./scripts/restore-test.sh

PowerShell:

.\scripts\backup.ps1
.\scripts\restore-test.ps1

E2E smoke run

Linux:

./scripts/e2e-smoke.sh

PowerShell:

.\scripts\e2e-smoke.ps1