feat: add .env.example file and update README with prerequisites and setup instructions

This commit is contained in:
2025-02-07 18:56:32 +01:00
parent 583687af2b
commit be0e0f8153
3 changed files with 29 additions and 7 deletions

View File

@@ -19,8 +19,21 @@ peertube-collector/
## Prerequisites
- Docker
- Docker Compose
**Linux** based OS with the following:
### Software:
- Docker (with compose support)
### Open ports on localhost/loopback interface:
- 4444 (Selenium)
- 7900 (Selenium VNC - Optional)
If needed, you can open these ports in `ufw` by running the following commands:
```sh
ufw allow from 172.30.0.1 to 127.0.0.1 port 4444
ufw allow from 172.30.0.1 to 127.0.0.1 port 7900
```
## Setup
@@ -36,10 +49,16 @@ peertube-collector/
```
3. Build and start the Docker containers:
3. Start the Docker containers:
```sh
docker compose up
```
or in detached mode:
```sh
docker-compose up -d
```
The collector will start collecting WebRTC stats from the specified PeerTube instance.
## Components