Skip to content

[Draft] Add documentation for Privacy Proxy#27724

Merged
patriciasantaana merged 7 commits intocloudflare:productionfrom
mgalicer:mgalicer/add-privacy-proxy-docs
Feb 3, 2026
Merged

[Draft] Add documentation for Privacy Proxy#27724
patriciasantaana merged 7 commits intocloudflare:productionfrom
mgalicer:mgalicer/add-privacy-proxy-docs

Conversation

@mgalicer
Copy link
Copy Markdown
Contributor

@mgalicer mgalicer commented Jan 19, 2026

Summary

Add net-new developer documentation for Privacy Proxy, a MASQUE-based forward proxy service for enterprise customers.

Documentation includes:

  • Overview and product landing page
  • Getting started guide
  • Concepts: how it works, deployment models, authentication, geolocation
  • Reference: HTTP headers, observability, client libraries

Screenshots (optional)

image

Documentation checklist

  • The change adheres to the documentation style guide.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.

Add developer documentation for Privacy Proxy, a MASQUE-based forward proxy
service for enterprise customers.

Documentation includes:
- Overview and product landing page
- Get started guide with Chaussette and curl examples
- Concepts: how it works, deployment models, authentication, geolocation
- Reference: HTTP headers, observability, client libraries

Co-authored-by: Claude <noreply@anthropic.com>
Copy link
Copy Markdown

@by-cf by-cf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm 👍

| Signal | Description |
|--------|-------------|
| Metrics | Connection counts, request rates, latency histograms, error rates |
| Traces | Per-request traces showing proxy processing time |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how much details we want to go into, but it may be worth mentioning traces are sampled (like 1%)?

Comment on lines +60 to +68
## Server-Timing header

Privacy Proxy includes a `Server-Timing` header in responses to help measure processing latency from the client side:

```http
Server-Timing: proxy;dur=12.5
```

The `dur` value is the processing time in milliseconds introduced by the proxy. Use this header as a client-side SLI (Service Level Indicator) to monitor proxy performance.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already mentioned in http-headers.mdx, probably can remove. However, it is observability related... I'll let you decide.

Comment on lines +60 to +62
<RelatedProduct header="1.1.1.1" href="/1.1.1.1/" product="1.1.1.1">
Cloudflare's public DNS resolver provides fast, private DNS resolution and integrates with Privacy Proxy for secure name resolution.
</RelatedProduct>
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of cloudflare products are related, but this one is related less so than Privacy Gateway and WARP. Maybe remove?

order: 3
---

This page lists open source libraries and tools you can use to connect to Privacy Proxy.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can also link a privacypass library: https://github.com/cloudflare/privacypass-ts

Comment thread src/content/docs/privacy-proxy/index.mdx Outdated
Comment thread src/content/docs/privacy-proxy/get-started.mdx Outdated
Comment thread src/content/docs/privacy-proxy/get-started.mdx Outdated
Comment thread src/content/docs/privacy-proxy/get-started.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/authentication.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/authentication.mdx
Comment thread src/content/docs/privacy-proxy/concepts/authentication.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/deployment-models.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/deployment-models.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/deployment-models.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/geolocation.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/deployment-models.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/deployment-models.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/geolocation.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/geolocation.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/how-it-works.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/how-it-works.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/how-it-works.mdx Outdated
Comment thread src/content/docs/privacy-proxy/get-started.mdx Outdated
Comment thread src/content/docs/privacy-proxy/get-started.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/observability.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/geolocation.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/authentication.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/authentication.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/authentication.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/authentication.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/deployment-models.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/how-it-works.mdx Outdated
Comment thread src/content/docs/privacy-proxy/concepts/how-it-works.mdx Outdated
Comment thread src/content/docs/privacy-proxy/reference/http-headers.mdx Outdated
@patriciasantaana patriciasantaana marked this pull request as ready for review February 3, 2026 17:57
@patriciasantaana patriciasantaana requested a review from a team as a code owner February 3, 2026 17:57
@patriciasantaana patriciasantaana merged commit 173bd86 into cloudflare:production Feb 3, 2026
3 checks passed
@github-actions github-actions Bot deleted the mgalicer/add-privacy-proxy-docs branch April 4, 2026 05:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants