peter/siftlode
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
siftlode/deploy/README.md

50 lines
2.1 KiB
Markdown
Raw Normal View History

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.
2026-06-14 23:20:02 +02:00
# Deploying Siftlode to the public VPS
chore(deploy): hardened prod compose, rollout script, and CI for asgard docker-compose.prod.yml targets the public VPS: Postgres is never published, the app binds to 127.0.0.1 (Caddy proxies it), and every service has a memory/CPU cap plus no-new-privileges / cap_drop / read-only rootfs. deploy/deploy.sh rolls out main with a host-side build (migrations run via the entrypoint). CI type-checks and builds the frontend and byte-compiles the backend on every push to main.
2026-06-14 01:39:43 +02:00
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.
2026-06-14 23:20:02 +02:00
The public test instance runs on a VPS at **https://siftlode.b1fr0st.eu**, behind
chore(deploy): hardened prod compose, rollout script, and CI for asgard docker-compose.prod.yml targets the public VPS: Postgres is never published, the app binds to 127.0.0.1 (Caddy proxies it), and every service has a memory/CPU cap plus no-new-privileges / cap_drop / read-only rootfs. deploy/deploy.sh rolls out main with a host-side build (migrations run via the entrypoint). CI type-checks and builds the frontend and byte-compiles the backend on every push to main.
2026-06-14 01:39:43 +02:00
Caddy (which terminates TLS and reverse-proxies to the app on `127.0.0.1:8080`).
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.
2026-06-14 23:20:02 +02:00
## Layout on the host
chore(deploy): hardened prod compose, rollout script, and CI for asgard docker-compose.prod.yml targets the public VPS: Postgres is never published, the app binds to 127.0.0.1 (Caddy proxies it), and every service has a memory/CPU cap plus no-new-privileges / cap_drop / read-only rootfs. deploy/deploy.sh rolls out main with a host-side build (migrations run via the entrypoint). CI type-checks and builds the frontend and byte-compiles the backend on every push to main.
2026-06-14 01:39:43 +02:00
```
chore: rebrand Subfeed -> Siftlode Rename all user-facing references (UI wordmark Sift+lode, titles, app name, legal pages, onboarding wizard, emails, README/docs) and infra paths (/srv/subfeed -> /srv/siftlode, image tag, deploy script, backup filenames). Internal identifiers kept on purpose: Postgres user/db "subfeed", logger namespace, localStorage keys, and the subfeed_pgdata volume (renaming would orphan the migrated production data).
2026-06-14 04:40:22 +02:00
/srv/siftlode/
chore(deploy): hardened prod compose, rollout script, and CI for asgard docker-compose.prod.yml targets the public VPS: Postgres is never published, the app binds to 127.0.0.1 (Caddy proxies it), and every service has a memory/CPU cap plus no-new-privileges / cap_drop / read-only rootfs. deploy/deploy.sh rolls out main with a host-side build (migrations run via the entrypoint). CI type-checks and builds the frontend and byte-compiles the backend on every push to main.
2026-06-14 01:39:43 +02:00
src/ git clone of this repo (build context + compose file)
.env secrets, mode 0600 — NEVER committed
```
The hardened compose is [`docker-compose.prod.yml`](../docker-compose.prod.yml): Postgres is
never published, the app binds to localhost only, and every service is memory/CPU-capped for
the small VPS.
## First-time setup
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.
2026-06-14 23:20:02 +02:00
1. DNS `A`/`AAAA` for `siftlode` → the VPS (via your DNS provider).
chore: rebrand Subfeed -> Siftlode Rename all user-facing references (UI wordmark Sift+lode, titles, app name, legal pages, onboarding wizard, emails, README/docs) and infra paths (/srv/subfeed -> /srv/siftlode, image tag, deploy script, backup filenames). Internal identifiers kept on purpose: Postgres user/db "subfeed", logger namespace, localStorage keys, and the subfeed_pgdata volume (renaming would orphan the migrated production data).
2026-06-14 04:40:22 +02:00
2. Caddy vhost block `siftlode.b1fr0st.eu { reverse_proxy 127.0.0.1:8080 }` (+ the shared
chore(deploy): hardened prod compose, rollout script, and CI for asgard docker-compose.prod.yml targets the public VPS: Postgres is never published, the app binds to 127.0.0.1 (Caddy proxies it), and every service has a memory/CPU cap plus no-new-privileges / cap_drop / read-only rootfs. deploy/deploy.sh rolls out main with a host-side build (migrations run via the entrypoint). CI type-checks and builds the frontend and byte-compiles the backend on every push to main.
2026-06-14 01:39:43 +02:00
security-headers snippet), then reload Caddy.
chore: rebrand Subfeed -> Siftlode Rename all user-facing references (UI wordmark Sift+lode, titles, app name, legal pages, onboarding wizard, emails, README/docs) and infra paths (/srv/subfeed -> /srv/siftlode, image tag, deploy script, backup filenames). Internal identifiers kept on purpose: Postgres user/db "subfeed", logger namespace, localStorage keys, and the subfeed_pgdata volume (renaming would orphan the migrated production data).
2026-06-14 04:40:22 +02:00
3. `git clone` this repo to `/srv/siftlode/src`.
4. Create `/srv/siftlode/.env` (mode 0600) with the required keys — see
chore(deploy): hardened prod compose, rollout script, and CI for asgard docker-compose.prod.yml targets the public VPS: Postgres is never published, the app binds to 127.0.0.1 (Caddy proxies it), and every service has a memory/CPU cap plus no-new-privileges / cap_drop / read-only rootfs. deploy/deploy.sh rolls out main with a host-side build (migrations run via the entrypoint). CI type-checks and builds the frontend and byte-compiles the backend on every push to main.
2026-06-14 01:39:43 +02:00
[`.env.example`](../.env.example). Generate the secrets:
- `SECRET_KEY`: `python -c "import secrets; print(secrets.token_urlsafe(48))"`
- `TOKEN_ENCRYPTION_KEY`: `python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"`
- `POSTGRES_PASSWORD`: any long random string.
chore: rebrand Subfeed -> Siftlode Rename all user-facing references (UI wordmark Sift+lode, titles, app name, legal pages, onboarding wizard, emails, README/docs) and infra paths (/srv/subfeed -> /srv/siftlode, image tag, deploy script, backup filenames). Internal identifiers kept on purpose: Postgres user/db "subfeed", logger namespace, localStorage keys, and the subfeed_pgdata volume (renaming would orphan the migrated production data).
2026-06-14 04:40:22 +02:00
- `OAUTH_REDIRECT_URL=https://siftlode.b1fr0st.eu/auth/callback`
chore(deploy): hardened prod compose, rollout script, and CI for asgard docker-compose.prod.yml targets the public VPS: Postgres is never published, the app binds to 127.0.0.1 (Caddy proxies it), and every service has a memory/CPU cap plus no-new-privileges / cap_drop / read-only rootfs. deploy/deploy.sh rolls out main with a host-side build (migrations run via the entrypoint). CI type-checks and builds the frontend and byte-compiles the backend on every push to main.
2026-06-14 01:39:43 +02:00
- `GOOGLE_CLIENT_ID` / `GOOGLE_CLIENT_SECRET` / `YOUTUBE_API_KEY` from Google Cloud Console.
- `ALLOWED_EMAILS` / `ADMIN_EMAILS` = the invited Google accounts.
> The app refuses to start in production (an `https` redirect URL) if `SECRET_KEY` is the
> placeholder/too short or `TOKEN_ENCRYPTION_KEY` is missing — by design.
## Rolling out a new version
```bash
chore: rebrand Subfeed -> Siftlode Rename all user-facing references (UI wordmark Sift+lode, titles, app name, legal pages, onboarding wizard, emails, README/docs) and infra paths (/srv/subfeed -> /srv/siftlode, image tag, deploy script, backup filenames). Internal identifiers kept on purpose: Postgres user/db "subfeed", logger namespace, localStorage keys, and the subfeed_pgdata volume (renaming would orphan the migrated production data).
2026-06-14 04:40:22 +02:00
/srv/siftlode/src/deploy/deploy.sh
chore(deploy): hardened prod compose, rollout script, and CI for asgard docker-compose.prod.yml targets the public VPS: Postgres is never published, the app binds to 127.0.0.1 (Caddy proxies it), and every service has a memory/CPU cap plus no-new-privileges / cap_drop / read-only rootfs. deploy/deploy.sh rolls out main with a host-side build (migrations run via the entrypoint). CI type-checks and builds the frontend and byte-compiles the backend on every push to main.
2026-06-14 01:39:43 +02:00
```
It pulls `main`, rebuilds the image on the host, and restarts the stack (migrations run
automatically via the entrypoint's `alembic upgrade head`).
## CI
`.forgejo/workflows/ci.yml` type-checks/builds the frontend and byte-compiles the backend on
every push to `main`. It does not auto-deploy; rollout is the script above. (A future
improvement: a Forgejo-triggered or watchtower-based auto-rollout.)
Reference in a new issue Copy permalink