feat: add .env.example file and update README with prerequisites and setup instructions
This commit is contained in:
25
README.md
25
README.md
@@ -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
|
||||
|
||||
|
Reference in New Issue
Block a user