From dba4fb29087b6ea9773cdf47db95a053ce1701fa Mon Sep 17 00:00:00 2001 From: Santiago Lo Coco Date: Wed, 1 Jan 2025 18:43:39 +0100 Subject: [PATCH] Update installation instructions --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 38ac44c..1bfc387 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,11 @@ - Docker Desktop - OBS Studio -2. Prepare the `.env` file +2. Clone the repository and its submodule (use `git clone --recursive` or run `git submodule update --init` if you didn't clone it with the recursive parameter). + +3. Prepare the `.env` files - Copy `.env.dev` to `.env` and update with your environment-specific values. + In the root directory, copy `.env.dev` to `.env` and update with your environment-specific values. ```bash cp .env.dev .env @@ -21,7 +23,9 @@ - `PORT_X` is the WebRTC HTTP listener port, which can be used for WHIP and WHEP. - `LISTENER_PORT_X` is the WebRTC ICE/UDP port. -3. Set up the necessary OBS profiles and scene collections: + Next, navigate to `./getendpoints/src` and copy `.env.dev` to `.env.` Refer to the `README.md` in the `getendpoints` directory for further documentation. + +4. Set up the necessary OBS profiles and scene collections: Let `N` be the number of instances you want to create (i.e., the maximum number of `PORT_X` defined in the `.env` file).