docs(deploy): deploy/README.md + record the live instance #255

Merged
claude merged 1 commits from deploy-docs-live-instance into main 2026-09-20 22:43:47 -04:00
3 changed files with 53 additions and 1 deletions
Showing only changes of commit 05aa57c880 - Show all commits
+3 -1
View File
@@ -41,7 +41,7 @@ Pick libraries consistent with this stack. If you introduce a significant depend
/ # docs and project meta (this file, README, LICENSE, COC, CONTRIBUTING) / # docs and project meta (this file, README, LICENSE, COC, CONTRIBUTING)
/docs # PRD.md, ARCHITECTURE.md /docs # PRD.md, ARCHITECTURE.md
/backend # FastAPI service (uv-managed). app/{api/v1, services (+ privacy engine), repositories, models, schemas, integrations (auth, mailer, objectstore, models = pluggable LLM/embedding providers), core}; migrations/ = Alembic /backend # FastAPI service (uv-managed). app/{api/v1, services (+ privacy engine), repositories, models, schemas, integrations (auth, mailer, objectstore, models = pluggable LLM/embedding providers), core}; migrations/ = Alembic
/deploy # docker-compose.yml (+ docker-compose.dev.yml), Caddyfile, .env.example, backup.sh + BACKUP.md (one-command pg_dump + MinIO backup) — the self-host stack /deploy # README.md (how to run it + the live instance), docker-compose.yml (+ docker-compose.dev.yml), Caddyfile, .env.example, backup.sh + BACKUP.md (one-command pg_dump + MinIO backup) — the self-host stack
/.gitea/workflows # Gitea Actions CI (build images → Gitea registry) /.gitea/workflows # Gitea Actions CI (build images → Gitea registry)
/frontend # Next.js (App Router, TS, Tailwind, shadcn-style UI). app/ pages, lib/api generated OpenAPI client, components/ui /frontend # Next.js (App Router, TS, Tailwind, shadcn-style UI). app/ pages, lib/api generated OpenAPI client, components/ui
``` ```
@@ -113,6 +113,8 @@ Wordmark is a serif (heritage register); UI body/secondary text is a humanist sa
Maintainer: **Justin Paul** (`[email protected]`). This deployment targets a home lab: Authentik at `auth.jpaul.io` for auth, `mail.jpaul.io` for SMTP, behind Caddy + Cloudflare Tunnel. Maintainer: **Justin Paul** (`[email protected]`). This deployment targets a home lab: Authentik at `auth.jpaul.io` for auth, `mail.jpaul.io` for SMTP, behind Caddy + Cloudflare Tunnel.
The maintainer's live instance is **<https://provenance.paul.farm>** (host `192.168.0.2`, owner account `[email protected]`) — see [deploy/README.md](deploy/README.md) for its specifics. The code itself hard-codes no hostname; the site address is env-driven.
## Open questions (don't assume answers) ## Open questions (don't assume answers)
Parked in PRD §11 and ARCHITECTURE §14: telemetry (opt-in anonymous vs none), embeddings provider for matching, DNA as future-phase vs permanent non-goal, native mobile timing, hosted-SaaS model, queue backend default (Postgres vs Redis), and PostGIS adoption. If a task depends on one of these, surface the dependency instead of picking silently. Parked in PRD §11 and ARCHITECTURE §14: telemetry (opt-in anonymous vs none), embeddings provider for matching, DNA as future-phase vs permanent non-goal, native mobile timing, hosted-SaaS model, queue backend default (Postgres vs Redis), and PostGIS adoption. If a task depends on one of these, surface the dependency instead of picking silently.
+2
View File
@@ -2,6 +2,8 @@
# Everything is twelve-factor; no endpoints or secrets live in code. # Everything is twelve-factor; no endpoints or secrets live in code.
# --- Core --- # --- Core ---
# development | production. Set to `production` on a real deployment — it is
# reported by /health and the owner /admin surface.
APP_ENV=development APP_ENV=development
# Instance owner / operator. The account(s) whose email is named here get # Instance owner / operator. The account(s) whose email is named here get
+48
View File
@@ -0,0 +1,48 @@
# Deploying Provenance
This directory is the self-host stack: `docker-compose.yml` (Postgres + MinIO +
Caddy + backend + worker + frontend, with a one-shot Alembic `migrate` job),
`Caddyfile` for the edge, `.env.example` for configuration, and `backup.sh` /
[BACKUP.md](BACKUP.md) for backup and restore.
## Run it
```bash
cp .env.example .env # fill in secrets, OWNER_EMAIL, APP_ENV=production
docker compose up -d # pulls backend/frontend images from git.jpaul.io
```
Images are **pulled** from the public `git.jpaul.io` registry (CI pushes them to
the LAN endpoint `192.168.0.2:1234`; see CLAUDE.md). To build locally instead,
layer the dev override:
```bash
docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build
```
Caddy's site address is env-driven (`PROVENANCE_SITE_ADDRESS`): `:80` for plain
HTTP behind a tunnel or for `http://localhost`, or a domain for automatic HTTPS.
Nothing in this repo hard-codes a hostname.
Note that a Watchtower image swap recreates only the long-running containers,
not the one-shot `migrate` job — pair auto-deploys with a `docker compose up`
so migrations re-run.
## The maintainer's instance
Justin's own deployment — the one holding the Paul/Reier family tree:
| | |
|---|---|
| **URL** | <https://provenance.paul.farm> |
| **Host** | `192.168.0.2` (the fleet host; also the LAN registry endpoint) |
| **Ingress** | Cloudflare Tunnel → `caddy:80`; Cloudflare terminates TLS, so `PROVENANCE_SITE_ADDRESS` stays `:80` |
| **Owner account** | `[email protected]` |
| **Deploys** | CI builds on merge to `main`; the host's global Watchtower swaps the `test-main` images |
Health check (no auth): `curl https://provenance.paul.farm/health`.
Known drift: that endpoint currently reports `"env":"development"` — the host's
`.env` never set `APP_ENV=production`. It is informational only (`app_env` is
reported by `/health` and `/api/v1/admin`; it gates no behavior), but it should
be corrected on the host.