Changeset 09ee2bd in Klonkt for README.md

Timestamp:

06/23/2026 09:25:42 PM (3 months ago)

Author:

Robin Genis <roboburr@…>

Branches:

main

Children:

f99bbe8

Parents:

45271b7

Message:

feat: auto-generate SESSION_SECRET if not set (zero-config Docker/manual)

If SESSION_SECRET is missing, generate a strong one on first boot and persist it
to <dataDir>/.session-secret (stable across restarts/updates). Env var still wins.
PUBLIC_BASE_URL already falls back to the request host. So Docker (B) and manual
(C) installs now run with no required .env editing. Docs + .env.example updated;
docker-compose comment translated to English.

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

File:

• README.md (modified) (2 diffs)

README.md

@@ -58 +58 @@
 git clone https://github.com/roboburr/klonkt.git
 cd klonkt
-cp .env.example .env          # then edit .env: set SESSION_SECRET + PUBLIC_BASE_URL
+cp .env.example .env          # works as-is; optionally set PUBLIC_BASE_URL to your domain
 docker compose up -d
 ```
 
+`SESSION_SECRET` is auto-generated on first start, so the defaults work as-is.
 Klonkt runs on port 3000 — put your own reverse proxy in front for HTTPS (see
 step 5 of Option C). Data (database + media) stays in the `klonkt-data` volume,
@@ -79 +80 @@
 ```
 
-**2. Create your config** — copy the example and edit it; at minimum set a long
-random `SESSION_SECRET` and your `PUBLIC_BASE_URL` (e.g. `https://yourdomain.com`):
+**2. Create your config.** `SESSION_SECRET` (the key that signs login cookies) is
+auto-generated on first start, so this works as-is. For production, set
+`PUBLIC_BASE_URL` to your site address (e.g. `https://yourdomain.com`) so email &
+login links are correct:
 
 ```bash
 cp .env.example .env
-nano .env
+nano .env          # optional: PUBLIC_BASE_URL, plus SMTP / Google if you want them
 ```