Changeset 7008b28 in Klonkt for README.md


Ignore:
Timestamp:
06/24/2026 06:41:03 PM (3 months ago)
Author:
Robin Genis <roboburr@…>
Branches:
main
Children:
0850535
Parents:
5410d4d
Message:

docs: update README — hub removed, fediverse-native (drop Google/comments mentions)

Solo (not solo/hub); replace 'Fans & comments via Google' with the fediverse
client; drop the dead GOOGLE_* env row + config/google reference.

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • README.md

    r5410d4d r7008b28  
    77## What it does
    88
    9 - **Solo or hub** — one personal site, or a label/collective with multiple
    10   makers under one roof.
     9- **Solo** — one personal site, entirely yours, on your own domain.
    1110- **Blog & photos** — posts with cover, tags, timeline or grid.
    1211- **Host your own music** — built-in audio player with tracks, albums and playlists.
    13 - **Fans & comments** — visitors sign in with Google (optional) and comment.
     12- **Fediverse-native** — your posts federate over **ActivityPub**: people follow,
     13  like, boost and reply from Mastodon (or another Klonkt). You can follow accounts,
     14  see a home timeline, and reply/like back — Klonkt is a full fediverse client.
    1415- **Grow**: newsletter, download-for-email, EPK/press kit, link-in-bio,
    1516  show calendar, and **cookie-free statistics**.
     
    2324Set `KLONKT_AUDIO=off` in `.env` to disable the entire audio/music feature.
    2425Klonkt then runs as a lightweight **blog/photo/EPK/links site without ffmpeg** —
    25 ideal for minimal hosting. Hub, Circles and external embeds
     26ideal for minimal hosting. Circles and external embeds
    2627(YouTube/SoundCloud/Spotify) keep working.
    2728
     
    8788```bash
    8889cp .env.example .env
    89 nano .env          # optional: PUBLIC_BASE_URL, plus SMTP / Google if you want them
     90nano .env          # optional: PUBLIC_BASE_URL, plus SMTP if you want it
    9091```
    9192
     
    149150| `SESSION_SECRET` | ✅ | Random string of ≥32 characters |
    150151| `PUBLIC_BASE_URL` | ✅ | Canonical URL (e.g. `https://yourdomain.com`) |
    151 | `GOOGLE_CLIENT_ID` / `_SECRET` / `_REDIRECT_URI` | — | Google login for listeners (your own OAuth client; never grants admin) |
    152152| `SMTP_HOST` / `_PORT` / `_USER` / `_PASS` / `_FROM` | — | Email for password reset + newsletter |
    153153| `KLONKT_DEFAULT_LANG` | — | Default language for visitors (`en`/`nl`/`de`) |
     
    169169src/
    170170├── server.js          # Express bootstrap + route mounting
    171 ├── config/            # database, mailer, google, feature flags
     171├── config/            # database, mailer, feature flags
    172172├── db/migrations/     # SQLite schema (001-init.sql)
    173173├── middleware/        # site resolving, auth, render (htmx-aware)
Note: See TracChangeset for help on using the changeset viewer.