kawaiipunk
7df6e57d42
Update the relay config command in the Docker Compose guide to node:24-alpine, pin the Material preview image to 9.7.7, and correct the licence note (caption-local is MPL-2.0).
Captions Coop Wiki
Plain-language documentation for the self-hosted captions stack:
- Using captions — for speakers, producers, editors and streamers who never touch a terminal.
- Running your own stack — for admins and self-hosters: installing the speech-to-text service, the caption relay, per-site access, and public hosting.
It is a static MkDocs site using the
Material theme. Content is a
curated copy derived from the caption-local and captionninja projects; see
_sources.md for the mapping.
Build and preview
No install required, using Docker:
docker run --rm -it -p 8000:8000 -v "$PWD":/docs squidfunk/mkdocs-material:9.7.7 serve --dev-addr 0.0.0.0:8000
Or with a local Python environment:
python3 -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
mkdocs serve
Open http://localhost:8000.
Build the static site
mkdocs build --strict
The output is written to site/ (git-ignored).
Layout
mkdocs.yml site configuration and navigation
requirements.txt build dependency (mkdocs-material)
docs/ the pages (see mkdocs.yml nav)
docs/assets/ diagrams and screenshots
_sources.md where each page comes from, for re-syncing
Licence
Content is licensed CC BY-SA 4.0 — see LICENSE and
docs/about/licence.md. Source projects keep their own licences (MPL-2.0 for
caption-local, the relay and the browser helper).