From ab10b09696cd2948bcdb8a5bf45dfdd495c28ad3 Mon Sep 17 00:00:00 2001 From: MiguelNdeCarvalho Date: Fri, 2 Oct 2020 17:26:12 +0100 Subject: [PATCH 1/3] README: Update the docs with instructions --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9fca3a8..074c327 100644 --- a/README.md +++ b/README.md @@ -1 +1,33 @@ -# speedtest-exporter \ No newline at end of file +#speedtest-exporter + +## Description + +This is a simple **speedtest exporter** for **Prometheus** written in **Python** + +## Running the Container + +To run the container via **CLI**: + +```bash +docker run -d \ + --name=speedtest-exporter \ + -p 9112:9112 \ + --restart unless-stopped \ + miguelndecarvalho/speedtest-exporter +``` + +Via **docker-compose**: + +```docker-compose +version: "3.0" +services: + speedtest-exporter: + image: miguelndecarvalho/speedtest-exporter + container_name: speedtest-exporter + ports: + - 9112:9112 + restart: unless-stopped +``` + + +Then just acess the page `http://localhost:9112/` and you will have the metrics. From d86b5693bfcf3b3c0b737a149504691e431ee844 Mon Sep 17 00:00:00 2001 From: MiguelNdeCarvalho Date: Fri, 2 Oct 2020 17:28:23 +0100 Subject: [PATCH 2/3] README: Fix Header and change it --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 074c327..dfb2eda 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -#speedtest-exporter +# Speedtest Exporter ## Description From 3ae6c7d63af0150da5c7d9eb7d26a5b5af024546 Mon Sep 17 00:00:00 2001 From: MiguelNdeCarvalho Date: Fri, 2 Oct 2020 17:31:26 +0100 Subject: [PATCH 3/3] README: Add a To Do list --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dfb2eda..6cf02b3 100644 --- a/README.md +++ b/README.md @@ -29,5 +29,9 @@ services: restart: unless-stopped ``` - Then just acess the page `http://localhost:9112/` and you will have the metrics. + +## TO Do List + +- [ ] Add option to choose **Server ID** +- [ ] Add option to choose the interval