All chapters

Huntress documentation

Huntress is a self-hosted command platform for physical security. It brings sensors, alarm panels, cameras, people and controllable devices into one live picture, turns everything they report into a common set of events, evaluates rules and schedules against those events, and responds with incidents, notifications and device commands. It is one self-contained solution that you run yourself, from a Raspberry Pi at a single site to a data centre serving many, so your data stays in your control.

How data flows#

Sources Sensors, alarm panels, cameras, Pulse trackers, Zigbee devices
Ingest HTTP, MQTT, SMTP, SIA DC-09, Contact ID, Zigbee, edge relays
Normalise Domain, category, event type, nature and severity
Decide Rules, schedules, sensor limits, object detection
Act Incidents, email, webhooks, device commands

Every protocol Huntress listens on hands its payload to the same ingestion service. A door contact that reports over HTTP, an alarm panel that reports over SIA DC-09 and a Zigbee sensor behind a USB dongle therefore end up as the same kind of event, in the same timeline, visible to the same rules. Every stored event keeps the raw request it came from, including the address it was received from.

What sets Huntress apart#

Yours to run One self-contained solution with nothing to install beside it. No cloud service is required, and a server can run without internet access. Every source, one picture 116 sensor types, alarm panels over SIA DC-09 and Contact ID, RTSP cameras, Zigbee devices and people with a phone. Rules you can test WHEN, IF, THEN, OTHERWISE rules with schedules, sequences and sustained conditions, replayed against real events before you save. Cameras that understand People, vehicles and animals recognised on your own hardware, in regions you draw, with video clips around each detection. A closed loop Rules and operators switch lights, locks, sirens and relays over MQTT, Zigbee or HTTP, with every command confirmed and audited. Built for the field Huntress Edge reaches cameras and devices behind NAT with outbound connections only. Looks after itself Signed updates with a health gate and automatic rollback, consistent backups, retention and health checks. Plain about security Roles, two-factor sign-in, passkeys, hashed API keys and a documented list of everything that connects out.

Find your way#

I want to try it Create an account, add a place and a sensor, send a reading and see it arrive. I want to connect something Send data over HTTP, MQTT or e-mail, connect an alarm panel or a camera. I want to automate Write rules, define schedules and decide what becomes an incident. I want to install it Platforms, installers, ports, reverse proxy, edges and configuration. I want to secure it Accounts, roles, network exposure and what is stored where. I need exact codes SIA and Contact ID codes and the event types they become.

Conventions#

<host> is the address of your Huntress server and {token} is a sensor, person or panel token copied from its page.
An organisation is the unit of ownership and isolation (called a tenant internally). Everything you create belongs to one.
Times are stored in UTC and shown, and used by time-based rules and schedules, in your organisation's time zone.