Home

Knightwatch Wiki

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](https://github.com/YofaGh/knightwatch#readme).

---

Pages

🔌 [API Reference](API-Reference)

Complete reference for all HTTP endpoints exposed by the Knightwatch server, including request formats and response shapes for every route.

📊 [System Resources Monitor](System-Resources-Monitor)

How to enable hardware telemetry (CPU, memory, disks, network, battery, thermals), default alert thresholds, available endpoints, and the webhook and Telegram events it emits.

⚙️ [Systemd Monitor](Systemd-Monitor)

Linux-only unit tracking via D-Bus. Covers available endpoints, webhook events, and Telegram notifications for unit state changes.

🤖 [Telegram Bot](Telegram-Bot)

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](Webhooks)

Payload format, retry behavior, and a complete catalogue of all events emitted by the process monitor, system resources monitor, and systemd monitor.

🔒 [Authentication](Authentication)

How to enable API authentication and manage users — adding, removing, listing, and linking Telegram accounts.

💾 [Persistent Configuration](Persistent-Configuration)

How to store and manage settings (Telegram token, webhook URLs) using the config subcommand so they persist across runs.