comintelexvision/sentry-firefly-proxy repository overview

⁠Installation Notes

These notes are for the installation and operation of the Sentry Edge Proxy in a production environment only.

⁠Copy the container to your target host

You will require an instance of Docker runtime Pull the image to your target host. The docker CLI command is

docker pull comintelexvision/sentry-firefly-proxy

⁠Environment variables

The Sentry Proxy can be configured using the following optional environment variables. These can be set in the environment prior to execution or as command line arguement at execution for either native o/s execution or as container.

⁠Selecting target host ports for binding

When running the image as a Docker container the container must bind to the following ports on the target host so that it can be found by the upstream Intelex Vision Management Platform (iMP). If the port is not available, i.e. it is in use by another application, then select the second or last choice port number.

⁠HTTPS

1. 53008 (first choice)
2. 53264 (second choice)
3. 53520 (last choice)

⁠HTTP

1. 53009 (first choice)
2. 53265 (second choice)
3. 53521 ( last choice )

⁠Host name resolution for alias to IMP

The Sentry Proxy requires that host name resolution service, either from hosts file or DNS, will resolve the alias sentry-imp to a valid IP address, and that there is an installation of Sentry IMP at that IP address.

⁠Running the Sentry FireFly Proxy

⁠Docker Volume

The Sentry FireFly Proxy requires a persistent filesystem volume so that the downstream topology information can be persisted after an ephemeral container is terminated. The volume is a Docker Volume and must be named com-intelexvision-imp-proxy. This volume is mounted at file system directory /var/lib/sentry consistent with Linux conventions. It is not necessary to create a volume as this is managed by Docker from the docker run command. nota bene if you launch the Sentry FireFly Proxy from the Docker Desktop then you must specify the volume mount.

⁠Host network environment

At installation time you must tell the Sentry Proxy which networks to scan for devices, e.g. cameras, Sentry installations, etc.

⁠Windows

Run the command in powershell Get-NetIPAddress -AddressFamily IPv4 | Select-Object InterfaceAlias,IPAddress,PrefixLength and from output, e.g.

InterfaceAlias IPAddress     PrefixLength
-------------- ---------     ------------
Ethernet       192.168.1.23  24
Wi-Fi          10.50.0.12    16

then declare environment variable to scan networks required SENTRY_PROXY_SCAN_IPV4_CIDRS=192.168.1.0/24;10.50.0.0/16 where multiple networks are ";" separated.

⁠Linux

Run the command ip -4 addr and from the output you select the networks and declare an environment variable, e.g.

inet 192.168.1.23/24
inet 10.50.0.12/16

declare to scan both networks SENTRY_PROXY_SCAN_IPV4_CIDRS=192.168.1.0/24;10.50.0.0/16 where multiple networks are ";" separated.

⁠First time start

⁠For Bash

nota bene The values for SENTRY_PROXY_SCAN_IPV4_CIDRS are illustrative. You must type the values for your host.

docker run -d \ --name imp-proxy \ --network bridge \ -e IMP_NETWORK_MODE=bridge \ -e SENTRY_PROXY_SCAN_IPV4_CIDRS=192.168.1.0/24;10.50.0.0/24 -p 53009:8080 \ -p 53008:443 \ --mount source=com-intelexvision-imp-proxy,target=/var/lib/sentry \ comintelexvision/sentry-firefly-proxy:latest

⁠For Power-Shell

nota bene The values for SENTRY_PROXY_SCAN_IPV4_CIDRS are illustrative. You must type the values for your host.

docker run -d --name imp-proxy -e IMP_NETWORK_MODE=bridge -p 53009:8080 -p 53008:443 -e SENTRY_PROXY_SCAN_IPV4_CIDRS=192.168.1.0/24;10.50.0.0/24 --mount source=com-intelexvision-imp-proxy,target=/var/lib/sentry comintelexvision/sentry-firefly-proxy:latest

⁠Start with specific settings for hostname

⁠Specific start For Power-Shell

docker run -d --name imp-proxy -e IMP_NETWORK_MODE=bridge -p 53009:8080 -p 53008:443 -e SENTRY_PROXY_SCAN_IPV4_CIDRS=192.168.1.0/24;10.50.0.0/24 -e HOST_FQDN="my-proxy.my-domain.my-tld" -e HOST_NAME="my-proxy" --mount source=com-intelexvision-imp-proxy,target=/var/lib/sentry comintelexvision/sentry-firefly-proxy:latest

⁠Upgrade the version of DOcker image

• find the running container "imp-proxy" and stop the container.
• pull the image comintelexvision/sentry-firefly-proxy to get the new version
• start the container that you stopped.

⁠Health Check

Once the docker container is running , you can test the health of the Sentry FireFly Proxy using a health check REST API at endpoint "/healthz". This example is using curl

curl https://localhost:53008/healthz

curl http://localhost:53009/healthz