Add README

Explains what lives here vs. in each project, how dev and production
connect to it, and the shared-secret/PAT conventions consuming projects
follow.
This commit is contained in:
2026-09-21 21:11:56 +02:00
parent c35881f471
commit 58f3c5925b
+108
View File
@@ -0,0 +1,108 @@
# Infrastructure
The technology services shared by every project under `Documentos/`
(currently Musify, Ping and docker-manager): PostgreSQL, Zitadel (OIDC),
SeaweedFS (S3-compatible storage), RabbitMQ and Jaeger. None of these have
any business logic of their own, so instead of each project running (and
provisioning, and keeping in sync) its own copy, they run once, here.
Each project keeps its own independent, fast `docker compose up` for the
things that actually are its own: API/worker/gateway containers, database
migrations, its own OIDC apps and storage bucket (created against the shared
Zitadel/SeaweedFS below by its own `zitadel-init`/`seaweedfs-init` one-shot
jobs — see e.g. `Musify/MusifyM/deploy/compose.yml`). A project's dev stack
only needs this one already running; nothing here needs to know a consuming
project exists.
## What's here vs. what stays in each project
| Here (shared) | Stays in each project |
|---|---|
| PostgreSQL (one instance, one database per project) | The project's own EF Core migrations, connection pooling config |
| Zitadel (OIDC provider) | The project's own OIDC app registration (`zitadel-init`), JWT validation config |
| SeaweedFS (S3 storage) | The project's own bucket (`seaweedfs-init`), key layout |
| RabbitMQ (broker) | The project's own exchanges/queues/consumers |
| Jaeger (OTLP collector + UI) | The project's own instrumentation |
| — | LiveKit (Ping only — a single-project SFU with its own port range, not generalized) |
## Running it
```bash
cp .env.example .env
docker compose -f compose.yml -f compose.dev.yml up -d
```
That starts Postgres, Zitadel, SeaweedFS, RabbitMQ and Jaeger, with their
ports published to `localhost`. Add `--profile tools` to also start pgAdmin.
In production, the base `compose.yml` file **is** the production shape
already — no published ports, everything reachable only on the internal
`infra-net` network — so no overlay is needed:
```bash
cp .env.prod.example .env.prod
# fill in real values, then: chmod 600 .env.prod
docker compose --env-file .env.prod -f compose.yml up -d
```
A consuming project's own production compose joins `infra-net` as an
external network to reach `postgres` / `zitadel` / `seaweedfs` / `rabbitmq` /
`jaeger` by container name (see Musify's `deploy/compose.prod.yml`).
### Ports (development)
| Service | Port | Notes |
|---|---|---|
| PostgreSQL | `5432` | one instance, one database per project |
| Zitadel | `8080` | OIDC/OAuth2, console at `/ui/console` |
| SeaweedFS | `8333` / `8888` / `9333` | S3 API / filer / master |
| RabbitMQ | `5672` / `15672` | AMQP / management UI |
| Jaeger | `16686` / `4317` / `4318` | UI / OTLP gRPC / OTLP HTTP |
| pgAdmin (`--profile tools`) | `5050` | Postgres UI |
A consuming project reaches all of these at `host.docker.internal:<port>`
from inside its own containers — the same address the browser and the host
use — so the address is valid whichever way that project's own apps are
running (in Docker or from the IDE). No shared Docker network is needed in
development; that's what keeps every project's own `up` independent and
fast, with this stack as the only prerequisite.
### Shared secrets
`POSTGRES_USER`/`POSTGRES_PASSWORD`, `S3_ACCESS_KEY`/`S3_SECRET_KEY`,
`RABBITMQ_DEFAULT_USER`/`RABBITMQ_DEFAULT_PASS` and `PUBLIC_AUTH_URL` (i.e.
`http://host.docker.internal:${ZITADEL_EXTERNAL_PORT}` in dev) are the values
every consuming project's own `.env.example` copies and documents as "must
match this repo's `.env`" — this file is the source of truth for them.
### The Zitadel admin PAT
`zitadel-init` (in the compose file of whichever project runs it first)
writes a service-account personal access token to `zitadel/.output/admin-sa.pat`
on first init. Every consuming project mounts that same folder read-only —
by default at `../../../Infrastructure/zitadel/.output`, three levels up from
a `deploy/` folder — to call the Zitadel management API and create its own
project/apps. Not versioned; regenerated whenever the Zitadel volume is
reset.
## Resetting
```bash
docker compose -f compose.yml -f compose.dev.yml down # stop, keep data
docker compose -f compose.yml -f compose.dev.yml down -v # stop, wipe volumes
```
Wiping the volumes resets Zitadel (all projects/apps/users) and SeaweedFS
(all buckets) — every consuming project's own `zitadel-init`/`seaweedfs-init`
re-creates its piece on the next `up`, since both are idempotent.
## Layout
```
Infrastructure/
├─ compose.yml # postgres, zitadel, seaweedfs, rabbitmq, jaeger — the prod shape
├─ compose.dev.yml # dev overlay: publishes ports, adds pgAdmin
├─ .env.example / .env.prod.example
├─ postgres-init/ # creates the per-project application databases
└─ zitadel/.output/ # PAT written by Zitadel on init (not versioned)
```