Skip to main content

Welcome to ArgusAI

ArgusAI is an AI-powered event detection system for home security. It analyzes video feeds from UniFi Protect cameras, RTSP IP cameras, and USB webcams, detects motion and smart events, and generates natural language descriptions using multi-provider AI.

Latest Release: Phase 14 Complete​

Phase 14: Technical Excellence & Quality Foundation brings major improvements to code quality, testing, and AI context:

  • MCP Context Enhancement - Parallel queries with 80ms timeout and fail-open behavior
  • Code Standardization - @singleton decorator, retry utility, consistent database patterns
  • Backend Testing - Comprehensive test coverage for 6 previously untested services (3,100+ total tests)
  • Database Integrity - Check constraints, timezone handling, FK constraints, indexes
  • Frontend Quality - React Query devtools, hook tests, accessibility improvements

What Can ArgusAI Do?​

  • Intelligent Event Detection: Automatically detect and describe what's happening in your camera feeds
  • Multi-Provider AI: Choose from OpenAI GPT-4, xAI Grok, Anthropic Claude, or Google Gemini
  • Entity Recognition: Track people, vehicles, and packages across events
  • Smart Notifications: Push notifications with thumbnails and configurable alert rules
  • Home Integration: Connect to Home Assistant and Apple HomeKit
  • API Key Authentication: Secure programmatic access with scoped permissions and rate limiting

Quick Start​

# Clone the repository
git clone https://github.com/project-argusai/ArgusAI.git
cd ArgusAI

# Copy and configure environment
cp .env.example .env

# Start with Docker Compose
docker-compose up -d

Access ArgusAI at http://localhost:3000

For production deployments with SSL:

docker-compose --profile ssl up -d

Manual Installation​

# Clone the repository
git clone https://github.com/project-argusai/ArgusAI.git
cd argusai

# Run the installation script
./scripts/install.sh

Deployment Options​

MethodBest For
Docker ComposeSingle server, easy setup
KubernetesScalable clusters, fine control
Helm ChartTemplate-based K8s, GitOps
ManualDevelopment, customization

Pre-built Docker images are available from GitHub Container Registry.

System Requirements​

Docker Deployment​

  • Docker Engine: 20.10 or higher
  • Docker Compose: V2 or higher
  • Optional: SSL certificates for HTTPS

Kubernetes Deployment​

  • Kubernetes: 1.25 or higher
  • Helm: 3.10 or higher (for Helm deployments)
  • kubectl: Configured with cluster access

Manual Installation​

  • Python: 3.11 or higher
  • Node.js: 18 or higher
  • Database: SQLite (default) or PostgreSQL
  • Optional: UniFi Protect controller for native camera integration

Architecture Overview​

Camera Capture → Motion Detection → Event Queue → AI Description → Database → Alert Rules → Webhooks/Notifications → WebSocket

Next Steps​

Deployment​

Configuration & Features​