- A running postgresql database and the ability to connect to it (see POSTGRESQL.md).
- If on Mac, you will need the
gtimeoutfunction. You can install
brew install coreutils.
- Install Docker
- Prepare your environment if you are not running postgresql in a docker container. Setup the pact broker connection to the database through the use of the following environment variables. If you want to use a disposable postgres docker container just do
export DISPOSABLE_PSQL=truebefore running the script/test.sh.
For a postgres or mysql database:
* PACT_BROKER_DATABASE_ADAPTER (optional, defaults to 'postgres', see note below.) * PACT_BROKER_DATABASE_USERNAME * PACT_BROKER_DATABASE_PASSWORD * PACT_BROKER_DATABASE_HOST * PACT_BROKER_DATABASE_NAME
Adapter can be 'postgres' (recommended) or 'mysql2' (please note that future JSON search features may not be supported on mysql).
For an sqlite database (only recommended for investigation/spikes, as it will be disposed of with the container unless you mount it from an external file system):
- PACT_BROKER_DATABASE_ADAPTER (set to 'sqlite')
- PACT_BROKER_DATABASE_NAME (arbitrary name eg. pact_broker.sqlite)
- Test the pact broker environment by executing script/test.sh
-p 80:80to start the docker image, as some of the Rack middleware gets confused by receiving requests for other ports and will return a 404 otherwise (port forwarding does not rewrite headers).
- On OSX, if you are not using Docker native, use
docker-machine ip $(docker-machine active)to get the IP of the VirtualBox, and connect on port 80.
- The application makes use of the phusion passenger application server.
- Apart from creating a database no further preparation is required.
Using basic auth
To enable basic auth, run your container with:
Developers should use the read only credentials on their local machines, and the CI should use the read/write credentials. This will ensure that pacts and verification results are only published from your CI.
Note that the verification status badges are not protected by basic auth, so that you may embed them in README markdown.
If you are using the docker container within an AWS autoscaling group, and you need to make a heartbeat URL publicly available, set
PACT_BROKER_PUBLIC_HEARTBEAT=true. No database connection will be made during the execution of this endpoint.
Setting the log level
Set the environment variable
PACT_BROKER_LOG_LEVEL to one of
- PACT_BROKER_WEBHOOK_HOST_WHITELIST - a space delimited list of hosts (eg.
github.com), network ranges (eg.
10.2.3.41/24, or regular expressions (eg.
/.*\\.foo\\.com$/). Regular expressions should start and end with a
/to differentiate them from Strings. Note that backslashes need to be escaped with a second backslash. Please read the Webhook whitelists section of the Pact Broker configuration documentation to understand how the whitelist is used. Remember to use quotes around this value as it may have spaces in it.
- PACT_BROKER_WEBHOOK_SCHEME_WHITELIST - a space delimited list (eg.
http https). Defaults to
Other environment variables
- PACT_BROKER_BASE_EQUALITY_ONLY_ON_CONTENT_THAT_AFFECTS_VERIFICATION_RESULTS -
trueby default, may be set to
- PACT_BROKER_ORDER_VERSIONS_BY_DATE -
trueby default, may be set to
- PACT_BROKER_DISABLE_SSL_VERIFICATION -
falseby default, may be set to
General Pact Broker configuration and usage
Documentation for the Pact Broker application itself can be found in the Pact Broker wiki.
Running with Docker Compose
For a quick start with the Pact Broker and Postgres, we have an example Docker Compose setup you can use:
- Modify the
docker-compose.ymlfile as required.
docker-compose upto get a running Pact Broker and a clean Postgres database
Now you can access your local broker:
curl -v http://localhost # you can visit in your browser too! # SSL endpoint, note that URLs in response contain https:// protocol curl -v -k https://localhost:8443
NOTE: this image should be modified before using in Production, in particular, the use of hard-coded credentials
Running with Openshift
See pact-broker-openshift for an example config file.
See the Troubleshooting page on the wiki.