Skip to main content

Getting Started

This section walks you through standing up a Smart Corridors & e-Gates deployment from the official Docker Compose stack — from prerequisites and registry access to a running system with cameras connected and watchlists populated.

What you'll need​

  • Linux host — all services run as Docker containers. Ubuntu 22.04 LTS or later is recommended.
  • Docker Engine with the Compose plugin (docker compose). For Linux containers on Windows via WSL2, contact your Innovatrics sales representative for a compatible license.
  • The deployment repository — innovatrics/border-control, folder smart-corridors-and-e-gates/.
  • Registry credentials — a robot account for the Innovatrics registry, plus GitLab registry access. See Registry Access.
  • A license file (iengine.lic) tied to the host hardware, from the Innovatrics Customer Portal.
  • Camera streams — RTSP streams from IP cameras reachable from the host.

What gets deployed​

The stack runs as a set of containers on a shared external Docker network:

  • Hub (corridor-foundation-service) — event aggregation, persistence, and the external GraphQL API
  • CIGS (corridor-identity-grouping-service) — corridor identity grouping across cameras
  • Frontend (biometriccorridor) — the corridor dashboard
  • VPP / SmartFace — face detection, recognition, and watchlist matching, brought up from the bundled vpp/ folder
  • Supporting services — RabbitMQ (message broker), PostgreSQL, and MinIO (S3-compatible storage for face crops)

The corridor images (corridor-foundation-service, corridor-identity-grouping-service, biometriccorridor) are pulled from the Innovatrics registry at registry.dot.innovatrics.com/border-control/. The VPP/SmartFace images and the license-manager image come from the GitLab registry. Both are covered in Registry Access.

What run.sh does​

run.sh orchestrates startup in the correct order: it links your license into the VPP folder, brings up VPP and its dependencies, creates the MinIO bucket the Hub uses for image storage, then starts the corridor services with docker compose --env-file ./.env up -d. You do not manage startup order manually.

Steps​

  1. Registry Access — obtain a registry robot account and log in to both registries
  2. First Deployment — clone, license, and run the stack
  3. Add Cameras — connect camera streams to VPP
  4. Add People to Watchlists — enroll subjects for identification