From 0028703e01830fef4e5526932c402525f6f2f8f0 Mon Sep 17 00:00:00 2001
From: KADDOUR Sidi Mohammed <sidi-mohammed.kaddour@inria.fr>
Date: Wed, 18 Dec 2024 14:16:50 +0100
Subject: [PATCH] update readme.md
---
readme.md | 20 ++++++++++++++++++--
1 file changed, 18 insertions(+), 2 deletions(-)
diff --git a/readme.md b/readme.md
index 7338acc..0a89f59 100644
--- a/readme.md
+++ b/readme.md
@@ -105,8 +105,24 @@ This surveillance system is designed to process video feeds using a distributed
These commands will automatically find the `Dockerfile` in each service's directory (`./services/camera`, `./services/motion_detector`, and `./services/object_recognizer`). The `latest` tag is used to mark the most recent image.
### Step 2: Create or Update `docker-compose.yml`
-
-Make sure the `docker-compose.yml` file is set up correctly. Here's an example for reference:
+#### Services Envirment Variables
+ **Object Recognizer**:
+ - No environment variables specified.
+
+ **Motion Detector**:
+ - `INDEX`: A unique identifier for each motion detector instance (e.g., `1`, `2`, `3`).
+ - `OR_HOST`: The hostname of the **object recognizer** service (set to `object_recognizer`).
+ - `OR_PORT`: The port on which the **object recognizer** service is listening (set to `9999`).
+
+ **Camera**:
+ - `CAMERA`: Set to `true`, indicating that the container is a camera service.
+ - `ANIMAL_NAME`: The name of the animal being observed by the camera (e.g., `tiger`, `bear`, `wolf`).
+ - `APPEARANCE_RATE`: The frequency at which the animal appears in the footage (in frames per minute).
+ - `MDHOST`: The hostname of the corresponding **motion detector** (e.g., `motion_detector_1`, `motion_detector_2`, `motion_detector_3`).
+ - `MDPORT`: The port on which the corresponding **motion detector** is listening (set to `9998`).
+ - `INDEX`: A unique identifier for each camera (e.g., `1`, `2`, `3`).
+
+Here's an example for reference. Make sure the `docker-compose.yml` file is set up correctly:
```yaml
version: '3'
--
GitLab