docs: reorganize server setup instructions and create dedicated server README
All checks were successful
Build and Push Docker Image / build (push) Successful in 1m7s
All checks were successful
Build and Push Docker Image / build (push) Successful in 1m7s
This commit is contained in:
25
README.md
25
README.md
@@ -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
30
server/README.md
Normal 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)
|
Reference in New Issue
Block a user