vienalatina/README.md
Claude 6ac814475e
Add a members area: roles and an internal board
Everything on this site so far has been a file built from git. This is the
first component that runs code to answer a request and the first whose data
git does not hold, so the trade is stated in the README and the backup script
is not optional.

Roles are owner, admin and user. The owner is seeded once from BOARD_OWNER and
cannot be seeded again, because otherwise editing a compose file would be a
quieter way to take the top role than asking for it; ownership moves only by
transfer, inside the app. There is exactly one owner and a partial unique index
enforces it, so the invariant holds even when a handler is wrong. The owner is
beyond suspension and demotion by everyone, themselves included. Only the owner
makes admins; admins make users.

Sign-in goes through Gitea as a confidential OAuth client — the opposite of
Decap, which has to be public because it runs in the browser. The rule the
whole thing rests on is that a Gitea account is not a membership: entry needs
an active row in `members`, or every account on the instance is a member,
starting with the translations bot.

Admins can delete any post; nobody can edit anyone else's, admins included.
Taking a post down is visible to its author. Quietly rewriting it is not, and
an admin who could do that could leave a sentence attributed to someone who
never wrote it. The plan said admins could do both; this is the one place the
implementation departs from it.

Markdown renders with raw HTML disabled, which is the entire XSS defence and
the reason there is no sanitiser: the renderer emits only its own tags and
escapes the rest. The CSP carries no 'unsafe-inline', which makes an inline
onsubmit silently inert rather than broken, so the confirmation dialogs live in
a static file and a test fails any template that grows an inline handler.

GDPR is in scope rather than deferred: erasure removes the member row and moves
their authorship to a tombstone so the conversations around them still read,
and any member can download their own writing.

Verified: 63 checks pass, covering the membership gate, every role predicate, a
direct insert of a second owner being refused by the index, atomic ownership
transfer, CSRF, an offsite login redirect, script tags rendering as text, soft
deletes leaving both listings and exports, and the member screens rendering for
each role. Smoke-tested live: headers, both static assets, and the bare
/comunidad redirect that the Caddy matcher has to cover.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NizVpJ2dwzCbjCrTLCjeHn
2026-09-22 10:57:18 +00:00

201 lines
7.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Viena Latina
Self-hosted, trilingual site for the Latin American community in Vienna —
Hugo + Decap CMS + Gitea + Woodpecker CI on a single Hetzner CX22 (Falkenstein,
DE). Replaces the previous WordPress + Polylang + synchronous DeepL stack.
Translation is self-hosted too: OPUS-MT (CC-BY-4.0) runs on CPU via CTranslate2
in the pipeline image, with the models mounted from the host. No API key, no
quota, and no visitor or content data leaving the server.
```
Pablo ──► Decap CMS (/admin) ──commit──► Gitea ──webhook──► Woodpecker CI
▲ │
│ translate ──────┤
OAuth2 build (hugo) ─┤
│ deploy (rsync) ─┘
│ ▼
Members ──► /comunidad/ ────────────────┘ Caddy 2 serves /var/www/vienalatina.com
Flask + SQLite …and proxies /comunidad/ to Flask
```
Everything except `/comunidad/` is a static file built from git. The members
area is the one component that runs code to answer a request, and the one whose
data is not reproducible from the repository — see **Members area** below.
## Languages
Spanish, German (`/de/`) and Brazilian Portuguese (`/pt-br/`). **Any of the
three can be the authored original**; the other two are generated by CI as
reviewable git commits. Siblings pair by filename basename:
```
content/post/mi-articulo.es.md ← authored (no `translated_from`)
content/post/mi-articulo.de.md ← written by scripts/translate.py
content/post/mi-articulo.pt-br.md ← written by scripts/translate.py
```
A generated file carries `translated_from`, which is what stops CI translating
its own output back into a loop. Machine output is never treated as a source.
`manual_translation: true` means "hands off", on both sides:
- on an **authored original** — don't generate siblings for this post at all
- on a **generated sibling** — never overwrite it again
### Frontmatter contract
```yaml
---
title: "Mi artículo"
date: 2026-07-31
lang: es
manual_translation: false
categories: [Gastronomía] # taxonomy terms stay Spanish in every language
---
```
Generated siblings additionally carry `translated_from: es`.
## Translation flow
1. Publish in Decap → one git commit.
2. Gitea webhook fires Woodpecker.
3. `scripts/translate.py` diffs the push, finds changed authored files in any
language, generates the missing siblings, and pushes them back as a bot
commit (`translations@vienalatina.com`) marked `[skip-translate]`.
4. `hugo --minify` builds, `rsync --delete` deploys, Caddy serves.
Markup never reaches the model: code blocks and raw HTML pass through
untouched, and link targets, inline code and protected community terms
(`Grätzl`, `Naschmarkt`, …) are masked and verified to survive the round trip.
Small models drop those masks occasionally, so a failed round trip degrades in
steps rather than failing the publish:
1. mask markup **and** protected terms — the normal path;
2. if a term is lost, retry guarding only markup, and log that the term may now
be translated;
3. if markup itself is lost, leave that segment in the source language and warn.
A stray `⦅0⦆` or a mangled URL therefore never reaches a reader, and one
awkward proper noun never blocks a deploy.
Backfill anything missing siblings (after the WP migration, or for pages that
predate the pipeline):
```sh
python scripts/translate.py --backfill
```
## Translation engine
Built once on the server, and again only when changing models:
```sh
docker build -t vienalatina/translate:1 docker/translate
```
The image bakes in a pre-converted CTranslate2 build of M2M100 418M plus its
tokenizer, so a publish makes no network calls. Tunable via `MT_MODEL_DIR`,
`MT_TOKENIZER`, `MT_COMPUTE_TYPE` and `MT_THREADS`.
Swapping engines means writing one class against
`scripts/translation/provider.py` — nothing in the pipeline changes. Two
upgrades worth knowing about:
- **M2M100 1.2B** — same MIT licence and same code path, materially better
output, but ~2–2.5GB peak RAM. Needs an 8GB box (Hetzner CX32), not the CX22.
- **opus-mt-tc-big** — better still for these specific language pairs and the
only permissive option that handles Brazilian Portuguese distinctly (`>>pob<<`),
at the cost of CC-BY-4.0 attribution and one model per directed pair.
Do **not** build on NLLB-200 (CC-BY-NC, non-commercial) or LibreTranslate
(AGPL-3.0) if this stack is ever to be sold or offered as a service.
## Server setup
Full command-by-command walkthrough: **[docs/server-setup.md](docs/server-setup.md)**.
The Caddyfile and Docker Compose files it uses live in [infra/](infra/).
## Local development
```sh
hugo server # http://localhost:1313
```
## CI secrets (Woodpecker → repo settings → secrets)
| Secret | Value |
|---|---|
| `gitea_push_token` | Gitea token for the translations bot user, repo write access |
Translation needs no secret — the model is local.
The repo must be marked **trusted** in Woodpecker so the deploy step can
mount `/var/www/vienalatina.com`.
## Decap CMS
`static/admin/config.yml` uses the Gitea backend. Register an OAuth app in
Gitea admin (redirect URI `https://vienalatina.com/admin/`) and put its
client ID in `app_id`. The Decap JS bundle is downloaded at build time into
`static/admin/decap-cms.js` (gitignored) — zero third-party requests at
runtime.
## Members area
`apps/board/` — a small Flask app at `/comunidad/`, behind Caddy, holding roles
and an internal message board. Signed-in members only.
```
apps/board/
app.py factory, config, the CSRF and noindex hooks
auth.py Gitea OAuth2 (confidential client) and the membership gate
members.py roles, provisioning, ownership transfer, GDPR erasure/export
board.py threads and comments
render.py markdown with raw HTML disabled
schema.sql three tables and the one-owner index
tests/ pytest, 41 checks — `python3 -m pytest apps/board/tests`
```
Three things about it are load-bearing and easy to undo by accident:
- **A Gitea account is not a membership.** Login succeeds only for an active row
in `members`. Drop that check and every account on the instance gets in,
starting with the translations bot.
- **One owner, enforced by a partial unique index**, not by application code.
The owner cannot be suspended or demoted by anyone; stepping down means
transferring ownership to an admin.
- **`html=False` in `render.py`** is the entire XSS defence, and it works
because markdown-it then emits only its own tags. Turning it on means owning a
sanitiser allowlist forever.
Admins can delete anyone's post; **nobody can edit anyone else's**, admins
included. Removing a post is visible to its author, quietly rewriting it is not.
Its SQLite database is the only state on the server that git does not hold.
`scripts/backup-board.sh` takes a consistent snapshot nightly — see
`docs/server-setup.md` §11.
## GEO/SEO surfaces
- `hreflang` + `og:locale(:alternate)` + JSON-LD `BlogPosting`/`Blog` with
`inLanguage` — `themes/vienalatina/layouts/partials/seo-head.html`
- `robots.txt` AI-crawler allowlist — `static/robots.txt`
- `llms.txt` — generated at build time from `layouts/index.llms.txt`
- `sitemap.xml` — Hugo native, multilingual
## One-shot content migration
```sh
pip install requests html2text
python scripts/wp-to-hugo.py https://<old-wp-site>
```
Converts every WP post (with Polylang siblings) to
`content/post/<slug>.<lang>.md`, downloads images into `static/uploads/`,
and preserves existing slugs. Spot-check ~10 articles before committing.
Add Caddy 301s for WP URL patterns that don't map cleanly
(`?p=123`, `/categoria/...` → `/categories/...`).