Compare commits

...

3 Commits

Author SHA1 Message Date
58369fccaf docs: add reference to MongoDB Docker Compose examples in README
All checks were successful
Build and Push Docker Image / build (push) Successful in 1m5s
2025-02-11 11:17:47 +01:00
4c46af63e3 feat: add MIT License file to the repository
All checks were successful
Build and Push Docker Image / build (push) Successful in 1m8s
2025-02-11 11:12:32 +01:00
755128a5c7 docs: update README to include server setup instructions and clarify port requirements
All checks were successful
Build and Push Docker Image / build (push) Successful in 2m19s
2025-02-10 12:45:25 +01:00
2 changed files with 52 additions and 7 deletions

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 Mirko Milovanovic
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -10,7 +10,7 @@ peertube-collector is a project designed to collect and analyze WebRTC statistic
- Docker Engine Community version is required. To install Docker CE, follow the official [install instructions](https://docs.docker.com/engine/install/).
### Ports:
#### Localhost (REQUIRED):
#### Docker to Host:
- 4444 (Selenium)
Ports can be opened in the host machine's firewall with:
@@ -31,9 +31,6 @@ Ports can be opened in the host machine's firewall with:
ufw allow 50000:60000/udp
ufw allow 27107/tcp
```
---
## Setup
1. Clone the repository:
@@ -58,10 +55,10 @@ ufw allow 27107/tcp
docker compose up -d
```
To stop the Docker containers run: `docker compose down -v`
The collector will start gathering WebRTC stats from the Selenium container and sending them to the Telegraf service.
To stop the Docker containers run: `docker compose down -v`
### Monitoring
A noVNC server is available at [http://localhost:7900](http://localhost:7900/?autoconnect=1&resize=scale&password=secret) to monitor the Selenium container. The password is `secret`.
@@ -98,4 +95,31 @@ peertube-collector/
├── .env
└── utils/
└── webrtc-internals-exporter/
```
```
---
# Server
The repository contains a `server` directory with a simple MongoDB server (with initializations scripts) and WebUI that serves the WebRTC stats collected by the collector.
Based this awesome example configuration: [MongoDB Docker Compose examples](https://github.com/TGITS/docker-compose-examples/tree/main/mongodb-docker-compose-examples).
## Setup
1. Change to the `server` directory:
```sh
cd server
```
2. Create and configure the environment file based on the `.env.example` file:
```sh
cp .env.example .env
```
3. Start the Docker containers:
```sh
docker compose up
```
The WebUI control panel will be available at [http://localhost:8081](http://localhost:8081).