Skip to content

Commit 3fe1e41

Browse files
committed
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.
1 parent 2402a45 commit 3fe1e41

2 files changed

Lines changed: 22 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<a name="unreleased"></a>
2+
### Unreleased
3+
4+
#### Features
5+
6+
* add Scarf analytics pixel to README and document telemetry / opt-out
7+
18
<a name="2.139.0-pactbroker2.119.0"></a>
29
### 2.139.0-pactbroker2.119.0 (2026-06-17)
310

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ This repository contains a Dockerized version of the [Pact Broker][pact-broker].
1717
[![size: arm64](https://badgen.net/docker/size/pactfoundation/pact-broker/latest-multi/arm64?icon=docker&label=size%3Aarm64)](https://hub.docker.com/r/pactfoundation/pact-broker)
1818
[![size: arm](https://badgen.net/docker/size/pactfoundation/pact-broker/latest-multi/arm?icon=docker&label=size%3Aarm)](https://hub.docker.com/r/pactfoundation/pact-broker)
1919

20+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=f0adca49-1631-4f0b-8914-366ea390b5c8" />
21+
2022
## In a hurry?
2123

2224
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 <a href="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
3638
- `--platform=linux/arm64`
3739

3840
```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'
4042
```
4143

4244
## Prerequisites
@@ -276,7 +278,7 @@ docker run --rm \
276278
-e PACT_BROKER_DATABASE_URL=<url> \
277279
-e PACT_BROKER_MIGRATION_TARGET=<target> \
278280
--entrypoint db-migrate \
279-
pactfoundation/pact-broker
281+
docker.pactflow.io/pactfoundation/pact-broker
280282
```
281283

282284
To get the current version of the database run:
@@ -285,7 +287,7 @@ To get the current version of the database run:
285287
docker run --rm \
286288
-e PACT_BROKER_DATABASE_URL=<url> \
287289
--entrypoint db-version \
288-
pactfoundation/pact-broker
290+
docker.pactflow.io/pactfoundation/pact-broker
289291
```
290292
# Vulnerability scanning
291293

@@ -319,6 +321,16 @@ Until May 2023, the versioning scheme used the `M.m.p` from the Pact Broker gem,
319321

320322
See the [Troubleshooting][troubleshooting] page on the docs site.
321323

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.
333+
322334
[docker]: https://docs.docker.com/install/
323335
[pact-broker]: https://github.com/pact-foundation/pact_broker
324336
[pact-broker-docker]: https://hub.docker.com/r/pactfoundation/pact-broker/

0 commit comments

Comments
 (0)