-
Notifications
You must be signed in to change notification settings - Fork 0
Home
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, optional 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.
| Page | Contents |
|---|---|
| Deployment | Requirements, Docker Compose (direct port vs Traefik), health checks |
| Configuration | Environment variables (server, security, Compose) |
| OIDC | OpenID Connect setup for dashboard login |
| Usage | Dashboard, Windows agent setup, HTTPS and cookies |
| Development | Local development, API and WebSocket overview, troubleshooting |
| 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.
Source code and README live in the main GitHub repository; this wiki holds the detailed operational guide.
Install and configure
Day to day
Integrations
Developers and security