mantis docs

The Mintlify documentation source for privacykey/mantis, a self-hostable mantis key service.

Local preview

npm run dev

Mintlify serves the local preview at http://localhost:3000.

Validate

npm run validate
npm run check-links

The same checks run in GitHub Actions on pushes and pull requests.

Deploy with Mintlify

Connect privacykey/mantis-docs in the Mintlify dashboard, install the Mintlify GitHub App for this repository, and use / as the docs source path. Mintlify will deploy automatically from main after each push.

Getting started

• Getting started — CLI install → first key, in five steps
• Trying it locally — Docker evaluation, local-dev setup for contributors, benchmarks
• Use cases — defensive, detective, operational, and adversarial-research patterns

Deployment

• Overview & chooser — picking between local, tunnelled, and PaaS options
• Local Docker (option A)
• Docker + Tailscale (option B)
• Docker + Cloudflare Tunnel (option C)
• Railway (option E1)
• Fly.io (option E2)
• Render (option E3)
• Edge limits — rate limiting / DDoS / WAF guidance
• Backups — Postgres backup strategies
• mantis-edge worker — Cloudflare Worker (stateless) variant

Reference

• HTTP API — endpoints, response kinds, webhook payload shape
• Configuration — required and optional env vars
• Updating — update commands per component (server, CLI, edge worker, IoT helper)

Features

• File keys — Office/PDF/SVG/HTML/Markdown/email/calendar/contact artifacts, honey-directory ZIP, NFC label PDF, and Apple Wallet .pkpass
• Honey directory — 9-file .zip bundle for shared-drive deployment
• Host-event keys — shell / login / boot / wake / network installers, web embeds, NFC, smart-home, and the X-Mantis-* header reference
• Uptime Kuma integration — fan-out via Kuma's 80+ notification channels
• Reliability — hit dedup, retry queue, UA / bot parsing

Operating

• Single-user model — admin / non-admin behaviour
• Operational notes — key hashing, disabled-key responses, worker model
• Dev inbox — built-in webhook capture for local dev

Recipes

• Self-hosted apps — per-app recipes (Immich, Paperless, Joplin, Vaultwarden, dashboards, code hosts)

Architecture

• Project layout — directory map of the source tree