Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
* we have Dockerhub images too, since
  #1004,
* the FreeBSD package is not updated to 5.x, so it's less
  maintained as of now
* wording improvements
  • Loading branch information
gdubicki authored and bastelfreak committed Apr 15, 2024
1 parent 00595b6 commit 4481ffa
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ To see how to get it working with RedHat/Centos 7 check out these [docs](https:/

### Using Docker

We provide [an official Docker image in the GitHub Container Registry](https://github.com/orgs/voxpupuli/packages/container/package/puppetboard).

You must provide a secret key! Generate one for example by running `ruby -e "require 'securerandom'; puts SecureRandom.hex(32)"`.
We provide an official Docker image in:
* [GitHub Container Registry](https://github.com/orgs/voxpupuli/packages/container/package/puppetboard),
* [Dockerhub](https://hub.docker.com/r/voxpupuli/puppetboard).

You can run the app on your PuppetDB host with this command:

Expand All @@ -58,6 +58,7 @@ docker run -it \
--net=host \
ghcr.io/voxpupuli/puppetboard
```
Note: you must provide a secret key! Generate one for example by running `ruby -e "require 'securerandom'; puts SecureRandom.hex(32)"`.

Optionally you can set `PUPPETBOARD_URL_PREFIX` env variable to a value like `/puppetboard` to run the app under a URL prefix.

Expand Down Expand Up @@ -131,11 +132,14 @@ docker build -t puppetboard .

Actively maintained packages:

* [FreeBSD](https://www.freshports.org/www/py-puppetboard/)
maintained by [Romain Tartière](https://github.com/smortex)
* [OpenBSD](https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/www/puppetboard/)
maintained by [Sebastian Reitenbach](https://github.com/buzzdeee)

Less actively maintained packages:

* [FreeBSD](https://www.freshports.org/www/py-puppetboard/)
maintained by [Romain Tartière](https://github.com/smortex)

### Manually

You can also install the package from PyPI and configure a WSGI-capable application server to serve it.
Expand Down

0 comments on commit 4481ffa

Please sign in to comment.