Skip to content

Commit

Permalink
docs(readme): add note about badges being publicly accessible
Browse files Browse the repository at this point in the history
  • Loading branch information
bethesque committed Oct 2, 2017
1 parent 94cab58 commit cc6666b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For an sqlite database (only recommended for investigation/spikes, as it will be
* Apart from creating a database no further preparation is required.

## Using basic auth
Run your container with `PACT_BROKER_BASIC_AUTH_USERNAME` and `PACT_BROKER_BASIC_AUTH_PASSWORD` set to enable basic auth for the pact broker application.
Run your container with `PACT_BROKER_BASIC_AUTH_USERNAME` and `PACT_BROKER_BASIC_AUTH_PASSWORD` set to enable basic auth for the pact broker application. Note that the [verification status badges][badges] are not protected by basic auth, so that you may embed them in README markdown.

## Running with Docker Compose

Expand All @@ -57,3 +57,5 @@ curl -v http://$DOCKER_HOST # you can visit in your browser too!
```

_NOTE: this image should be modified before using in Production, in particular, the use of hard-coded credentials_

[badges]: https://github.com/pact-foundation/pact_broker/wiki/Provider-verification-badges

0 comments on commit cc6666b

Please sign in to comment.