Configuration
EyesOnIt reads configuration files from a designated configuration folder. These files can control certain aspects of how EyesOnIt operators.
Configuration Folder
The location of the configuration folder depends on whether you are running the Docker version of EyesOnIt, or the Windows installed version.
- Docker
- Windows
With Docker the config folder needs to be created on the host and mapped to the container. To do that, create a folder on the host like /usr/local/EyesOnIt/input, and add the following to the docker run command:
-v /usr/local/EyesOnIt/input:/home/eyesonit_user/input
A complete docker run command would look like this:
docker run -d -p 8000:8000 --gpus all -e EOI_LICENSE_KEY='<EyesOnIt license key>' -e EOI_AUTHORIZATION_TOKEN='<EyesOnIt auth token>' -v /usr/local/EyesOnIt/input:/home/eyesonit_user/input eyesonit/eyesonit_v3:latest
Under the /usr/local/EyesOnIt/input folder, create another folder named config. Create your config files within this folder.
When using the Windows installed version of EyesOnIt, the config folder will be located at. <user>\AppData\Local\Programs\EyesOnIt\input\config. For example, if your username is "test_user", this folder would probably be c:\users\test_user\AppData\Local\Programs\EyesOnIt\input\config.
If you are running EyesOnIt as a Windows service, the config folder will be located at C:\Windows\System32\config\systemprofile\AppData\Local\Programs\EyesOnIt\input\config
Create your config files within the config folder.
Configuration Files
EyesOnIt will read .yml files from the config folder as follows:
vms_config.yml - Video Management System configuration file
This is a special file containing configuration data for integration with your Video Management System and for other REST API integration.
Genetec Configuration
For Genetec VMS systems, the format of the vms_config.yml file should be like this:
genetec:
web_sdk_ip: <the Genetec Web SDK IP address>
web_sdk_port: <the Genetec Web SDK port number>
web_sdk_base_uri: <the Genetec Web SDK base URL path>
use_ssl: True to use SSL, False otherwise
ssl_certificate: <the .pem certificate file for the Genetec self-signed certificate. The .pem file should be in the config folder.>
genetec_username: <the Genetec Web SDK username>
genetec_password: <the Genetec Web SDK password>
Here is an example of the Genetec configuration section with actual values:
genetec:
web_sdk_ip: 192.168.0.10
web_sdk_port: 4590
web_sdk_base_uri: WebSdk
use_ssl: False
ssl_certificate: certificate.pem
genetec_username: my_username
genetec_password: my_password
When EyesOnIt sends an alert to Genetec, it combines the fields from the config file with the webhook_event_id and webhook_camera_uuid fields provided to the add_stream method and constructs the alert URL as follows:
https://<web_sdk_ip>:<web_sdk_port>/<web_sdk_base_uri>/events/RaiseCustomEvent/<webhook_event_id>/<webhook_camera_uuid>
Note that you will need configure Genetec to handle events from EyesOnIt by creating custom events through the Genetec Config Tool. The settings for custom events can be found in the Genetec Config Tool under System / General Settings / Events. The event number assigned to your custom event can be specified in the alert settings in the EyesOnIt Genetec Plugin.
Generic REST API Configuration
EyesOnIt is also able to make REST calls to generic REST APIs. For these generic REST calls, the authentication parameters must be specified in vms_config.yml. The format of these parameters is as follows:
rest:
ssl_certificate: <certificate .pem file if needed. The .pem file should be in the config folder.>
auth_type: <the auth type: none, basic, digest, or bearer>
username: <the username for basic or digest auth>
password: <the password for basic or digest auth>
bearer_token: <the bearer token for bearer auth>
Here is an example of the REST configuration section with actual values:
rest:
ssl_certificate:
auth_type: digest
username: my_username
password: my_password
bearer_token:
When EyesOnIt sends a generic REST alert, it will use the POST method to send data to the rest_url provided in the notification parameters of the add_stream method. The body of the request will contain the same data as returned by the get_last_detection_info method of the REST API.
{
"detections": [
{
"stream_url": "rtsp://Va8RLc91r2Am:Jg7SuwC9ea4u@192.168.1.13/live0",
"region": "Doorway",
"time": "2025-03-17 22:27:33",
"frame_num": 75,
"class_name": "person",
"condition": {
"type": "count_greater_than",
"count": 0,
"line_name": null,
"alert_direction": null,
"objects": [
{
"object_description": "person",
"confidence": 99,
"bounds": {
"left": 837,
"top": 15,
"width": 581,
"height": 1072
}
}
]
}
}
],
"image": "<base64-encoded image string>"
}
REST POST Body Attributes
| Name | Type | Description |
|---|---|---|
| stream_url | string | the RTSP URL for the stream where the detection occurred |
| region | string | the friendly name for the region where the detection occurred |
| time | string | the time (UTC) when the detection occurred |
| class_name | string | the common object type associated with the detection, or null if no common object type was used. |
| condition | Detection Condition | the detection condition that triggered the detection |
eoi_streams.json - Stream definition JSON file
The config folder can contain a eoi_streams.json file. This file can contain the definition of one or more streams to load automatically when EyesOnIt runs. The format of the eoi_streams.json file exactly matches the JSON sent to the add_stream method of the REST API. Here is an example of a eoi_streams.json file:
{
"rtsp://username:password@192.168.1.14/live": {
"name": "Back Alley Camera",
"stream_url": "rtsp://username:password@192.168.1.14/live0",
"frame_rate": 15,
"regions": [
{
"enabled": true,
"name": "Back Alley",
"polygon": [
{
"x": 528,
"y": 175
},
{
"x": 876,
"y": 166
},
{
"x": 896,
"y": 285
},
{
"x": 506,
"y": 279
},
{
"x": 528,
"y": 175
}
],
"motion_detection": {
"enabled": true,
"detection_threshold": 300,
"regular_check_frame_interval": 1,
"backup_check_frame_interval": null
},
"detection_configs": [
{
"class_name": "vehicle",
"class_threshold": 10,
"object_size": 150,
"object_descriptions": [
{
"text": "black sedan",
"threshold": 90,
"alert": true,
"background_prompt": false
},
{
"text": "vehicle",
"threshold": 90,
"alert": false,
"background_prompt": false
},
{
"text": "street building",
"threshold": null,
"alert": false,
"background_prompt": true
}
],
"conditions": [
{
"type": "count_greater_than",
"count": 0,
"line_name": null,
"alert_direction": null
}
],
"alert_seconds": 0.3,
"reset_seconds": 2.0,
"vms_config": null
}
]
},
],
"lines": [
{
"name": "loading zone entrance",
"vertices": [
{
"x": 1302,
"y": 159
},
{
"x": 1047,
"y": 480
}
]
}
],
"notification": {
"phone_number": null,
"image_notification": false,
"genetec": {
"webhook_event_id": null,
"webhook_camera_uuid": null
},
"rest_url": null
}
},
"rtsp://username:password@192.168.1.15/live": {
"name": "Back Alley Camera2",
...
}
}
JSON Format Description
The json in eoi_streams.json is a dictionary. The key for each entry is the stream URL. The value for each entry has the following fields:
| Name | Type | Description |
|---|---|---|
| name | string | a friendly name for the stream used in the EyesOnIt Web UI and in alerts |
| stream_url | string | the RTSP URL for the stream including credentials required to connect to the stream |
| frame_rate | integer | the frame rate for this stream. This attribute is optional. The default value is 5. |
| regions | Region[] | an array of detection regions |
| lines | Line[] | an array of boundary lines |
| notification | Notification | the notification settings for this stream |