You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: route pulls through Scarf gateway and add anonymized analytics disclosure
Switches the documented `docker run` commands from the canonical
`pactfoundation/pact-broker` to the Scarf Docker gateway URL
`docker.pactflow.io/pactfoundation/pact-broker`, so installs are
counted by default. Canonical `docker pull pactfoundation/pact-broker`
is now the documented opt-out, mirroring the swagger-ui
anonymized-analytics section style.
Adds a Scarf README pixel (HTML <img> form recommended by Scarf for
GitHub READMEs, pixel UUID f0adca49-1631-4f0b-8914-366ea390b5c8) and an
"Anonymized analytics" section disclosing what's collected and how to
opt out.
Part of PACT-6978.
No application, image, or CI changes.
If you want to try out a Pact Broker that can be accessed by all your teams, without having to fill in requisition forms and wait for 3 months, you can get a free trial at <ahref="https://pactflow.io/?utm_source=github&utm_campaign=pact_foundation_pact_broker_docker">pactflow.io</a>. Built by a group of core Pact maintainers, PactFlow is a fork of the OSS Pact Broker with extra goodies like an improved UI, user and team management, secrets, field level verification results and federated login. It's also fully supported, and that means when something goes wrong, *someone else* gets woken up in the middle of the afternoon to fix it...
@@ -36,7 +38,7 @@ Multi-platform images are available
36
38
-`--platform=linux/arm64`
37
39
38
40
```sh
39
-
docker run --rm -it --entrypoint /bin/sh pactfoundation/pact-broker:latest -c 'uname -sm'
41
+
docker run --rm -it --entrypoint /bin/sh docker.pactflow.io/pactfoundation/pact-broker:latest -c 'uname -sm'
40
42
```
41
43
42
44
## Prerequisites
@@ -276,7 +278,7 @@ docker run --rm \
276
278
-e PACT_BROKER_DATABASE_URL=<url> \
277
279
-e PACT_BROKER_MIGRATION_TARGET=<target> \
278
280
--entrypoint db-migrate \
279
-
pactfoundation/pact-broker
281
+
docker.pactflow.io/pactfoundation/pact-broker
280
282
```
281
283
282
284
To get the current version of the database run:
@@ -285,7 +287,7 @@ To get the current version of the database run:
285
287
docker run --rm \
286
288
-e PACT_BROKER_DATABASE_URL=<url> \
287
289
--entrypoint db-version \
288
-
pactfoundation/pact-broker
290
+
docker.pactflow.io/pactfoundation/pact-broker
289
291
```
290
292
# Vulnerability scanning
291
293
@@ -319,6 +321,16 @@ Until May 2023, the versioning scheme used the `M.m.p` from the Pact Broker gem,
319
321
320
322
See the [Troubleshooting][troubleshooting] page on the docs site.
321
323
324
+
## Anonymized analytics
325
+
326
+
`pactfoundation/pact-broker` uses [Scarf](https://scarf.sh/) to collect [anonymized download analytics](https://about.scarf.sh/about). These analytics help support the maintainers of this image and ONLY run when you pull the image through the Scarf gateway (the pull commands shown throughout this README). To opt out, pull the image directly from Docker Hub:
327
+
328
+
```sh
329
+
docker pull pactfoundation/pact-broker
330
+
```
331
+
332
+
Alternatively, block `static.scarf.sh` at the network level (or disable image loading in your browser when viewing this README) to disable the README impression pixel.
0 commit comments