-
Notifications
You must be signed in to change notification settings - Fork 2
Home
Welcome to the Knightwatch documentation. Knightwatch is a lightweight, real-time browser-based dashboard for monitoring system performance, live screenshots, and process activity on a remote or local machine.
For installation and basic usage, see the README.
Complete reference for all HTTP endpoints exposed by the Knightwatch server, including request formats and response shapes for every route.
How to track root processes and their child trees, the work-done detection mechanic, available endpoints, and the webhook and Telegram events it emits.
How to enable hardware telemetry (CPU, memory, disks, network, battery, thermals), default alert thresholds, available endpoints, and the webhook and Telegram events it emits.
Linux-only unit tracking via D-Bus. Covers available endpoints, webhook events, and Telegram notifications for unit state changes.
How to enable Docker container monitoring, available endpoints, container command endpoints, and the webhook and Telegram events it emits.
How to set up and enable the Telegram bot, and a full list of push notifications it sends for process, system resource, and systemd events.
🪝 Webhooks
Payload format, retry behavior, and a complete catalogue of all events emitted by the process monitor, system resources monitor, and systemd monitor.
How to enable API authentication and manage users — adding, removing, listing, and linking Telegram accounts.
How to store and manage settings (Telegram token, webhook URLs) using the config subcommand so they persist across runs.
How to persist CLI flag defaults to a file so they apply automatically when running as a service, and how to override them at runtime.
⚙️ Events
Events sent by API and Webhook.