Skip to main content

Configuration Basics

The deployment is configured through environment files next to the Docker Compose package — most importantly .env.hub, which defines the units the node serves and how they behave. Changes follow the usual Compose cycle: edit the file, then recreate the affected services. This page covers the settings every deployment touches; the long tail is in Advanced Configuration.

Units: what this node serves

A unit is a physical corridor or gate lane. Each unit gets an ID, a type, and its cameras:

FOUNDATION_UNITS_0_ID=corridor-a
FOUNDATION_UNITS_0_TYPE=CORRIDOR # or EGATE
FOUNDATION_UNITS_0_CAMERAS=<VPP camera IDs, comma-separated>

The camera IDs come from VPP — register the streams there first (see Add Cameras), then list the resulting IDs on the unit. Every event the Hub publishes carries the unit ID, which is how consumers tell lanes apart.

Watchlists and clearance

Watchlists live in VPP; the Hub needs to know which of them mean "allowed" so it can raise identification.clearance.green instead of a plain match. Create the watchlists, note their IDs, and wire the allowed ones into the Hub configuration as described in Add People to Watchlists. Matches on denied watchlists raise red clearance events automatically.

Storage

Decide explicitly whether the node persists events. STORAGE_ENABLED=false stores nothing at rest (the GDPR-friendly mode); true enables the event store with configurable retention TTLs for events and images. The defaults and the full retention model are documented in Event Storage & Retention.