Update self service docs (#47994)
Related to: - #39018 --------- Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com> Co-authored-by: Rachael Shaw <r@rachael.wtf>
This commit is contained in:
co-authored by
Noah Talerman
Rachael Shaw
parent
8e94d5e820
commit
e32bcd594a
@@ -56,15 +56,14 @@ _Available in Fleet Premium_
|
||||
End users can install every app in a category in one click from the **My device > Self-service** page:
|
||||
|
||||
1. Select a category from the dropdown above the software table.
|
||||
2. Select **Install all (n)** to install every app in the category, or **Install missing (n)** to install only the apps that aren't yet installed. The button label and count adjusts based on what's already installed on the device.
|
||||
2. Select **Install all** to install every app in the category. The count in the button adjusts based on what's already installed on the device.
|
||||
|
||||
Fleet queues each install as a separate operation; end users can monitor progress in the **Status** column. Software is installed in alphabetical order.
|
||||
Fleet queues each install as a separate operation. End users can monitor progress in the **Status** column. Software is installed in alphabetical order.
|
||||
|
||||
## Deploy self-service on iOS and iPadOS
|
||||
|
||||
Install this configuration profile to add the self-service web app to the home screen on iPhone and iPad.
|
||||
|
||||
|
||||
### Create the self-service configuration profile
|
||||
|
||||
On your Mac, open [iMazing Profile Editor](https://imazing.com/profile-editor). Create a new profile and add a **Web Clip** payload with these settings:
|
||||
|
||||
@@ -537,11 +537,6 @@ Currently, when a `.ipa` file is added in `packages`, Fleet adds software for bo
|
||||
|
||||
```yaml
|
||||
software:
|
||||
self_service_categories:
|
||||
- "🌎 Browsers"
|
||||
- "👬 Communication"
|
||||
- "🧰 Developer tools"
|
||||
- "💻 Productivity"
|
||||
packages:
|
||||
- path: ../lib/software-name.package.yml
|
||||
categories:
|
||||
@@ -593,20 +588,13 @@ software:
|
||||
- Engineering
|
||||
```
|
||||
|
||||
#### self_service_categories
|
||||
|
||||
_Available in Fleet Premium_
|
||||
|
||||
- `self_service_categories` is a list of custom self-service category names available on this fleet. End users can browse and install self-service software by category on the **My device > Self-service** page. Custom categories replace Fleet's previous fixed list and are managed per fleet.
|
||||
- Each category name must be unique within the fleet (case-insensitive) and is limited to 255 characters. Emojis are supported and are part of the name (e.g. `"🌎 Browsers"`).
|
||||
- When a fleet is created, Fleet seeds the following default categories that admins can rename or delete: **🌎 Browsers**, **👬 Communication**, **🧰 Developer tools**, **💻 Productivity**, **🔐 Security**, and **🛟 Support**.
|
||||
- `self_service_categories` is an optional key. When the key is included, the listed categories fully replace the fleet's existing self-service categories — any category not listed is deleted. When the key is omitted, existing categories are left unchanged. Software assigned to a deleted category is removed from that category but otherwise unaffected.
|
||||
|
||||
#### self_service, labels, categories, and setup_experience
|
||||
|
||||
- `self_service` specifies whether end users can install from **Fleet Desktop > Self-service** (default: `false`) on macOS or [self-service web app](https://fleetdm.com/learn-more-about/deploy-self-service-to-ios) on iOS/iPadOS.
|
||||
- `labels_include_all` targets hosts that **have all** of the specified labels. `labels_include_any` targets hosts that **have any** of the specified labels. `labels_exclude_any` targets hosts that **have none** of the specified labels. Only one of these fields can be set. If none are set, all hosts are targeted.
|
||||
- `categories` is a list of [self-service category names](#self-service-categories) on the fleet. Categories group self-service software on your end users' **Fleet Desktop > My device** page so that end users can filter by category and install all software in a category at once. Each value must match a category defined in the fleet's `self_service_categories`. If `categories` is empty, Fleet-maintained apps get their [default categories](https://github.com/fleetdm/fleet/tree/main/ee/maintained-apps/outputs) (creating them on the fleet if needed) and all other software only appears in the **All** group.
|
||||
- `categories` is a list of self-service category names. Categories group self-service software on your end users' **Fleet Desktop > My device** page so that end users can filter by category and install all software in a category at once.
|
||||
- Category names support emojis and can be up to 255 characters long. The uniqueness checks ignore emojis, so `"🌎 Browsers"` and `"🔍 Browsers"` are treated as the same name.
|
||||
- For Fleet-maintained apps, if `categories` is omitted, apps get their [default categories](https://github.com/fleetdm/fleet/tree/main/ee/maintained-apps/outputs). If `categories` is empty, default categories are removed. If custom categories are specified, apps don't get their default categories unless they're specified explicitly.
|
||||
- `setup_experience` installs the software when hosts enroll (default: `false`). Learn more in the [setup experience guide](https://fleetdm.com/guides/setup-experience).
|
||||
|
||||
### packages
|
||||
@@ -714,7 +702,7 @@ If the fields below are omitted, they default to values specified in [the app's
|
||||
|
||||
- `install_script.path` specifies the command Fleet will run on hosts to install software.
|
||||
- `uninstall_script.path` is the script Fleet will run on hosts to uninstall software.
|
||||
- `categories` is an array of categories, from [supported categories](#labels-and-categories).
|
||||
- `categories` is an array of categories, see [categories](#self-service-labels-categories-and-setup-experience).
|
||||
|
||||
## org_settings and settings
|
||||
|
||||
|
||||
Reference in New Issue
Block a user