eblume/blumeops
1
1
Fork 0
Code Issues Pull requests Projects Releases 83 Packages Wiki Activity Actions
blumeops/docs/reference/services/kiwix.md
Erich Blume b197bd5f58 Adopt Dagger CI for docs build (Phase 2) (#157) 
## Summary

Migrates the docs build pipeline to Dagger (Phase 2 of the Dagger CI adoption plan).

- **Backfill `date-modified` frontmatter** on all 80 docs — Dagger's `--src=.` excludes `.git`, so Quartz can't use git history for page dates. Frontmatter dates work with or without git.
- **New `docs-check-frontmatter` mise task + pre-commit hook** — validates all docs have `title`, `tags`, and `date-modified`
- **New Dagger functions** — `build_changelog` (towncrier in Python container) and `build_docs` (chains changelog → Quartz build in Node container, returns tarball)
- **Simplified CI workflow** — the ~44-line inline Quartz build (clone, npm ci, build, tar, cleanup) is replaced by `dagger call build-docs`. Changelog step remains local on the runner since towncrier needs to modify the host working tree for the git commit.

### Design decisions

- **Towncrier runs twice in CI**: once inside Dagger (for the docs tarball) and once on the runner (for the git commit). This is intentional — Dagger's directory export is additive and can't delete the consumed changelog fragments from the host.
- **Artifact hosting stays on Forgejo Releases** (not migrated to Forgejo Packages as the plan doc originally suggested). That migration can happen independently.
- **`date-modified` frontmatter** preserved even though `build_changelog` installs git — the git there is only for towncrier's `git add` call, not for history. The local iteration story (`dagger call build-docs --src=. --version=dev` with uncommitted changes) depends on frontmatter dates.

### Local iteration

```bash
dagger call build-docs --src=. --version=dev export --path=./docs-dev.tar.gz
tar tf docs-dev.tar.gz | head -20
```

## Deployment and Testing

- [x] `dagger call build-docs --src=. --version=dev` produces valid 1.1MB tarball (149 HTML pages)
- [x] Pre-commit hooks pass (including new `docs-check-frontmatter`)
- [ ] Full `workflow_dispatch` run after merge

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Reviewed-on: https://forge.ops.eblu.me/eblume/blumeops/pulls/157
2026-02-11 16:33:16 -08:00

1.3 KiB
Raw Blame History

title date-modified tags
Kiwix 2026-02-07
service
knowledge

Kiwix

Offline Wikipedia and ZIM archive server.

Quick Reference

Property Value
URL https://kiwix.ops.eblu.me
Tailscale URL https://kiwix.tail8d86e.ts.net
Namespace kiwix
Image ghcr.io/kiwix/kiwix-serve:3.8.1
Storage NFS from [[sifaka

Architecture

Component Purpose
kiwix-serve Serves ZIM files on port 80
torrent-sync Sidecar syncing ZIM torrents to transmission
zim-watcher CronJob (hourly) to restart on new ZIMs

Configured Archives

  • Wikipedia top 1M English articles with images
  • Project Gutenberg (60,000+ books)
  • iFixit repair guides
  • Stack Exchange (SuperUser, Math, etc.)
  • LibreTexts textbooks
  • DevDocs developer documentation

Full list: argocd/manifests/kiwix/configmap-zim-torrents.yaml

Adding Archives

  1. Edit configmap-zim-torrents.yaml
  2. Add torrent URL from https://download.kiwix.org/zim/
  3. Sync: argocd app sync kiwix
  4. Torrent-sync adds to transmission
  5. zim-watcher restarts kiwix when download completes

Related