Skip to content

Commit 378fa9b

Browse files
ranbelhyperlint-ai[bot]
authored andcommitted
[ZT] WARP QR code enrollment (#20904)
* QR code enrollment * Update src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/manual-deployment.mdx Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> * PM feedback * add beta pill * Apply suggestions from code review * Update src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/manual-deployment.mdx * Update src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/manual-deployment.mdx * browser support * Apply suggestions from code review --------- Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
1 parent 385b492 commit 378fa9b

File tree

1 file changed

+68
-3
lines changed

1 file changed

+68
-3
lines changed

src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/manual-deployment.mdx

Lines changed: 68 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar:
55
order: 2
66
---
77

8-
import { Details, GlossaryTooltip, Render } from "~/components";
8+
import { Details, GlossaryTooltip, Render, Badge } from "~/components";
99

1010
If you plan to direct your users to manually download and configure the WARP client, users will need to connect the client to your organization's Cloudflare Zero Trust instance.
1111

@@ -15,13 +15,13 @@ If you plan to direct your users to manually download and configure the WARP cli
1515

1616
## Windows, macOS, and Linux
1717

18-
### Enroll via the GUI
18+
### Enroll using the GUI
1919

2020
<Render file="warp/enroll-desktop" />
2121

2222
The device is now protected by your organization's Zero Trust policies.
2323

24-
### Enroll via the CLI
24+
### Enroll using the CLI
2525

2626
To enroll your device using the terminal:
2727

@@ -74,10 +74,75 @@ The device is now protected by your organization's Zero Trust policies. For more
7474

7575
## iOS, Android, and ChromeOS
7676

77+
### Enroll manually
78+
7779
<Render file="warp/enroll-ios-android" />
7880

7981
The device is now protected by your organization's Zero Trust policies.
8082

83+
### Enroll using a URL <Badge text="Beta" variant="caution"/>
84+
85+
<Details header="Feature availability">
86+
87+
| System | Availability | Minimum WARP version |
88+
| -------- | ------------ | -------------------- |
89+
| Windows || |
90+
| macOS || |
91+
| Linux || |
92+
| iOS || 1.10 |
93+
| Android || 2.4 |
94+
| ChromeOS || 2.4 |
95+
96+
</Details>
97+
98+
Administrators can provide users with a custom login URL that automatically fills in your organization's <GlossaryTooltip term="team name">team name</GlossaryTooltip> during device enrollment. Using a URL reduces the potential for error that comes with manual entry of the team name.
99+
100+
The WARP client supports URLs accessed through a direct link or with a URL handler such as a QR code. Direct links are currently only supported in Safari and Firefox. If your default browser is Chrome (or another unsupported browser), we recommend embedding the link in a QR code.
101+
102+
#### Generate a login URL
103+
104+
To generate a URL for device enrollment:
105+
106+
1. Copy the following link, replacing `<your-team-name>` with your Zero Trust <GlossaryTooltip term="team name">team name</GlossaryTooltip>:
107+
```txt
108+
cf1app://oneapp.cloudflare.com/team?name=<your-team-name>
109+
```
110+
2. (Optional) Use any QR code generator to embed the link in a QR code.
111+
3. Distribute the link or QR code to users.
112+
113+
#### Use the login URL
114+
115+
To enroll a device using a login URL:
116+
117+
1. [Download](/cloudflare-one/connections/connect-devices/warp/download-warp/) and install the Cloudflare One Agent app.
118+
2. Go to the [login URL](#generate-a-login-url) provided by your account administrator. To use a QR code, open the QR scanner app on your device and scan the QR code.
119+
120+
The Cloudflare One Agent app will open and start the onboarding flow.
121+
122+
:::note
123+
If the device is already enrolled in the account associated with this URL, Cloudflare One agent will bypass onboarding and show the **Connected** switch.
124+
:::
125+
126+
3. To complete the onboarding flow:
127+
128+
a. Review the privacy policy and select **Accept**.
129+
130+
b. On the **Enter team name** screen, confirm that the pre-populated <GlossaryTooltip term="team name">team name</GlossaryTooltip> matches your organization.
131+
132+
:::note[`Already Authenticated` error]
133+
If Cloudflare One Agent is logged in using another team name, you must first log out of that account. Go to **Settings** > **Account** to log out, and then retry the QR code or login link.
134+
:::
135+
136+
c. Complete the authentication steps required by your organization.
137+
138+
d. After authenticating, select **Install VPN Profile**.
139+
140+
e. In the **Connection request** popup window, select **OK**.
141+
142+
4. If you did not enable [auto-connect](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-settings/#auto-connect), manually turn on the switch to **Connected**.
143+
144+
The device is now protected by your organization's Zero Trust policies.
145+
81146
## Virtual machines
82147

83148
By default, virtual machines (VMs) are subject to the WARP client settings of the host. If you want to deploy a separate instance of WARP in a VM, you must configure the VM to operate in bridged networking mode.

0 commit comments

Comments
 (0)