docs: add Scarf telemetry pixel and route pulls through Scarf gateway - #337
Merged
Conversation
…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.
Per Scarf's GitHub obfuscation guidance (https://docs.scarf.sh/web-traffic/#obfuscation-on-github), GitHub's camo image proxy rewrites image URLs to camo.githubusercontent.com, which both strips the referrer and obscures which page is being viewed. Adding the `page=README.md` query param tags the pixel impression with its source page so it still attributes correctly.
…ssions Replaces the vague "anonymized download analytics" line with Scarf's documented categories — system and OS statistics, company information, and downloads by versions/tags — plus the explicit "no IP storage, no cookies, no PII" reassurance from Scarf's privacy policy. Links to the authoritative Scarf docs pages for both mechanisms (Docker Package and web-traffic pixel) so the disclosure stays accurate as their policy evolves.
Adds a "For more information" pointer to the Pact Foundation's central telemetry page from the Anonymized analytics section, so readers can find the canonical Pact-wide telemetry policy without having to chase Scarf's docs in isolation.
Reverts the enumerated Scarf-categories paragraph back to the tighter "anonymized download analytics" wording that mirrors swagger-ui's style. The data-categories detail belongs on docs.pact.io/telemetry, which is already linked from this section.
mefellows
approved these changes
Jun 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docker runcommands in the README through the Scarf Docker gateway atdocker.pactflow.io/pactfoundation/pact-broker, so image pulls from the documented examples are counted by default. The canonicaldocker pull pactfoundation/pact-brokeris now the documented opt-out, mirroring the swagger-ui anonymized-analytics pattern.<img>form withreferrerpolicy="no-referrer-when-downgrade") using pixel UUIDf0adca49-1631-4f0b-8914-366ea390b5c8.## Anonymized analyticssection disclosing what's collected and how to opt out.Unreleased.No application, image, or CI changes. Pact-Foundation maintainers' Scarf account owns the gateway and pixel.
Part of PACT-6978 under epic PACT-6977 (Scarf rollout across the Pact Broker repos).
Test plan
docker run --rm -it --entrypoint /bin/sh docker.pactflow.io/pactfoundation/pact-broker:latest -c 'uname -sm'complete successfully and appear on the Scarf Docker Package.docker pull pactfoundation/pact-brokercontinues to work unchanged for users who opt out.