Home

Sentinel wiki

Sentinel is a lightweight, self-hosted monitoring stack: a Rust server with a built-in React dashboard, PostgreSQL storage, and a Windows agent that streams telemetry (windows, keys, URLs, activity, screen capture) over WebSockets.

Warning: This project was largely written with AI assistance and is intended for experimentation and testing, not as a hardened or supported product. Do not rely on it in production or for sensitive environments. Monitoring, remote control, and keystroke-related features carry inherent privacy and security implications; the codebase has not undergone professional security review and may contain bugs, weak defaults, or other issues that could expose data or systems. Use at your own risk.

Using this wiki (GitHub Wiki)

This site is the GitHub Wiki for the Sentinel repository. Navigation:

• Use the wiki Pages list, or the custom _Sidebar.md (shown beside the page on github.com when enabled).
• Links between pages use GitHub’s wiki form: [Page title](Page-file-name) — the part in parentheses must match the wiki page name (for example Home-Assistant, Environment-template).
• Screenshots for Features live only under the images/ folder in this wiki repo; image paths are written as images/filename.jpg next to each .md page.

Documentation

Page	Contents
Deployment	Docker Compose (default file in repo; build + Traefik snippets here), health checks
Configuration	Environment variables (server, security, Compose)
Environment template	Full .env-style block for advanced / non-Compose setups
Security	Vulnerability reporting, safe harbor, operator hardening
OIDC	OpenID Connect setup for dashboard login
Usage	Dashboard, Windows agent setup, HTTPS and cookies
Features	Feature-by-feature walkthrough of the dashboard and agent tabs (with screenshots)
Development	Local development, API and WebSocket overview, troubleshooting
Home Assistant	Send alert-rule matches to Home Assistant (blueprint + mobile notifications)

Components

Part	Role
Server (sentinel-server)	HTTP on port 9000 by default: dashboard static files, REST API, /ws/agent, /ws/view.
PostgreSQL	Agents, telemetry, audit, settings. Migrations run at server startup.
Agent (sentinel-agent)	Windows agent with a hidden Tauri settings window; connects to the server and receives remote control commands.

The Docker image builds the frontend; you do not run Node in production for the dashboard.

Repository

Source code, README (with screenshots), SECURITY.md, docker-compose.yml, and .env.example live in the main Sentinel repository. This wiki holds the extended operational guide, the full environment template page, and the Features walkthrough (screenshots in images/).