Documentation site for Watchflare — a self-hosted host monitoring solution.
Live site: docs.watchflare.io
Guides, reference pages, and architecture concepts covering:
- Deploying the Hub with Docker Compose
- Enrolling agents on Linux and macOS
- Configuring alerts and notification channels
- Package inventory and vulnerability tracking
- PKI, TLS 1.3, and HMAC-SHA256 security model
- Configuration reference for all environment variables
Content is available in English and French.
| Tool | Role |
|---|---|
| Astro 6 | Static site generator |
| MDX | Markdown with component support |
| Pagefind | Full-text search |
| Native CSS | No framework, design tokens only |
Requires Node >= 22.12.0 and pnpm.
pnpm install
pnpm dev # http://localhost:4321
pnpm build # Production build → ./dist/
pnpm preview # Preview production buildSearch (
⌘K) only works after a build. Runpnpm dev:searchto develop with search enabled.
Deployed automatically to GitHub Pages on push to main via .github/workflows/deploy.yml.
Content lives in src/content/docs/. Each MDX file maps directly to a URL:
src/content/docs/en/hub/configuration.mdx → /hub/configuration/
src/content/docs/fr/hub/configuration.mdx → /fr/hub/configuration/
Frontmatter schema:
---
title: "Page Title"
description: "One-line description for SEO and search."
---See CLAUDE.md for full architecture notes.
MIT — documentation and site source code only. The Watchflare application itself is licensed under AGPL-3.0.