justin/provenance
1
0
Fork 0
Code Issues 173 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(deploy): add deploy/README.md and record the live instance

Browse Source 
The deploy/ directory had no entry point: how to stand the stack up lived
only in comments inside docker-compose.yml, and the maintainer's own
instance (provenance.paul.farm) was written down nowhere in the repo —
it had to be rediscovered from an unrelated repo's research log.

Add deploy/README.md covering the run/build commands, the LAN-push /
FQDN-pull registry split, the env-driven site address, and the Watchtower
+ one-shot-migrate caveat, plus a "maintainer's instance" section with
the URL, host, ingress and deploy path. Cross-reference it from CLAUDE.md.

Also note the live instance reports "env":"development" — its .env never
set APP_ENV=production. Informational only (app_env gates no behavior),
but .env.example now says to set it on a real deployment.

Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
Claude-Session: https://claude.ai/code/session_01BeRh7Vwq8j9s6jshaMUNCd
Signed-off-by: Justin Paul <[email protected]>
This commit is contained in:
justin
2026-09-20 22:43:33 -04:00
co-authored by Claude Opus 5
parent 7043532c3b
commit 05aa57c880
3 changed files with 53 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+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 # 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
/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)
/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.
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)
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.