Changeset 5a2cb69 in Klonkt for README.md

Timestamp:

06/21/2026 11:12:08 PM (3 months ago)

Author:

roboburr <roboburr@…>

Branches:

main

Children:

19b0727

Parents:

7bd97a6

Message:

feat(self-host): Docker-image + compose + quickstart-README

Dockerfile (multi-stage node:20-bookworm → -slim): native better-sqlite3 +
gebundelde ffmpeg (ffmpeg-static) uit builder, cwebp uit Debian 'webp', draait
als non-root, healthcheck. docker-compose met persistent storage-volume.
README: zelf-host-quickstart (Docker + Node + Caddy-HTTPS + eerste-keer-setup).
Op de VPS gebouwd + getest: build OK, GET / 200, DB auto-migreert, ffmpeg+cwebp
aanwezig, healthcheck healthy. Distributie (publiceren) wacht op GitHub-stap.

Co-Authored-By: Claude <noreply@…>

File:

• README.md (modified) (2 diffs)

README.md

@@ -9 +9 @@
 ## Filosofie
 
-- **Editorial feel.** Magazine-typografie (Fraunces + Literata + Plus Jakarta), royale spacing, 8 paletten waaronder Sage / Paper / Ocean / Forest / Stone / Midnight / Sunset / Cream. Light + dark per palette.
+- **Editorial feel.** Magazine-typografie (Fraunces + Literata + Plus Jakarta), royale spacing, 12 paletten (o.a. Sage, Paper, Ocean, Forest, Stone, Midnight, Sunset, Cream, Rose, Goud, Terracotta, Lilac). Light + dark per palette.
 - **App-feel waar het telt.** Geen full page reloads — htmx swaps + (binnenkort) View Transitions. Voelt als app, niet als website.
 - **Server-rendered.** Geen build step, geen SPA-tax. EJS + htmx + minimale Alpine.
@@ -26 +26 @@
 | **2.0 — E2EE DMs** | MLS protocol via `@openmls/openmls`, single-device first | ⚪ apart project |
 
-## Quick start
+## Zelf hosten
+
+Klonkt is een **Node-app** (geen PHP) — draai 'm op een VPS, in Docker of op een
+Node-hostingplatform. **Niet** op klassieke shared PHP-hosting. De database
+(SQLite) maakt zichzelf aan bij de eerste start; er is geen los installatiescript.
+
+### Optie A — Docker (aanbevolen)
+
+Alles (Node, ffmpeg, cwebp) zit in het image; je hoeft alleen Docker te hebben.
 
 ```bash
-npm install
+git clone <repo-url> klonkt && cd klonkt
 cp .env.example .env
-# zet SESSION_SECRET op iets random (>=32 chars in production)
-npm run migrate
-npm run dev
+# vul in .env minimaal in: SESSION_SECRET (>=32 random tekens) + PUBLIC_BASE_URL
+docker compose up -d
 ```
 
-Open http://localhost:3000
+De app draait nu op poort 3000. Alle data (database + geüploade media/audio)
+blijft bewaard in het `klonkt-data`-volume, ook na een update. Updaten:
+
+```bash
+git pull && docker compose up -d --build
+```
+
+### Optie B — direct met Node (Node 20+)
+
+```bash
+git clone <repo-url> klonkt && cd klonkt
+npm ci
+cp .env.example .env        # SESSION_SECRET + PUBLIC_BASE_URL invullen
+npm start                   # database wordt bij de eerste start aangemaakt
+```
+
+Open http://localhost:3000. Voor productie: zet 'm achter een procesmanager
+(pm2/systemd) zodat 'ie aanblijft. `cwebp` is optioneel (Debian/Ubuntu:
+`apt install webp`) voor WebP-afbeeldingen — ontbreekt 'ie, dan wordt het
+origineel bewaard. (`npm run dev` = watch-mode voor ontwikkeling.)
+
+### HTTPS (productie)
+
+Zet een reverse-proxy vóór de app voor TLS. Met **Caddy** (automatisch
+Let's Encrypt) volstaat één blok:
+
+```caddy
+jouwdomein.nl {
+    reverse_proxy localhost:3000
+    encode gzip zstd
+}
+```
+
+### Eerste keer
+
+Open je site en ga naar **`/auth/register`** — de **eerste gebruiker wordt
+automatisch beheerder**; daarna sluit registratie zich. Wachtwoord kwijt?
+`npm run reset-admin` (in Docker: `docker compose exec klonkt npm run reset-admin`).
 
 ## Stack