slococo-uni
/
startstreaming
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Santiago Lo Coco 2024-11-21 00:48:30 +01:00
parent 255961b944
commit 290ad4e72d
1 changed files with 34 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -2,25 +2,46 @@
## Prerequisites
1. Docker Desktop
2. OBS Studio
1. Install:
## OBS configuration
- Docker Desktop
- OBS Studio
- Create a scene collection named `Profile1` and a profile named `Profile1`.
- Create a scene collection named `Profile2` and a profile named `Profile2`.
- Add scenes and configure the input sources (e.g., HDMI cards) for each scene collection.
- For each profile, go to `Settings` -> `Stream`, set `Service` to WHIP, and enter the endpoint for each MediaMTX server:
- Profile1: `http://192.168.137.1:8100/mystream/whip`
- Profile2: `http://192.168.137.1:8200/mystream/whip`
2. Prepare the `.env` file
## IP address configuration
Copy `.env.dev` to `.env` and update with your environment-specific values.
The `docker-compose.yaml` is hardcoded to use the IP address `192.168.137.1`. You must update this to your specific network IP from the mobile hotspot configuration.
```bash
cp .env.dev .env
```
In the `.env` file:
- `IP` is the IP address to which the WebRTC server will be bound.
- `PORT_1` is the WebRTC HTTP listener port, which can be used for WHIP and WHEP.
- `LISTENER_PORT_1` is the WebRTC ICE/UDP port.
3. 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).
- Create a scene collection and a profile for each instance (e.g., `Profile1`, `Profile2`, ... `ProfileN`).
- Add scenes and configure the input sources (e.g., HDMI cards) for each scene collection.
- Go to `Settings` -> `Stream`, set the `Service` to WHIP, and enter the endpoint for each MediaMTX server: `http://{{IP}}:{{PORT_X}}/mystream/whip`.
Repeat for each profile from `X=1` to `X=N`.
## Run
The Docker image will automatically generate the necessary configurations for you. After finishing with the prerequisites, simply run the following command from the root repository:
```
docker run --rm -v ${PWD}:/app/data se23m504/startstreaming
```
## Build
The image is already available on DockerHub, but if you need to build it again for any reason, run the following command from the root directory:
```
docker build -t se23m504/startstreaming .\src -f .\docker\Dockerfile
docker run --rm -v ${PWD}:/app/data se23m504/startstreaming
```