Skip to content

Commit

Permalink
Update README and RELEASE_NOTES
Browse files Browse the repository at this point in the history
  • Loading branch information
Jenkins committed Dec 22, 2021
1 parent 3f9c71e commit 6e0da63
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
Export your favorite GitHub repositories to Prometheus

* Use it _as a service_: See https://gh.skuzzle.de for instructions
* Deploy it _on-premise_: `docker pull ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.7-SNAPSHOT`
* Deploy it _on-premise_: `docker pull ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.7`

## On-Premise deployment with docker
This application can easily be run as a docker container in whatever environment you like:

```
docker run -p 8080:8080 \
-e WEB_ALLOWANONYMOUSSCRAPE=true \
ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.7-SNAPSHOT
ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.7
```

With _anonymous scraping_ allowed, you can now easily view the scrape results directly in the browser by navigating to
Expand All @@ -38,7 +38,7 @@ scrape_configs:
In case you want to enforce authenticated scrapes only, use this configuration instead:
```
docker run -p 8080:8080 \
ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.7-SNAPSHOT
ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.7
```

Scraping now requires a GitHub access token, otherwise the service will respond with 401/Unauthorized.
Expand Down
2 changes: 1 addition & 1 deletion RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
* Support open metrics format (`Accept: application/openmetrics-text`)

```
docker pull ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.7-SNAPSHOT
docker pull ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.7
```

0 comments on commit 6e0da63

Please sign in to comment.