From 1cc7180cbe16ac30d52300278ed4d6a7a3aa2caf Mon Sep 17 00:00:00 2001 From: Dave Herder <27025660+dherder@users.noreply.github.com> Date: Wed, 16 Oct 2024 08:18:05 -0700 Subject: [PATCH 1/6] Create fleet.mdx modify base managed distribution instructions, create fleet.mdx file. --- .../mdm-deployment/partners/fleet.mdx | 193 ++++++++++++++++++ 1 file changed, 193 insertions(+) create mode 100644 src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx new file mode 100644 index 00000000000000..ac241068917254 --- /dev/null +++ b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx @@ -0,0 +1,193 @@ +--- +pcx_content_type: how-to +title: Fleet +sidebar: + order: 1 +--- + + + +## Windows + +The WARP Client for Windows allows for an automated install via tools like Intune, AD, or any script or management tool that can execute a `.msi` file. + +### Download the WARP client installer for Windows + +Visit the [Download page](/cloudflare-one/connections/connect-devices/warp/download-warp/#windows) to review system requirements and download the installer for your operating system. + +### Upload to Fleet + +To add the WARP client installer package for distribution to your hosts enrolled in Fleet: + +1. + + +### Install WARP + +To install the WARP client, run the following command: + +```bash +msiexec /i "Cloudflare_WARP_.msi" /qn ORGANIZATION="your-team-name" SUPPORT_URL="http://support.example.com" +``` + +Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) for a description of each argument. + +### Uninstall WARP + +To uninstall the WARP client: + +1. First, locate the `.msi` package with the following PowerShell command: + +```powershell +Get-WmiObject Win32_Product | Where-Object { $_.Name -match "WARP" } | Sort-Object -Property Name | Format-Table IdentifyingNumber, Name, LocalPackage -AutoSize +``` + +```txt output +IdentifyingNumber Name LocalPackage +----------------- ---- ------------ +{5RA4DJWK-13D8-2NSX-QRF8-UANLODWD6D90} Cloudflare WARP C:\WINDOWS\Installer\3f476db.msi +``` + +2. You can then use the LocalPackage output in the uninstall command. For example, + +```powershell +msiexec /x C:\WINDOWS\Installer\.msi /quiet +``` + +### Update the configuration + +The on-disk configuration of the Windows client can be changed at any time by modifying or replacing the contents of `C:\ProgramData\Cloudflare\mdm.xml`. The format of this file is as follows: + +```xml + + organization + your-team-name + onboarding + + +``` + +Changes to this file are processed immediately by the WARP client. + +### Authenticate in embedded browser + +By default WARP will use the user's default browser to perform registration. You can override the default setting to instead authenticate users in an embedded browser. The embedded browser will work around any protocol handler issues that may prevent the default browser from launching. + +To use an embedded browser: + +1. Download and install WebView2 by following the [Microsoft instructions](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section). +2. Add a registry key with the following command: + ```txt + REG ADD HKLM\SOFTWARE\Cloudflare\CloudflareWARP /f /v UseWebView2 /t REG_SZ /d y + ``` + +The WARP client will now launch WebView2 when the user is registering their device with Zero Trust. + +## macOS + +The Cloudflare WARP macOS client allows for an automated install via tools like Jamf, Intune, Kandji, or JumpCloud or any script or management tool that can place a `com.cloudflare.warp.plist` file in `/Library/Managed Preferences` on a supported macOS device. Additionally this plist can be wrapped in a `.mobileconfig`. + +### Create `plist` file + +1. [Download](/cloudflare-one/static/mdm/com.cloudflare.warp.plist) an example `com.cloudflare.warp.plist` file. + +2. Modify the file with your desired [deployment arguments](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/). + +3. (Optional) If you want to manually place the file in `/Library/Managed Preferences` (rather than use a management tool), convert the `plist` into binary format: + +```sh +plutil -convert binary1 com.cloudflare.warp.plist +``` + +The plist must be pushed by an MDM tool in order to persist after reboot. Manually-placed files will be automatically deleted by the OS. + +### Create `mobileconfig` file + +1. [Download](/cloudflare-one/static/mdm/CloudflareWARP.mobileconfig) an example `.mobileconfig` file. + +2. Run `uuidgen` from your macOS Terminal. This will generate a value for `PayloadUUID`, which you can use to replace the default value used for `PayloadUUID`. + +3. Modify the file with your desired [deployment arguments](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/). + +## Linux + +The WARP Client for Linux allows for an automated install via the presence of an `mdm.xml` file in `/var/lib/cloudflare-warp`. + +The format of `/var/lib/cloudflare-warp/mdm.xml` is as follows: + +```xml + + organization + your-team-name + +``` + +Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) for a list of accepted arguments. + +## iOS + +:::note[Migrate from 1.1.1.1] + +The legacy iOS client, [1.1.1.1: Faster Internet](https://apps.apple.com/us/app/1-1-1-1-faster-internet/id1423538627), is becoming the Cloudflare One Agent. Learn more in our [migration guide](/cloudflare-one/connections/connect-devices/warp/download-warp/cloudflare-one-agent-migration/). +::: + +The Cloudflare WARP iOS client, known in the App Store as [Cloudflare One Agent](https://apps.apple.com/us/app/cloudflare-one-agent/id6443476492), allows for an automated install via tools like Jamf, Intune, or SimpleMDM. + +To proceed with the installation, here is an example of the XML code you will need: + +```xml + + organization + your-team-name + auto_connect + 1 + switch_locked + + service_mode + warp + support_url + https://support.example.com + +``` + +Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) for a description of each argument. + +## Android + +:::note[Migrate from 1.1.1.1] + +The legacy Android client, [1.1.1.1 + WARP: Safer Internet](https://play.google.com/store/apps/details?id=com.cloudflare.onedotonedotonedotone), is becoming the Cloudflare One Agent. Learn more in our [migration guide](/cloudflare-one/connections/connect-devices/warp/download-warp/cloudflare-one-agent-migration/). +::: + +The Cloudflare WARP Android client, known in the Google Play store as [Cloudflare One Agent](https://play.google.com/store/apps/details?id=com.cloudflare.cloudflareoneagent), allows for an automated install via tools like Intune, Google Endpoint Manager, and others. + +To proceed with the installation, here is an example of the XML code you will need: + +```xml +organization +your-team-name +enable + +gateway_unique_id +your_gateway_doh_subdomain +service_mode +warp +support_url +https://support.example.com +``` + +If your MDM tool does not support XML, you may need to convert the XML to JSON. Here is an example below: + +```json +{ + "organization": "your-team-name", + "gateway_unique_id": "your_gateway_doh_subdomain", + "onboarding": true, + "switch_locked": true, + "auto_connect": 0, + "service_mode": "warp", + "support_url": "https://support.example.com" +} +``` + +Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) for a description of each value. From 807d146313a04d87bd3f0d4603bdd46b5aba4171 Mon Sep 17 00:00:00 2001 From: Dave Herder <27025660+dherder@users.noreply.github.com> Date: Thu, 17 Oct 2024 09:44:45 -0700 Subject: [PATCH 2/6] Added deployment instructions... ...for macOS, Windows, and Linux operating systems. --- .../mdm-deployment/partners/fleet.mdx | 194 +++++++----------- 1 file changed, 72 insertions(+), 122 deletions(-) diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx index ac241068917254..14902a01c6ce17 100644 --- a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx @@ -4,190 +4,140 @@ title: Fleet sidebar: order: 1 --- +## macOS +### Create a custom `.mobileconfig` file -## Windows +1. [Download](/cloudflare-one/static/mdm/CloudflareWARP.mobileconfig) an example `.mobileconfig` file. -The WARP Client for Windows allows for an automated install via tools like Intune, AD, or any script or management tool that can execute a `.msi` file. - -### Download the WARP client installer for Windows +2. [Download](https://imazing.com/profile-editor/download) iMazing Profile Editor and open the downloaded `.mobileconfig` file. -Visit the [Download page](/cloudflare-one/connections/connect-devices/warp/download-warp/#windows) to review system requirements and download the installer for your operating system. +3. Modify the file with your desired [deployment arguments](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/). -### Upload to Fleet -To add the WARP client installer package for distribution to your hosts enrolled in Fleet: +### Upload `.mobileconfig` file to Fleet -1. +1. In the Fleet admin console, navigate to the Controls tab. +2. From the Teams dropdown, select the team (group of hosts) that require deployment of the `.mobileconfig`. -### Install WARP +3. Select "OS settings> Custom settings". -To install the WARP client, run the following command: +4. Click "+ Add profile" and upload the custom `.mobileconfig`. -```bash -msiexec /i "Cloudflare_WARP_.msi" /qn ORGANIZATION="your-team-name" SUPPORT_URL="http://support.example.com" -``` +5. If the profile should be applied to all hosts in the team, select "All hosts". If the profile should be deployed to a subset of the hosts in the team, choose "Custom" and leverage labels (dynamic or static) to define inclusions or exclusions. Upon clicking "Add profile", the defined hosts will immediately receive the profile. -Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) for a description of each argument. -### Uninstall WARP +### Download the WARP installer pkg for macOS -To uninstall the WARP client: +Visit the [Download page](/cloudflare-one/connections/connect-devices/warp/download-warp/#macos) to review system requirements and download the installer for your operating system. -1. First, locate the `.msi` package with the following PowerShell command: -```powershell -Get-WmiObject Win32_Product | Where-Object { $_.Name -match "WARP" } | Sort-Object -Property Name | Format-Table IdentifyingNumber, Name, LocalPackage -AutoSize -``` +### Upload the WARP installer pkg to Fleet -```txt output -IdentifyingNumber Name LocalPackage ------------------ ---- ------------ -{5RA4DJWK-13D8-2NSX-QRF8-UANLODWD6D90} Cloudflare WARP C:\WINDOWS\Installer\3f476db.msi -``` +To add the WARP client installer package for distribution to your hosts enrolled in Fleet: -2. You can then use the LocalPackage output in the uninstall command. For example, +1. In the Fleet admin console, navigate to the Software tab. -```powershell -msiexec /x C:\WINDOWS\Installer\.msi /quiet -``` +2. From the Teams dropdown, select the team (group of hosts) that require deployment of the the WARP client. -### Update the configuration +3. Select "Add Software" and upload the .pkg that was previously downloaded. -The on-disk configuration of the Windows client can be changed at any time by modifying or replacing the contents of `C:\ProgramData\Cloudflare\mdm.xml`. The format of this file is as follows: -```xml - - organization - your-team-name - onboarding - - -``` +### Install the WARP pkg for macOS -Changes to this file are processed immediately by the WARP client. +Please refer to [Fleet's current documentation](https://fleetdm.com/guides/deploy-software-packages) for the various methods (REST API, UI, GitOps) to add a software package for deployment. -### Authenticate in embedded browser -By default WARP will use the user's default browser to perform registration. You can override the default setting to instead authenticate users in an embedded browser. The embedded browser will work around any protocol handler issues that may prevent the default browser from launching. +### Uninstall WARP -To use an embedded browser: +To uninstall the Fleet-deployed WARP client: -1. Download and install WebView2 by following the [Microsoft instructions](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section). -2. Add a registry key with the following command: - ```txt - REG ADD HKLM\SOFTWARE\Cloudflare\CloudflareWARP /f /v UseWebView2 /t REG_SZ /d y - ``` +1. Select the host in Fleet that requires the WARP client to be uninstalled. +2. From the host's "Software" tab, search for "Cloudflare". +3. In the "Actions" menu, select "Uninstall". -The WARP client will now launch WebView2 when the user is registering their device with Zero Trust. -## macOS +## Windows -The Cloudflare WARP macOS client allows for an automated install via tools like Jamf, Intune, Kandji, or JumpCloud or any script or management tool that can place a `com.cloudflare.warp.plist` file in `/Library/Managed Preferences` on a supported macOS device. Additionally this plist can be wrapped in a `.mobileconfig`. -### Create `plist` file +### Download the WARP client installer for Windows -1. [Download](/cloudflare-one/static/mdm/com.cloudflare.warp.plist) an example `com.cloudflare.warp.plist` file. +Visit the [Download page](/cloudflare-one/connections/connect-devices/warp/download-warp/#windows) to review system requirements and download the installer for your operating system. -2. Modify the file with your desired [deployment arguments](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/). -3. (Optional) If you want to manually place the file in `/Library/Managed Preferences` (rather than use a management tool), convert the `plist` into binary format: +### Upload the WARP installer msi to Fleet -```sh -plutil -convert binary1 com.cloudflare.warp.plist -``` +To add the WARP client installer package for distribution to your hosts enrolled in Fleet: -The plist must be pushed by an MDM tool in order to persist after reboot. Manually-placed files will be automatically deleted by the OS. +1. In the Fleet admin console, navigate to the Software tab. -### Create `mobileconfig` file +2. From the Teams dropdown, select the team (group of hosts) that require deployment of the the WARP client. -1. [Download](/cloudflare-one/static/mdm/CloudflareWARP.mobileconfig) an example `.mobileconfig` file. +3. Select "Add Software" and upload the .msi that was previously downloaded. -2. Run `uuidgen` from your macOS Terminal. This will generate a value for `PayloadUUID`, which you can use to replace the default value used for `PayloadUUID`. -3. Modify the file with your desired [deployment arguments](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/). +### Install the WARP msi for Windows -## Linux +Please refer to [Fleet's current documentation](https://fleetdm.com/guides/deploy-software-packages) for the various methods (REST API, UI, GitOps) to add a software package for deployment. -The WARP Client for Linux allows for an automated install via the presence of an `mdm.xml` file in `/var/lib/cloudflare-warp`. -The format of `/var/lib/cloudflare-warp/mdm.xml` is as follows: +### Configure the WARP client software package during upload -```xml - - organization - your-team-name - -``` +When defining the WARP software package in Fleet, optionally choose whether the package is enabled for Self-service. -Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) for a list of accepted arguments. +To install the WARP client, set the Install Script as follows, swapping out "example" for your organization and support values: -## iOS +``` +$logFile = "${env:TEMP}/fleet-install-software.log" -:::note[Migrate from 1.1.1.1] +try { -The legacy iOS client, [1.1.1.1: Faster Internet](https://apps.apple.com/us/app/1-1-1-1-faster-internet/id1423538627), is becoming the Cloudflare One Agent. Learn more in our [migration guide](/cloudflare-one/connections/connect-devices/warp/download-warp/cloudflare-one-agent-migration/). -::: +$installProcess = Start-Process msiexec.exe ` + -ArgumentList "/quiet /norestart ORGANIZATION=example SUPPORT_URL=https://example.com /lv ${logFile} /i `"${env:INSTALLER_PATH}`"" ` + -PassThru -Verb RunAs -Wait -The Cloudflare WARP iOS client, known in the App Store as [Cloudflare One Agent](https://apps.apple.com/us/app/cloudflare-one-agent/id6443476492), allows for an automated install via tools like Jamf, Intune, or SimpleMDM. +Get-Content $logFile -Tail 500 -To proceed with the installation, here is an example of the XML code you will need: +Exit $installProcess.ExitCode -```xml - - organization - your-team-name - auto_connect - 1 - switch_locked - - service_mode - warp - support_url - https://support.example.com - +} catch { + Write-Host "Error: $_" + Exit 1 +} ``` Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) for a description of each argument. -## Android -:::note[Migrate from 1.1.1.1] +### Uninstall WARP + +To uninstall the Fleet-deployed WARP client: + +1. Select the host in Fleet that requires the WARP client to be uninstalled. +2. From the host's "Software" tab, search for "Cloudflare". +3. In the "Actions" menu, select "Uninstall". + -The legacy Android client, [1.1.1.1 + WARP: Safer Internet](https://play.google.com/store/apps/details?id=com.cloudflare.onedotonedotonedotone), is becoming the Cloudflare One Agent. Learn more in our [migration guide](/cloudflare-one/connections/connect-devices/warp/download-warp/cloudflare-one-agent-migration/). -::: +## Linux -The Cloudflare WARP Android client, known in the Google Play store as [Cloudflare One Agent](https://play.google.com/store/apps/details?id=com.cloudflare.cloudflareoneagent), allows for an automated install via tools like Intune, Google Endpoint Manager, and others. +The WARP Client for Linux allows for an automated install via the presence of an `mdm.xml` file in `/var/lib/cloudflare-warp`. -To proceed with the installation, here is an example of the XML code you will need: +The format of `/var/lib/cloudflare-warp/mdm.xml` is as follows: ```xml -organization -your-team-name -enable - -gateway_unique_id -your_gateway_doh_subdomain -service_mode -warp -support_url -https://support.example.com + + organization + your-team-name + ``` -If your MDM tool does not support XML, you may need to convert the XML to JSON. Here is an example below: - -```json -{ - "organization": "your-team-name", - "gateway_unique_id": "your_gateway_doh_subdomain", - "onboarding": true, - "switch_locked": true, - "auto_connect": 0, - "service_mode": "warp", - "support_url": "https://support.example.com" -} -``` +Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) for a list of accepted arguments. + +### Run scripts on Linux hosts + +Fleet allows script execution on hosts. In order to deploy the WARP client, please refer to [Cloudflare's documentation](https://pkg.cloudflareclient.com/) for your specific Linux platform. + +In order to execute a script on a Fleet managed Linux host, please refer to the [Fleet documentation on script execution](https://fleetdm.com/guides/scripts). -Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) for a description of each value. From f7f906d59c67a9fcda869236a7d4058f827c5651 Mon Sep 17 00:00:00 2001 From: Claire W <78226508+crwaters16@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:55:47 -0500 Subject: [PATCH 3/6] Apply suggestions from code review Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> --- .../warp/deployment/mdm-deployment/partners/fleet.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx index 14902a01c6ce17..48db67ae4de8c9 100644 --- a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx @@ -40,7 +40,7 @@ To add the WARP client installer package for distribution to your hosts enrolled 1. In the Fleet admin console, navigate to the Software tab. -2. From the Teams dropdown, select the team (group of hosts) that require deployment of the the WARP client. +2. From the Teams dropdown, select the team (group of hosts) that require deployment of the WARP client. 3. Select "Add Software" and upload the .pkg that was previously downloaded. @@ -73,7 +73,7 @@ To add the WARP client installer package for distribution to your hosts enrolled 1. In the Fleet admin console, navigate to the Software tab. -2. From the Teams dropdown, select the team (group of hosts) that require deployment of the the WARP client. +2. From the Teams dropdown, select the team (group of hosts) that require deployment of the WARP client. 3. Select "Add Software" and upload the .msi that was previously downloaded. From 55665e3dca3f7070b7e421f7b95ffd7b8a0820af Mon Sep 17 00:00:00 2001 From: ranbel <101146722+ranbel@users.noreply.github.com> Date: Mon, 21 Oct 2024 14:59:24 -0400 Subject: [PATCH 4/6] PCX content review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Made changes to align with our [documentation style guide](https://developers.cloudflare.com/style-guide/). - Removed reference to third-party .mobileconfig editor, as we’re not in the position to recommend any particular tool. - Reorganize Windows section to align with Fleet instructions in https://fleetdm.com/guides/deploy-software-packages#step-by-step-instructions. --- .../mdm-deployment/partners/fleet.mdx | 126 +++++++----------- 1 file changed, 46 insertions(+), 80 deletions(-) diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx index 48db67ae4de8c9..c4010fac076f2a 100644 --- a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx @@ -4,98 +4,77 @@ title: Fleet sidebar: order: 1 --- -## macOS - - -### Create a custom `.mobileconfig` file - -1. [Download](/cloudflare-one/static/mdm/CloudflareWARP.mobileconfig) an example `.mobileconfig` file. -2. [Download](https://imazing.com/profile-editor/download) iMazing Profile Editor and open the downloaded `.mobileconfig` file. +This guide covers how to deploy the Cloudflare WARP client using [Fleet](https://fleetdm.com/) device management software. -3. Modify the file with your desired [deployment arguments](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/). - - -### Upload `.mobileconfig` file to Fleet - -1. In the Fleet admin console, navigate to the Controls tab. +## macOS -2. From the Teams dropdown, select the team (group of hosts) that require deployment of the `.mobileconfig`. +### 1. Create a custom MDM file -3. Select "OS settings> Custom settings". +1. [Download](/cloudflare-one/static/mdm/CloudflareWARP.mobileconfig) an example `.mobileconfig` file. +2. Modify the file with your desired [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/). -4. Click "+ Add profile" and upload the custom `.mobileconfig`. +### 2. Upload MDM file to Fleet -5. If the profile should be applied to all hosts in the team, select "All hosts". If the profile should be deployed to a subset of the hosts in the team, choose "Custom" and leverage labels (dynamic or static) to define inclusions or exclusions. Upon clicking "Add profile", the defined hosts will immediately receive the profile. +1. In the Fleet admin console, go to **Controls**. +2. From the **Teams** dropdown, select the team (group of hosts) that requires Cloudflare WARP. +3. Select **OS settings** > **Custom settings**. +4. Select **Add profile** and upload the custom `.mobileconfig`. +5. Select the hosts which require Cloudflare WARP: + - **All hosts**: Deploys WARP to all hosts in the team. + - **Custom**: Deploys WARP to a subset of the hosts in the team. Use [labels](https://fleetdm.com/guides/managing-labels-in-fleet#basic-article) to define the hosts that should be included or excluded. +6. Select **Add profile**. +The defined hosts will immediately receive the deployment profile, but WARP is not yet installed. -### Download the WARP installer pkg for macOS +### 3. Download WARP package for macOS Visit the [Download page](/cloudflare-one/connections/connect-devices/warp/download-warp/#macos) to review system requirements and download the installer for your operating system. - -### Upload the WARP installer pkg to Fleet +### 4. Upload WARP package to Fleet To add the WARP client installer package for distribution to your hosts enrolled in Fleet: -1. In the Fleet admin console, navigate to the Software tab. - -2. From the Teams dropdown, select the team (group of hosts) that require deployment of the WARP client. - -3. Select "Add Software" and upload the .pkg that was previously downloaded. - - -### Install the WARP pkg for macOS +1. In the Fleet admin console, go to **Software**. +2. From the **Teams** dropdown, select the team (group of hosts) that requires Cloudflare WARP. +3. Select **Add Software** and upload the `.pkg` file that was previously downloaded. -Please refer to [Fleet's current documentation](https://fleetdm.com/guides/deploy-software-packages) for the various methods (REST API, UI, GitOps) to add a software package for deployment. +### 5. Install WARP with Fleet +To deploy the uploaded `.pkg` file to your hosts, refer to the [Fleet documentation](https://fleetdm.com/guides/deploy-software-packages). -### Uninstall WARP +### 6. Uninstall WARP with Fleet To uninstall the Fleet-deployed WARP client: -1. Select the host in Fleet that requires the WARP client to be uninstalled. -2. From the host's "Software" tab, search for "Cloudflare". -3. In the "Actions" menu, select "Uninstall". - +1. In the Fleet admin console, select the host that requires the WARP client to be uninstalled. +2. Go to **Software** and search for `Cloudflare`. +3. In **Actions**, select **Uninstall**. ## Windows - -### Download the WARP client installer for Windows +### 1. Download WARP package for Windows Visit the [Download page](/cloudflare-one/connections/connect-devices/warp/download-warp/#windows) to review system requirements and download the installer for your operating system. - -### Upload the WARP installer msi to Fleet +### 2. Upload WARP package to Fleet To add the WARP client installer package for distribution to your hosts enrolled in Fleet: -1. In the Fleet admin console, navigate to the Software tab. - -2. From the Teams dropdown, select the team (group of hosts) that require deployment of the WARP client. +1. In the Fleet admin console, go to **Software**. +2. From the **Teams** dropdown, select the team (group of hosts) that requires Cloudflare WARP. +3. Select **Add Software** and upload the `.msi` file that was previously downloaded. +4. (Optional) To allow users to install WARP from Fleet Desktop, select **Self-service**. +5. Select **Advanced options**. +6. In **Install script**, replace the default script with the following: -3. Select "Add Software" and upload the .msi that was previously downloaded. - - -### Install the WARP msi for Windows - -Please refer to [Fleet's current documentation](https://fleetdm.com/guides/deploy-software-packages) for the various methods (REST API, UI, GitOps) to add a software package for deployment. - - -### Configure the WARP client software package during upload - -When defining the WARP software package in Fleet, optionally choose whether the package is enabled for Self-service. - -To install the WARP client, set the Install Script as follows, swapping out "example" for your organization and support values: - -``` +```bash $logFile = "${env:TEMP}/fleet-install-software.log" try { $installProcess = Start-Process msiexec.exe ` - -ArgumentList "/quiet /norestart ORGANIZATION=example SUPPORT_URL=https://example.com /lv ${logFile} /i `"${env:INSTALLER_PATH}`"" ` + -ArgumentList "/quiet /norestart ORGANIZATION=your-team-name SUPPORT_URL=https://example.com /lv ${logFile} /i `"${env:INSTALLER_PATH}`"" ` -PassThru -Verb RunAs -Wait Get-Content $logFile -Tail 500 @@ -110,34 +89,21 @@ Exit $installProcess.ExitCode Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) for a description of each argument. +### 3. Install WARP with Fleet -### Uninstall WARP +To deploy the uploaded `.msi` file to your hosts, refer to the [Fleet documentation](https://fleetdm.com/guides/deploy-software-packages). -To uninstall the Fleet-deployed WARP client: +### 4. Uninstall WARP with Fleet -1. Select the host in Fleet that requires the WARP client to be uninstalled. -2. From the host's "Software" tab, search for "Cloudflare". -3. In the "Actions" menu, select "Uninstall". +To uninstall the Fleet-deployed WARP client: +1. In the Fleet admin console, select the host that requires the WARP client to be uninstalled. +2. Go to **Software** and search for `Cloudflare`. +3. In **Actions**, select **Uninstall**. ## Linux -The WARP Client for Linux allows for an automated install via the presence of an `mdm.xml` file in `/var/lib/cloudflare-warp`. - -The format of `/var/lib/cloudflare-warp/mdm.xml` is as follows: - -```xml - - organization - your-team-name - -``` - -Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) for a list of accepted arguments. - -### Run scripts on Linux hosts - -Fleet allows script execution on hosts. In order to deploy the WARP client, please refer to [Cloudflare's documentation](https://pkg.cloudflareclient.com/) for your specific Linux platform. - -In order to execute a script on a Fleet managed Linux host, please refer to the [Fleet documentation on script execution](https://fleetdm.com/guides/scripts). +Fleet allows you to [execute custom scripts](https://fleetdm.com/guides/scripts) on Linux hosts. Your script should: +1. Place an [`mdm.xml` file](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/#linux) in `/var/lib/cloudflare-warp/`. +2. Run the [WARP installation commands](https://pkg.cloudflareclient.com/) for your specific Linux platform. From cf82468d7bf231561328e384e34e78fe934840fb Mon Sep 17 00:00:00 2001 From: ranbel <101146722+ranbel@users.noreply.github.com> Date: Wed, 23 Oct 2024 17:37:41 -0400 Subject: [PATCH 5/6] add UI install instructions --- .../mdm-deployment/partners/fleet.mdx | 32 ++++++++++++++----- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx index c4010fac076f2a..c36d9762478537 100644 --- a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx @@ -41,15 +41,23 @@ To add the WARP client installer package for distribution to your hosts enrolled ### 5. Install WARP with Fleet -To deploy the uploaded `.pkg` file to your hosts, refer to the [Fleet documentation](https://fleetdm.com/guides/deploy-software-packages). +To deploy the uploaded `.pkg` file to your hosts: + +1. In the Fleet admin console, go to **Hosts**. +2. Select the host that requires the WARP client. +3. Go to **Software** and search for `Cloudflare`. +4. Select **Actions** > **Install**. + +Installation will happen automatically when the host comes online. To deploy with REST API or GitOps, refer to the [Fleet documentation](https://fleetdm.com/guides/deploy-software-packages). ### 6. Uninstall WARP with Fleet To uninstall the Fleet-deployed WARP client: -1. In the Fleet admin console, select the host that requires the WARP client to be uninstalled. -2. Go to **Software** and search for `Cloudflare`. -3. In **Actions**, select **Uninstall**. +1. In the Fleet admin console, go to **Hosts**. +2. Select the host that requires the WARP client to be uninstalled. +3. Go to **Software** and search for `Cloudflare`. +4. Select **Actions** > **Uninstall**. ## Windows @@ -91,15 +99,23 @@ Refer to [deployment parameters](/cloudflare-one/connections/connect-devices/war ### 3. Install WARP with Fleet -To deploy the uploaded `.msi` file to your hosts, refer to the [Fleet documentation](https://fleetdm.com/guides/deploy-software-packages). +To deploy the uploaded `.pkg` file to your hosts: + +1. In the Fleet admin console, go to **Hosts**. +2. Select the host that requires the WARP client. +3. Go to **Software** and search for `Cloudflare`. +4. Select **Actions** > **Install**. + +Installation will happen automatically when the host comes online. To deploy with REST API or GitOps, refer to the [Fleet documentation](https://fleetdm.com/guides/deploy-software-packages). ### 4. Uninstall WARP with Fleet To uninstall the Fleet-deployed WARP client: -1. In the Fleet admin console, select the host that requires the WARP client to be uninstalled. -2. Go to **Software** and search for `Cloudflare`. -3. In **Actions**, select **Uninstall**. +1. In the Fleet admin console, go to **Hosts**. +2. Select the host that requires the WARP client to be uninstalled. +3. Go to **Software** and search for `Cloudflare`. +4. Select **Actions** > **Uninstall**. ## Linux From 65c880cf482d67d04f5a3404339cce7a7a1198f8 Mon Sep 17 00:00:00 2001 From: ranbel <101146722+ranbel@users.noreply.github.com> Date: Tue, 12 Nov 2024 16:40:32 -0500 Subject: [PATCH 6/6] add example Linux script --- .../mdm-deployment/partners/fleet.mdx | 23 ++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx index c36d9762478537..6039f4a5871403 100644 --- a/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/partners/fleet.mdx @@ -119,7 +119,24 @@ To uninstall the Fleet-deployed WARP client: ## Linux -Fleet allows you to [execute custom scripts](https://fleetdm.com/guides/scripts) on Linux hosts. Your script should: +Fleet allows you to [execute custom scripts](https://fleetdm.com/guides/scripts) on Linux hosts. The following example script creates an [MDM file](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/#linux) and installs WARP on an Ubuntu 22.04 host: -1. Place an [`mdm.xml` file](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/#linux) in `/var/lib/cloudflare-warp/`. -2. Run the [WARP installation commands](https://pkg.cloudflareclient.com/) for your specific Linux platform. +```sh +#!/bin/sh + +# Write the mdm.xml file +touch /var/lib/cloudflare-warp/mdm.xml +echo -e "\n organization\n your-team-name\n +" > /var/lib/cloudflare-warp/mdm.xml + +# Add cloudflare gpg key +curl -fsSL https://pkg.cloudflareclient.com/pubkey.gpg | sudo gpg --yes --dearmor --output /usr/share/keyrings/cloudflare-warp-archive-keyring.gpg + +# Add this repo to your apt repositories +echo "deb [signed-by=/usr/share/keyrings/cloudflare-warp-archive-keyring.gpg] https://pkg.cloudflareclient.com/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/cloudflare-client.list + +# Install +sudo apt-get -y update && sudo apt-get -y install cloudflare-warp +``` + +To install WARP on other Linux distributions, refer to the [package repository](https://pkg.cloudflareclient.com/).