1 Deployment Architecture
Forgejo Actions edited this page 2026-09-25 17:00:22 +00:00

Deployment Architecture

The official target is a single Docker Compose stack on a Linux host that is reachable from localhost, a private LAN, a VPN, or a private overlay network. Hostile exposure to the public internet is explicitly not part of the baseline.

deploy/compose.yaml defines eight first-class services:

  • memories-postgres — PostgreSQL with PostGIS and pgvector.
  • memories-api — the Core API and the authoritative application state.
  • memories-web — the SvelteKit UI and public web entrypoint, which proxies uploads to the API.
  • worker-media, worker-ml, worker-plants, worker-people, and worker-converter — the five workers.

Only clients talk to the API. Workers never access PostgreSQL directly and never write final stored-object or derived paths themselves. See Workers for what each one does.

The reverse proxy is not part of the stack. Compose ships Traefik labels for an external proxy network, so you can put your own reverse proxy in front; ADR 0008 treats reverse proxies as optional helpers. Traefik is not deployed or bundled by Memories.

First run: copy deploy/example.env to .env, replace the change-me secrets, set MEMORIES_LIBRARY_PATH to an absolute host path, build memories-postgres first, then run docker compose up --build. Default local ports are web 13000 and API 18080.

Details