docs: reorganize server setup instructions and create dedicated server README
All checks were successful
Build and Push Docker Image / build (push) Successful in 1m6s

This commit is contained in:
2025-02-12 20:20:41 +01:00
parent 5be06ec11f
commit 752cea15d4
2 changed files with 32 additions and 27 deletions

View File

@@ -49,12 +49,12 @@ ufw allow 27107/tcp
4. Start the Docker containers: 4. Start the Docker containers:
```sh ```sh
docker compose up \ docker compose up \
--pull missing \ --pull always \
--abort-on-container-exit --abort-on-container-exit
``` ```
or in detached mode: or in detached mode:
```sh ```sh
docker compose up --pull missing -d docker compose up --pull always -d
``` ```
The collector will start gathering WebRTC stats from the Selenium container and sending them to the Telegraf service. The collector will start gathering WebRTC stats from the Selenium container and sending them to the Telegraf service.
@@ -99,31 +99,6 @@ peertube-collector/
└── webrtc-internals-exporter/ └── 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.
## 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).
# Credits # Credits
- [WebRTC Internals Exporter](https://github.com/vpalmisano/webrtc-internals-exporter) - [WebRTC Internals Exporter](https://github.com/vpalmisano/webrtc-internals-exporter)

30
server/README.md Normal file
View File

@@ -0,0 +1,30 @@
# 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.
It's not mandatory to run and use this service, it's provided just as an example of how to store collected data.
## 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).
# Credits
- [WebRTC Internals Exporter](https://github.com/vpalmisano/webrtc-internals-exporter)
- [WebRTC debugging with Prometheus/Grafana](https://medium.com/@vpalmisano/webrtc-debugging-with-prometheus-grafana-254b6ac71063)
- [MongoDB Docker Compose examples](https://github.com/TGITS/docker-compose-examples/tree/main/mongodb-docker-compose-examples)