Skip to main content

Configuration

These are the environment variables and parameters that you need to configure to run our People Tracker.

Here is a full example of the run command:

#run stream using CMD on Windows
docker run -e KEY=YOUR_ACCESS_KEY -t platerecognizer/people-detection ^
  --url rtsp://your-camera.com:8554/demo ^
  --webhook https://webhook.site/abcde ^
  --image ^
  --sample 5

Environment Variables​

You can pass environment variables when running the docker container using the option -e VARIABLE_NAME=VALUE.

KEY​

Specify the access key. Example:

-e KEY=YOUR_ACCESS_KEY
danger

This is required.

LOGGING​

For users who prefer monitoring the People Tracker's operation directly in the terminal, the software provides an option to display detected data. By setting the environment variable LOGGING=true, users can enable this feature, allowing real-time insights into the detected objects and their corresponding track IDs directly within the terminal environment. This flexibility enhances user visibility and control over the People Tracker's functionality.

Example:

-e LOGGING=true

Parameters​

Below are parameters that you can pass when running the People Tracker.

url​

This is the URL of a camera stream or the path to a video file. Example:

--url rtsp://your-camera.com:8554/demo

If processing video files, make sure the file path is to a mounted volume. Example:

-v "/opt/people-counter":/user-data/videos --url /user-data/videos/people.mp4
danger

This is required.

webhook​

This is the URL of the target webhook where data will be sent when people are detected. Example:

--webhook https://webhook.site/abcde
danger

This is required.

image​

This option includes an image in the webhook payload. Example:

--image

sample​

This defines the sample rate for reading the video stream. Example:

--sample 5
Floating button icon
CTRL + .