From c19f4d9d31eac2dec748b0dde02d6333f01c9614 Mon Sep 17 00:00:00 2001 From: npeter83 Date: Sun, 14 Jun 2026 23:20:02 +0200 Subject: [PATCH] chore(repo): remove internal deployment plan, sanitize infra references Drop docs/deployment-plan.md (internal planning doc, kept out of the repo) and replace the personal lab DB IP and host names in the env/compose/deploy docs with generic placeholders, so the repo is safe to make public later. --- .forgejo/workflows/ci.yml | 2 +- deploy/README.md | 8 ++++---- deploy/deploy.sh | 4 ++-- docker-compose.localdev.yml | 2 +- docker-compose.prod.yml | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.forgejo/workflows/ci.yml b/.forgejo/workflows/ci.yml index 8db4df1..680e9e8 100644 --- a/.forgejo/workflows/ci.yml +++ b/.forgejo/workflows/ci.yml @@ -1,6 +1,6 @@ name: CI # Lightweight validation on every push to main: type-check + build the frontend and -# byte-compile the backend. The image build and rollout happen on the the VPS host +# byte-compile the backend. The image build and rollout happen on the deploy host # (see deploy/README.md); this just catches breakage early. on: push: diff --git a/deploy/README.md b/deploy/README.md index 825ad9b..96acf7a 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -1,9 +1,9 @@ -# Deploying Siftlode to the public VPS (the VPS) +# Deploying Siftlode to the public VPS -The public test instance runs on the the VPS VPS at **https://siftlode.b1fr0st.eu**, behind +The public test instance runs on a VPS at **https://siftlode.b1fr0st.eu**, behind Caddy (which terminates TLS and reverse-proxies to the app on `127.0.0.1:8080`). -## Layout on the VPS +## Layout on the host ``` /srv/siftlode/ @@ -17,7 +17,7 @@ the small VPS. ## First-time setup -1. DNS `A`/`AAAA` for `siftlode` → the VPS (done via the your DNS provider CLI). +1. DNS `A`/`AAAA` for `siftlode` → the VPS (via your DNS provider). 2. Caddy vhost block `siftlode.b1fr0st.eu { reverse_proxy 127.0.0.1:8080 }` (+ the shared security-headers snippet), then reload Caddy. 3. `git clone` this repo to `/srv/siftlode/src`. diff --git a/deploy/deploy.sh b/deploy/deploy.sh index 1e3690a..7918555 100755 --- a/deploy/deploy.sh +++ b/deploy/deploy.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash -# Roll out the latest main branch to the public the VPS instance. +# Roll out the latest main branch to the public VPS instance. # -# Layout on the VPS: +# Layout on the host: # /srv/siftlode/src git clone of this repo (build context + compose file) # /srv/siftlode/.env secrets, mode 0600 (never in git) # diff --git a/docker-compose.localdev.yml b/docker-compose.localdev.yml index 69b3dd3..9835770 100644 --- a/docker-compose.localdev.yml +++ b/docker-compose.localdev.yml @@ -1,4 +1,4 @@ -# Local development against the central (Proxmox) Postgres. +# Local development against the central Postgres (an always-on host that also runs the scheduler). # # Runs only the webapp/API — no local database, no scheduler — pointed at the shared # DB on the server. You see the same live data the 24/7 backfill is filling, and you diff --git a/docker-compose.prod.yml b/docker-compose.prod.yml index 1c9b513..215d2ff 100644 --- a/docker-compose.prod.yml +++ b/docker-compose.prod.yml @@ -1,4 +1,4 @@ -# Public VPS (the VPS) deployment — hardened, single-host, behind Caddy. +# Public VPS deployment — hardened, single-host, behind Caddy. # # Differs from docker-compose.server.yml (the home/LXC stack): the database is NEVER # published, the app binds to 127.0.0.1 only (Caddy terminates TLS and reverse-proxies it),