From 62981f095bcf235098f1403c7c95c6a8782db196 Mon Sep 17 00:00:00 2001 From: Mirko Milovanovic Date: Wed, 12 Feb 2025 20:20:41 +0100 Subject: [PATCH] docs: reorganize server setup instructions and create dedicated server README --- README.md | 25 ------------------------- server/README.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 25 deletions(-) create mode 100644 server/README.md diff --git a/README.md b/README.md index 9d8c99e..df0e354 100644 --- a/README.md +++ b/README.md @@ -99,31 +99,6 @@ peertube-collector/ └── 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 - [WebRTC Internals Exporter](https://github.com/vpalmisano/webrtc-internals-exporter) diff --git a/server/README.md b/server/README.md new file mode 100644 index 0000000..fbe43f9 --- /dev/null +++ b/server/README.md @@ -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) \ No newline at end of file