diff --git a/readme.md b/readme.md index e96eefc5d30d62e3442178fae2610192e9704bfb..73f7b5f1a3a3e8bad34f2b27693b4d5ef2e93889 100644 --- a/readme.md +++ b/readme.md @@ -150,27 +150,26 @@ This surveillance system is designed to process video feeds using a distributed docker pull <your-username>/object_recognizer:latest ``` ### Step 2: Create or Update `docker-compose.yml` -#### 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`). +#### **Services Environment Variables** - **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`). +- **Object Recognizer**: + No environment variables are specified for this service. -you can find an example in the deploy/docker-compose directory. Make sure the `docker-compose.yml` file is set up correctly +- **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 (default: `object_recognizer`). + - `OR_PORT`: The port on which the **Object Recognizer** service is listening (default: `9999`). +- **Camera**: + - `CAMERA`: Set to `true` to indicate that the container is a camera service. + - `ANIMAL_NAME`: The name of the animal being monitored 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 associated **Motion Detector** (e.g., `motion_detector_1`, `motion_detector_2`, `motion_detector_3`). + - `MDPORT`: The port on which the associated **Motion Detector** is listening (default: `9998`). + - `INDEX`: A unique identifier for each camera instance (e.g., `1`, `2`, `3`). -Here’s a concise version of your instructions that replaces the detailed descriptions while maintaining clarity. This focuses on updating the environment variables and deploying the system using `docker-compose`. +You can find a complete example configuration in the `deploy/docker-compose` directory. Ensure the `docker-compose.yml` file is properly set up before deployment. ---