Getting Started¶

Welcome to Home Security Intelligence. This section guides you from zero to a running system.

Note: This section covers installation and initial setup. For ongoing usage documentation, see the User Guide.

Technical Setup (for operators/installers)¶

Follow these steps in order to install and start the system:

Step	Guide	Description
1	Prerequisites	Verify hardware and software requirements
2	Installation	Clone, setup environment, download AI models
3	First Run	Start the system and verify everything works
4	Upgrading	Update to new versions

End User Guides¶

These guides help users learn the system after installation:

Guide	Description
Quick Start	Non-technical intro - what the system does and basic use
Product Tour	Interactive walkthrough and first-time setup

Recommended Path¶

New users: Follow steps 1-3 in order. The entire process takes approximately 30 minutes (plus model download time).

Existing users: Jump directly to Upgrading for version updates.

User Journey¶

journey
    title Onboarding Journey: From Zero to Monitoring
    section Prerequisites
      Check hardware requirements: 5: Operator
      Verify GPU and drivers: 4: Operator
      Install Python and Node.js: 4: Operator
      Setup container runtime: 4: Operator
    section Installation
      Clone repository: 5: Operator
      Run setup script: 5: Operator
      Download AI models: 3: Operator
      Configure environment: 4: Operator
    section First Run
      Start AI services: 4: Operator
      Start application stack: 5: Operator
      Verify health checks: 5: Operator
      Add first camera: 4: Operator
    section Configuration
      Complete product tour: 5: User
      Enable notifications: 5: User
      Configure detection zones: 4: User
      Review dashboard: 5: User

The onboarding journey takes operators through system setup, then hands off to end users for configuration and daily use.

What You Will Need¶

NVIDIA GPU with 8GB+ VRAM (RTX 3060 or better)
Python 3.14+, Node.js 20.19+
Docker or Podman
Foscam cameras (or compatible FTP-uploading cameras)

See Prerequisites for complete requirements and verification commands.

Next Steps After Setup¶

Once your system is running, continue to the guide that matches your role:

Role	Hub	Focus
End Users	User Guide	Dashboard usage, cameras, alerts
Developers	Developer Guide	Contributing, testing, architecture
Operators	Operator Guide	Deployment, monitoring, configuration

Recommended for all users: Complete the Product Tour to familiarize yourself with the dashboard before diving into detailed documentation.