update README and add docker compose
All checks were successful
ci/woodpecker/push/golang-test Pipeline was successful

This commit is contained in:
Adora Laura Kalb 2024-04-19 12:07:41 +02:00
parent 127f21e445
commit 0887112c44
Signed by: adoralaura
GPG key ID: E2E0F82107536C1B
2 changed files with 11 additions and 6 deletions

View file

@ -2,16 +2,13 @@
This exporter is @adoralaura s try to display server scores from servers in [ntppool.org](https://www.ntppool.org) in a format which [Prometheus](https://prometheus.io/) can ingest.
# Usage
## Installation
Binaries can be downloaded soon from the [GitLab releases page](https://gitlab.com/adoralaura/ntppool-exporter/-/releases) and need no
special installation
Pre-built docker images can be found at [Docker Hub](https://hub.docker.com/r/lauralani/ntppool-exporter). A sample `docker-compose.yml` can be [found here](docker-compose.yml).
Binaries can be built by cloning this repository and run `go build main.go` with [Golang](https://go.dev/) installed.
## Running

8
docker-compose.yml Normal file
View file

@ -0,0 +1,8 @@
services:
ntppool_exporter:
image: lauralani/ntppool-exporter:latest
restart: always
ports:
- '127.0.0.1:43609:43609'
# Add this to enable debug logging:
# command: --log.level=debug