# kogut > Documentation for kogut: server, container and uptime monitoring in one binary, with one alert that says what broke. Every page below is plain Markdown. The whole documentation in one file: https://docs.kogut.dev/llms-full.txt ## Introduction - [What is kogut](https://docs.kogut.dev/introduction/what-is-kogut.md): Self-hosted server, container, and uptime monitoring in one Rust binary. - [Why one timeline](https://docs.kogut.dev/introduction/why-one-tool.md): How kogut connects uptime checks, host metrics, and deploys through services. - [Comparison](https://docs.kogut.dev/introduction/comparison.md): How kogut's scope and requirements differ from Uptime Kuma, Beszel, Checkmate, maintenant, Gatus, Umami, Tianji, Kener, openstatus, OneUptime, and Betterlytics. - [Resource use compared](https://docs.kogut.dev/introduction/resource-comparison.md): Memory, CPU, disk, and install steps of kogut and similar tools, measured with one workload on one machine. ## Getting started - [Quick start](https://docs.kogut.dev/getting-started/quick-start.md): Start kogut, connect a server, and test your notifications. - [First run](https://docs.kogut.dev/getting-started/first-run.md): Create the first account and complete the welcome screen. ## Installation - [Overview](https://docs.kogut.dev/installation/overview.md): The ways to install kogut. - [Linux](https://docs.kogut.dev/installation/linux.md): Install kogut on Linux and configure its systemd service. - [Docker](https://docs.kogut.dev/installation/docker.md): Run kogut as a single container with its data in a volume. - [Docker Compose](https://docs.kogut.dev/installation/docker-compose.md): Run kogut and an optional host agent with Docker Compose. - [Behind Caddy](https://docs.kogut.dev/installation/caddy.md): Serve the panel and status page over HTTPS with Caddy. - [Tailscale](https://docs.kogut.dev/installation/tailscale.md): Keep the panel off the internet. Run kogut on your tailnet with HTTPS from Tailscale. - [Dokploy](https://docs.kogut.dev/installation/dokploy.md): Deploy kogut on Dokploy with HTTPS and a persistent volume. - [Coolify](https://docs.kogut.dev/installation/coolify.md): Deploy kogut on Coolify with HTTPS and a persistent volume. - [CapRover](https://docs.kogut.dev/installation/caprover.md): Deploy kogut on CapRover with HTTPS and a persistent volume. - [Railway](https://docs.kogut.dev/installation/railway.md): Deploy kogut on Railway with a persistent volume. - [Render](https://docs.kogut.dev/installation/render.md): Deploy kogut on Render with a persistent disk. - [NixOS](https://docs.kogut.dev/installation/nixos.md): Configure the kogut server and agent with the NixOS module. - [Upgrading](https://docs.kogut.dev/installation/upgrading.md): Update kogut and recover from a failed upgrade. ## Coming from - [Uptime Kuma](https://docs.kogut.dev/coming-from/uptime-kuma.md): Map Uptime Kuma monitors and notifications to kogut.toml. - [Gatus](https://docs.kogut.dev/coming-from/gatus.md): Map Gatus endpoints, conditions, and channels to kogut.toml. - [Beszel](https://docs.kogut.dev/coming-from/beszel.md): Install kogut agents alongside Beszel, replace its network monitors and alerts, and recreate its setup from data.db. - [Umami](https://docs.kogut.dev/coming-from/umami.md): Replace an Umami snippet and keep compatible event calls. ## Agent - [Install the agent](https://docs.kogut.dev/agent/installing.md): Install and connect the agent on a Linux server. - [The agent in Docker](https://docs.kogut.dev/agent/docker.md): Run the agent in Docker or Podman. - [Permissions and the Docker socket](https://docs.kogut.dev/agent/permissions.md): Agent permissions, Docker socket access, and data sent to kogut. - [Discovery](https://docs.kogut.dev/agent/discovery.md): How the agent finds services and suggests checks. - [Command checks](https://docs.kogut.dev/agent/command-checks.md): Run your own programs on a host as checks, from a file only the host can change. ## Monitoring - [Checks](https://docs.kogut.dev/monitoring/checks.md): Check types, assertions, results, and scheduling. - [Heartbeats](https://docs.kogut.dev/monitoring/heartbeats.md): Detect missed or failed jobs with heartbeat pings. - [Internal services](https://docs.kogut.dev/monitoring/internal-services.md): Run checks from an agent inside your private network. - [Recipes](https://docs.kogut.dev/monitoring/recipes.md): Monitor a database that other services need, and home DNS through Pi-hole. - [Certificates and domains](https://docs.kogut.dev/monitoring/certificates-and-domains.md): How certificate and domain expiry affect checks and incidents. ## Web apps - [The tracking script](https://docs.kogut.dev/web-apps/tracking-script.md): Add page views, Web Vitals, and JavaScript errors to your site. - [Single-page apps](https://docs.kogut.dev/web-apps/single-page-apps.md): Page views, Web Vitals, and errors during client-side navigation. - [Web Vitals](https://docs.kogut.dev/web-apps/web-vitals.md): Browser performance metrics, thresholds, and where kogut reports them. - [JavaScript errors](https://docs.kogut.dev/web-apps/javascript-errors.md): Browser error capture, redaction, grouping, and reporting limits. - [Data kogut collects](https://docs.kogut.dev/web-apps/privacy.md): Stored analytics, visitor ids, retention, and outbound connections. - [Apps on Vercel, Netlify, or Cloudflare Pages](https://docs.kogut.dev/web-apps/hosted-apps.md): Check an app on Vercel, Netlify, or Cloudflare Pages from outside, mark its deploys, and watch its scheduled jobs. ## Deploys - [Deploy API](https://docs.kogut.dev/deploys/api.md): Request fields, authentication, and responses for recording deploys. - [Change API](https://docs.kogut.dev/deploys/changes.md): Request fields, responses, and merging for changes such as migrations, flag flips, and cache purges. - [GitHub](https://docs.kogut.dev/deploys/github.md): Record deploys from GitHub events through a signed webhook. - [Container images](https://docs.kogut.dev/deploys/containers.md): How kogut records a deploy when a container starts from a new image. - [Deploy reports](https://docs.kogut.dev/deploys/reports.md): Comparison windows, metrics, and verdicts for deploy reports. ## Alerts - [How alerts work](https://docs.kogut.dev/alerts/how-alerts-work.md): How signals become incidents and when kogut sends notifications. - [Notification channels](https://docs.kogut.dev/alerts/channels.md): Configure and test incident notifications. - [Silences and maintenance](https://docs.kogut.dev/alerts/silences-and-maintenance.md): Hold notifications for a service, a host, or everything during planned work. ## Incidents - [Likely causes](https://docs.kogut.dev/incidents/correlation.md): The rules and evidence kogut uses to rank likely causes of an incident. - [Copy for AI](https://docs.kogut.dev/incidents/copy-for-ai.md): Copy an incident as Markdown for an AI assistant. ## Status page - [Status page](https://docs.kogut.dev/status-page.md): Set up a public status page and optional email updates. ## When kogut itself is down - [kogut edge](https://docs.kogut.dev/high-availability/kogut-edge.md): An external watchdog on Cloudflare Workers. - [Heartbeat URL](https://docs.kogut.dev/high-availability/heartbeat-url.md): kogut calls an external service every minute, which alerts when the calls stop. - [Where to run kogut](https://docs.kogut.dev/high-availability/setups.md): Where to run kogut so monitoring survives an outage. - [Backups and restore](https://docs.kogut.dev/high-availability/backups.md): Back up the database offsite and restore it on another machine. ## Sign-in - [Passwords](https://docs.kogut.dev/sign-in/passwords.md): Local accounts with an email address and password, and how to turn them off. - [OpenID Connect](https://docs.kogut.dev/sign-in/openid-connect.md): Sign in to the panel through an OpenID Connect provider. - [Forward auth](https://docs.kogut.dev/sign-in/forward-auth.md): Sign in through a reverse proxy that already signs people in. - [Roles](https://docs.kogut.dev/sign-in/roles.md): Permissions for admins, viewers, and API tokens. ## Reference - [kogut.toml](https://docs.kogut.dev/reference/configuration.md): Configuration keys, types, defaults, and validation rules. - [Environment variables](https://docs.kogut.dev/reference/environment-variables.md): Every environment variable the server, the agent, and the install script read, with defaults. - [CLI](https://docs.kogut.dev/reference/cli.md): Commands, flags, and exit codes of the kogut binary. - [HTTP API](https://docs.kogut.dev/reference/http-api.md): The JSON API, the endpoints for agents, browsers, and CI, and authentication. - [MCP](https://docs.kogut.dev/reference/mcp.md): MCP transport, authentication, tools, and response format. ## Project - [Security](https://docs.kogut.dev/security.md): Vulnerability reporting, trust boundaries, and secret handling. - [FAQ](https://docs.kogut.dev/faq.md): Resources, data, platforms, agent security, sign-in, configuration, and extending kogut. - [Versioning](https://docs.kogut.dev/project/versioning.md): What can change between kogut versions, and which image tags to use. - [How kogut is built](https://docs.kogut.dev/project/development.md): Tests, CI, review, dependencies, releases, and AI tools.