# cairn documentation

Start here, every page is one click away. To see cairn running before
reading anything: <https://cairn.libresoftware.cloud>.

## First steps

- [Getting started](getting-started.md): zero to a served page in five minutes.
- [Upgrading](upgrading.md): what a new version can refuse, each message and its fix.

## Configuration

- [Services](configuration/services.md): the cards: every key, defaults, examples.
- [Site](configuration/site.md): title, welcome note, header links, footer, hosted legal pages.
- [Writing text](configuration/text.md): the long fields take CommonMark, minus raw HTML.
- [Theming](configuration/theming.md): accent color, dark mode, `custom.css`.
- [Languages](configuration/i18n.md): locales, fallbacks, UI string overrides.

## Deployment

- [Docker Compose](deployment/docker-compose.md): the hardened reference setup.
- [Podman](deployment/podman.md): the same container as a systemd quadlet.
- [Bare binary](deployment/binary.md): no container, a hardened systemd unit.
- [Kubernetes](deployment/kubernetes.md): a ConfigMap, a Deployment, no volume.
- [Helm](deployment/helm.md): the same four objects, and your Ingress from values.
- [Air-gapped](deployment/airgap.md): what crosses the white station, and the icons that catch everyone.
- [Static hosting](deployment/static.md): `-export` writes the site as files for Cloudflare Pages, Netlify or Apache.
- [Reverse proxies](deployment/reverse-proxies.md): Caddy, Traefik, Nginx, Pangolin.

## Recipes

- [Icons](recipes/icons.md): dashboard-icons slugs, selfh.st, your own files.
- [Multiple files](recipes/multiple-files.md): one YAML per category.
- [Status page](recipes/status.md): pairing cairn with Gatus, Uptime Kuma or any
  other monitor, and [which ones have been read live](recipes/status.md#which-monitors-cairn-reads).
- [Coming from Homer or Homepage](recipes/migration.md): your config maps over.

## Reference

- [Configuration reference](reference.md): every key, flag and endpoint on one page.
- [FAQ](faq.md): tracking, JavaScript, auth, cookies, breakage.
- [Comparison](comparison.md): when Homer or Homepage fit better.