[Privacy Gateway] onboarding guide #18646
Conversation
Deploying cloudflare-docs with
|
| Latest commit: |
a376513
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://37d058d7.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://kate-fixes-pgg.cloudflare-docs-7ou.pages.dev |
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
There was a problem hiding this comment.
2 files reviewed, 9 total issue(s) found.
Note: We resolved prior Hyperlint review comments because:
We updated our inline suggestion AI.
We do this to avoid keeping outdated or irrelevant comments around. We'll leave a new review with current comments below.
deadlypants1973
left a comment
deadlypants1973
left a comment
There was a problem hiding this comment.
Questions for Mari
mgalicer
left a comment
mgalicer
left a comment
There was a problem hiding this comment.
@deadlypants1973 thanks for the comments!
|
|
||
| DNS resolution uses [Cloudflare’s public resolver (1.1.1.1)](/1.1.1.1/) infrastructure for name resolution. | ||
|
|
||
| ### System architecture |
|
|
||
| A client requires configuration data (the region public key) to request tokens. The key is used to initialize the request for blinded tokens from the Privacy API. | ||
|
|
||
| The client should periodically refresh this public key, especially after IP address changes, since Cloudflare will use the IP address to map to the region. |
There was a problem hiding this comment.
this should all be "region-based public key"
|
|
||
| ## Egress IP management | ||
|
|
||
| The Egress Selection service uses the client IP address to select an egress IP address that roughly approximates that of the client. Clients do not have control over which egress IP address is used, up to manually changing their IP address or location. |
There was a problem hiding this comment.
you can cut the second part of the sentence.
i.e. "Clients do not have control over which egress IP address is used."
| 1. Allocating a PresharedToken PAT for test devices that is known only to the client provider and Cloudflare. This PAT is not associated with any production egress IP address. This PAT is allocated and distributed out-of-band between Cloudflare and the client provider. | ||
| 2. Configuring control plane mutual TLS authentication for PrivacyToken issuance. Refer to [Appendix A. Control API](#appendix-a-control-api) for more details about this API. | ||
|
|
||
| To test that the PAT is configured correctly, clients can run the following test cURL command: |
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
2 files reviewed, 2 total issue(s) found.
Note: We resolved prior Hyperlint review comments because:
We updated our inline suggestion AI.
We do this to avoid keeping outdated or irrelevant comments around. We'll leave a new review with current comments below.
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
| The first CONNECT request in a newly established tunnel must provide a PAT. Until a PAT has been presented, each CONNECT request fails with a HTTP `401` error. Details about authenticating with a PAT are in [client authentication](#client-authentication). | ||
|
|
||
| - Each CONNECT request can identify a target either by name or IP address. | ||
| - In the case of a name, Cloudflare’s DNS Resolver service will be queried to map the name to an IP address. |
There was a problem hiding this comment.
| - In the case of a name, Cloudflare’s DNS Resolver service will be queried to map the name to an IP address. | |
| - In the case of a name, Cloudflare's DNS Resolver service will be queried to map the name to an IP address. |
Issues:
- Style Guide - (cloudflare.NonStandardQuotes-warning) Use standard single quotes or double quotes only. Do not use any of the following quote mark types: ‘ ’ “ ”. In the text, we found this character: ’
Fix Explanation:
The non-standard single quote (‘) in 'Cloudflare’s' should be replaced with a standard single quote (') to adhere to the style guide.
7 participants
14563
Summary
adding privacy proxy onboarding guide
Documentation checklist