Skip to content

Commit

Permalink
Adjust release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
skuzzle committed Dec 23, 2021
1 parent daeab17 commit bc4c7ce
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 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`
* Deploy it _on-premise_: `docker pull ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.8-SNAPSHOT`

## 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
ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.8-SNAPSHOT
```

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
ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.8-SNAPSHOT
```

Scraping now requires a GitHub access token, otherwise the service will respond with 401/Unauthorized.
Expand Down
5 changes: 3 additions & 2 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

[![Coverage Status](https://coveralls.io/repos/github/skuzzle/gh-prom-exporter/badge.svg?branch=master)](https://coveralls.io/github/skuzzle/gh-prom-exporter?branch=master) [![Twitter Follow](https://img.shields.io/twitter/follow/skuzzleOSS.svg?style=social)](https://twitter.com/skuzzleOSS)

* Support open metrics format (`Accept: application/openmetrics-text`)
* Clean up
* Add License (MIT)

```
docker pull ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.7
docker pull ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.8-SNAPSHOT
```
3 changes: 2 additions & 1 deletion readme/RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

[![Coverage Status](https://coveralls.io/repos/github/${github.user}/${github.name}/badge.svg?branch=${github.main-branch})](https://coveralls.io/github/${github.user}/${github.name}?branch=${github.main-branch}) [![Twitter Follow](https://img.shields.io/twitter/follow/skuzzleOSS.svg?style=social)](https://twitter.com/skuzzleOSS)

* Support open metrics format (`Accept: application/openmetrics-text`)
* Clean up
* Add License (MIT)

```
docker pull ${docker.image.name}:${project.version}
Expand Down

0 comments on commit bc4c7ce

Please sign in to comment.