Home

Marmot documentation

Marmot is a self-hosted status monitor for teams: Uptime Kuma's monitoring and alerting, kan.bn-style organizations, built on Payload CMS 3 and Next.js. These pages are written for the people who run it, the people who use it and the people who change it. Pages marked (landing in the current release) describe features whose pull requests are merging alongside this documentation.

Run it

Page	What it covers
Getting started	Docker compose quick start, the first-run setup wizard, your first monitor and your first status page.
Configuration	Every environment variable (grouped, with defaults and the process that reads it), instance settings, first-run and realtime.
Deployment	Caddy auto-TLS, running behind nginx/Traefik, MongoDB, scaling workers, backups and restore, upgrades, single-container mode.
Kubernetes	The Helm chart: per-role Deployments, migration Job, ingress and /socket.io, bundled or external databases, probe agents.
Single sign-on	Generic OIDC, GitHub and Google sign-in, per-organization OIDC/SAML connections with verified domains, linked accounts.
Security	Hardening checklist: TLS, trusted proxies, rate limiting, security headers, audit log and admin access.
Telemetry	What the opt-in analytics collect and how consent works.
Billing	The plan/entitlement scaffold for hosted offerings; off on self-hosted installs.
Demo mode	A self-resetting demo instance: seeded data, simulated checks, nothing sent, scheduled resets.

Use it

Page	What it covers
Monitors	Monitor concepts: types, intervals and retries, groups, push monitors, pausing and cloning.
Monitor types	Field-by-field reference for every monitor type.
Probe locations	Checks from your own networks: self-hosted probe agents, outbound HTTPS only.
Notifications	Notification channels, the delivery pipeline, message templates and the provider reference.
Status pages	Public status pages, incidents, custom domains and the public JSON/RSS endpoints.
Maintenance	Maintenance windows and how they silence alerts.
Organizations and members	Roles and permissions, invitations, invite links, ownership transfer, account settings.
Integrations	Status badges, the push endpoint, Prometheus metrics, organization API keys and outbound event webhooks.
MCP server for AI agents	Connect Claude, Cursor and other MCP clients with an API key; the tools and how they map onto the management API.
Import and export	Importing an Uptime Kuma backup or a Marmot export, and exporting an organization.
CLI and monitors as code	The marmot command line: status from the terminal, monitors in YAML with plan/apply, GitOps.
GitHub Action	Run Marmot's checks after a deploy and fail the job on a broken endpoint; plan and apply monitors as code from workflows.

Change it

Page	What it covers
Architecture	Processes, polling engine, time-series storage, notifications pipeline, realtime, RBAC.
Development	Local setup with or without Docker, the three processes, tests, migrations, server bundles.
Release checklist	What to verify before tagging a version.
Comparison	Feature-by-feature parity with Uptime Kuma and the kan.bn-inspired team features.
Contributing	Workflow, commit conventions, how to add a monitor type or a notification provider.
Security policy	How to report a vulnerability.

Found a mistake? Documentation lives next to the code in docs/ and is published to the GitHub wiki on every push to main; open a pull request with the docs(docs): … prefix.