From 2720304eaf16603956b5dc562c2823f6b6426898 Mon Sep 17 00:00:00 2001 From: Jeff Wong Date: Sun, 17 Nov 2024 14:20:40 -0800 Subject: [PATCH] Give an example on how to hide IPs. Add readme to remove data. --- README.md | 22 +++++++++++++++++++++- docker-compose.yml | 4 ++++ 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 53107ba..b407618 100644 --- a/README.md +++ b/README.md @@ -175,9 +175,29 @@ Navigate to `localhost:3000`. Log in with username: admin, password: admin. You If you do not see any data or your server populate in the top, the monitoring stack most likely cannot reach your game. +#### Hiding IPs from the dashboard + +In case you need to hide IPs from the dashboard, you may update `docker-compose.yml` to include `extra_hosts` - this is a way of telling the internal services how to access the FRM host by a hostname alias. + +Uncomment (remove the # character) on both `extra_hosts` lines and replace `192.168.1.100` lines with your IP. Then use `FRM_HOST=my-server` in your .env file. The resulting configuration will allow the FRM companion and cache to access the data by IP, and the dashboards will list the server(s) by their alias (`my-server`). + +EG: +``` +extra_hosts: + - "frm-server:192.168.1.100" +``` + ### Remove environment -When you're done with the data, you can run `docker compose down` which will completely delete and remove the monitoring stack. +When you're done with stack, you can run `docker compose down` which will completely delete and remove the monitoring stack. + +#### Removing data + +Data is saved to [docker volumes](https://docs.docker.com/engine/storage/volumes/). To remove the data after you stop the stack run: + +`docker volume rm satisfactory-monitoring_grafana satisfactory-monitoring_postgresql satisfactory-monitoring_prometheus` + +When you're done with the data you can run `docker volume rm satisfactory-monitoring_grafana` ### Update environment diff --git a/docker-compose.yml b/docker-compose.yml index c56479a..e3b0535 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -18,6 +18,8 @@ services: - FRM_HOST=${FRM_HOST:-host.docker.internal} - FRM_PORT=${FRM_PORT:-8080} - FRM_HOSTS=${FRM_HOSTS:-} + #extra_hosts: + # - "frm-server:192.168.1.100" ports: - "9000:9000" prometheus: @@ -33,6 +35,8 @@ services: build: ./frmcache image: featheredtoast/ficsit-remote-monitoring-cache restart: unless-stopped + #extra_hosts: + # - "frm-server:192.168.1.100" environment: - FRM_HOST=${FRM_HOST:-host.docker.internal} - FRM_PORT=${FRM_PORT:-8080}