Estate Sentry¶
Open-source automated intelligence for personal and public safety.
Estate Sentry is a prototype threat intelligence platform that combines real-time sensor monitoring, zone-based perception, and AI-powered analysis to make security accessible, transparent, and affordable.
Prototype Notice — This software is a demonstrational prototype under active development. It is not licensed for public intelligence gathering. See the Specification for the full system design.
Start Here¶
I want to understand the system¶
- Specification — The complete intelligence architecture: perception layers, zone model, identity pipeline, and threat assessment.
- Architecture Overview — How the API, Switchboard, databases, and dashboard fit together.
- Database Architecture — PostgreSQL, Neo4j, ChromaDB, and MinIO roles.
- Roadmap — What's built, what's next.
I want to run it locally¶
- Installation — Three setup paths: Docker, Task runner, or manual.
- Quick Start — Register a user, create a sensor, trigger your first alert.
- Docker Setup — Full stack with PostgreSQL, Neo4j, NATS, MinIO, and ChromaDB.
I want to build on it¶
- Plugin Development — Create a sensor handler in under 50 lines.
- API Usage — Every endpoint with request/response examples.
- MCP Integration — Connect Claude for AI-powered threat analysis.
- Development Guide — Tooling, testing, and contribution workflow.
I want to deploy and operate it¶
- Node Deployment — Single-node and multi-node configurations.
- Monitoring — Prometheus metrics, Grafana dashboards, alerting rules.
- Task Reference — Every
taskcommand for setup, dev, Docker, and database ops.
Quick Start¶
# Clone and setup
git clone https://github.com/QR-Madness/estate-sentry.git
cd estate-sentry
task setup
# Create admin user and start dev servers
task api:superuser
task dev
API and dashboard at localhost:8000 · Docs at localhost:8001 (task docs:serve)