From 9df18acc79dd012d705bf1696bac4c56b615011f Mon Sep 17 00:00:00 2001 From: Noah Talerman <47070608+noahtalerman@users.noreply.github.com> Date: Tue, 13 Jan 2026 16:39:31 -0500 Subject: [PATCH] YAML reference: Some `macos_setup` keys are cross-platform (#37680) - Document which keys are supported on which platforms. - Separate feature request to come up with a cross-platform name for `macos_setup` is here: https://github.com/fleetdm/fleet/issues/33059 --- docs/Configuration/yaml-files.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/Configuration/yaml-files.md b/docs/Configuration/yaml-files.md index 00055e3a37..c42c06cd64 100644 --- a/docs/Configuration/yaml-files.md +++ b/docs/Configuration/yaml-files.md @@ -462,17 +462,17 @@ To hide variable values in the API and UI, you can use Fleet's [custom variables ### macos_setup -The `macos_setup` section lets you control the out-of-the-box macOS [setup experience](https://fleetdm.com/guides/setup-experience) for hosts that use Automated Device Enrollment (ADE). +The `macos_setup` section lets you control the out-of-the-box [setup experience](https://fleetdm.com/guides/setup-experience). > **Experimental feature.** The `manual_agent_install` feature is undergoing rapid improvement, which may result in breaking changes to the API or configuration surface. It is not recommended for use in automated workflows. -- `bootstrap_package` is the URL to a bootstrap package. Fleet will download the bootstrap package (default: `""`). -- `manual_agent_install` specifies whether Fleet's agent (fleetd) will be installed as part of setup experience. (default: `false`) -- `enable_end_user_authentication` specifies whether or not to require end user authentication when the user first sets up their macOS host. +- `bootstrap_package` is the URL to a bootstrap package. Fleet will download the bootstrap package. Applies to macOS only (default: `""`). +- `manual_agent_install` specifies whether Fleet's agent (fleetd) will be installed as part of setup experience. Applies to macOS only (default: `false`) +- `enable_end_user_authentication` specifies whether or not to require end user authentication when the user first sets up their host. Applies to macOS, Windows, Linux, iOS/iPadOS, and Android. - `require_all_software` specifies whether to cancel setup on a macOS host if any software installs fail. -- `enable_release_device_manually` when enabled, you're responsible for sending the [`DeviceConfigured` command](https://developer.apple.com/documentation/devicemanagement/device-configured-command). End users will be stcuk in Setup Assistant until this command is sent. -- `macos_setup_assistant` is a path to a custom automatic enrollment (ADE) profile (.json). -- `script` is the path to a custom setup script to run after the host is first set up. +- `enable_release_device_manually` when enabled, you're responsible for sending the [`DeviceConfigured` command](https://developer.apple.com/documentation/devicemanagement/device-configured-command). End users will be stuck in Setup Assistant until this command is sent. Applies to Apple (macOS, iOS, iPadOS) hosts that automatically enroll via Apple Business Manager (ABM). +- `macos_setup_assistant` is a path to a custom automatic enrollment (ADE) profile (.json). Applies to macOS and iOS/iPadOS hosts. +- `script` is the path to a custom setup script to run after the host is first set up. Applies to macOS only. #### Example