diff --git a/articles/fleet-4.69.0.md b/articles/fleet-4.69.0.md index 05254d6405..31d463b487 100644 --- a/articles/fleet-4.69.0.md +++ b/articles/fleet-4.69.0.md @@ -30,6 +30,10 @@ Fleet now supports [pulling user data](https://fleetdm.com/guides/foreign-vitals When a vulnerability has no primary CVSS score in the [National Vulnerability Database (NVD)](https://nvd.nist.gov/), Fleet now shows the secondary score instead. This gives Security Engineers better visibility into potential risk and helps prioritize remediation. +### Self-service software: uninstall + +End users can now [uninstall self-service software](https://fleetdm.com/guides/software-self-service#uninstall-self-service-software) via the My device UI. Software uninstalls initiated this way are tracked in Fleet's [audit log](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/reference/audit-logs.md#uninstalled_software). + ### Add custom packages in GitOps mode In GitOps mode, IT Admins can now use the UI to add a custom package and copy the corresponding YAML. This is useful for managing private software (like CrowdStrike) without a public URL. See the [manage software using GitOps guide](https://fleetdm.com/guides/gitops-mode-software) for more information. diff --git a/articles/software-self-service.md b/articles/software-self-service.md index 1b32d0276f..3db42477fc 100644 --- a/articles/software-self-service.md +++ b/articles/software-self-service.md @@ -2,81 +2,69 @@ ![Software self-service](../website/assets/images/articles/software-self-service-1600x900@2x.png) +_Available in Fleet Premium_ + Fleet’s self-service software feature empowers end users by allowing them to independently install approved software packages from a curated list through the Fleet Desktop “My device” page. This not only reduces the administrative burden on IT teams but also enhances user productivity and satisfaction. In this guide, we will walk you through the process of uploading, editing, and managing self-service software packages in Fleet, enabling seamless software distribution and management. -## Prerequisites - -* Fleet Premium is required for software self-service. - -> Software packages can be added to a specific team or to the "No team" category. The "No team" category is the default assignment for hosts that are not part of any specific team. +> Software packages can be added to a specific team or to "No team." "No team" is the default assignment for hosts that are not part of any specific team. ## Step-by-step instructions -### Adding a self-service software package +### Add self-service software -1. **Navigate to the Software page**: Click “Software” in the main navigation menu. -2. **Select a team**: Click the dropdown in the upper left corner of the page and click on the team to which you want to add the software package. -3. **Open the “Add software” modal**: Click the “Add software” button in the upper right corner of the page. -4. **Select a software package to upload**: Click “Choose file” in the “Add software” modal and select a software package from your computer. -5. **Select the hosts that you want to target**: Select "All hosts" if you want the software to be available to all your hosts. Select "Custom" to scope the software to specific groups of hosts based on label membership. You can select "Include any", which will scope the software to hosts that have any of the labels you select, or "Exclude any", which will scope the software to hosts that do _not_ have the selected labels. -6. **Advanced options**: If desired, click “Advanced options” to add a pre-install condition or post-install script to your software package. - * **Pre-install condition**: This is an osquery query that results in true. For example, you might require a specific software title to exist before installing additional extensions. - * **Post-install script**: This might be used to apply a license key, perform configuration tasks, or execute cleanup tasks after the software installation. -7. **Make the software package self-service**: Check the “Self-service” checkbox to mark the software package as self-service. -8. **Finish the upload**: Click the “Add software” button to finish the upload process. +1. Select the team to which you want to add the software package from the dropdown in the upper left corner of the page. +2. Select **Software** in the main navigation menu. +3. Press the **Add software** button in the upper right corner of the page. +4. Stay on the **Fleet-maintained** tab to add a Fleet-maintained App, or select one of the other tabs if you want to add an App Store (VPP) app or upload a custom software package. +5. Based on the type of software you would like to add, follow instructions for adding a [Fleet-maintained app](https://fleetdm.com/guides/fleet-maintained-apps#add-a-fleet-maintained-app), a [VPP app](https://fleetdm.com/guides/install-vpp-apps-on-macos-using-fleet#add-the-app-to-fleet), or a [custom package](https://fleetdm.com/guides/deploy-software-packages#add-a-custom-package). In each case, you can check the **Self-service** box when adding software to make it immediately available for self-service installation once added. -### Editing a self-service software package +### Enable self-service on existing software -1. **Navigate to the software details page for the software package**: Click “Software” in the main navigation menu. -2. **Select a team**: Click the dropdown in the upper left corner of the page and click on the team to which you added the software package. -3. **Filter by self-service**: To make it easier to find your software package, click on the dropdown to the left of the search bar and select “Self-service”. This will filter the results in the table to only show self-service software packages. If you still don’t see your software package, you can page through the results or search for your software package’s name in the search bar. -4. **Open the details page**: Click on the software package’s name. -5. **Open the actions dropdown**: Click on the “Actions” dropdown on the far right of the page. From here, you can download the software package, delete the software package, or click “Advanced options” to see the options you configured when adding the software package. +1. Select the team to which you added the software from the dropdown in the upper left corner of the page. +2. Select **Software** in the main navigation menu. +3. To make it easier to find your software, select the **All software** dropdown and choose **Available for install.** This filters the results in the table to show only software that can be installed on hosts. If you don’t see your software, page through the results or search for your software's name in the search bar. Once you find the software, select its title. +4. Press the ✏️ icon, then check **Self-service** in the **Options** section. You can also assign categories to your software, which will organize the display of software to end users on the **My device > Self-service** page. +5. Press the **Save** button. -### Enable self-service on an existing software package -Self-service is supported on custom packages, App Store apps, and Fleet-maintained apps. To enable self-service on a software package that is already added to Fleet: -1. **Navigate to the software details page for the software package**: Click “Software” in the main navigation menu. -2. **Select a team**: Click the dropdown in the upper left corner of the page and click on the team to which you added the software package. -3. **Find your package**: To make it easier to find your software package, click on the dropdown to the left of the search bar and select "Available for install". This will filter the results in the table to only show software packages that are able to be installed on hosts. If you still don’t see your software package, you can page through the results or search for your software package’s name in the search bar. Once you find the software package, click its the row in the table. -4. **Edit the package**: Click the "Actions" dropdown on the far right of the page, then click "Edit". In the "Edit software" modal, under "Options", check "Self-service". -5. **Select categories**: Optionally, you can assign the software package to one or more categories. Categories are used to group software on the end user's **My device > Self-service** page, which can make your self-service software easier to find for end users. Fleet-maintained apps have default categories that will be pre-selected when you enable self-service. These default categories can be changed when editing the app. +### Download a self-service software package -> Note: editing a software package's categories will _not_ cancel pending installs or uninstalls. +1. Select the team to which you added the software from the dropdown in the upper left corner of the page. +2. Select **Software** in the main navigation menu. +3. Select the **All software** dropdown and choose **Self-service.** Page through the results to find your software or search for the software package name in the search bar. +4. Select the row containing the software’s name. +5. Press the **Download** icon (next to the ✏️ icon) to the right of the software package's filename. -### Downloading a self-service software package +### Delete self-service software -1. **Navigate to the software details page for the software package**: Click “Software” in the main navigation menu. -2. **Select a team**: Click the dropdown in the upper left corner of the page and click on the team to which you added the software package. -3. **Filter by self-service**: Click on the dropdown to the left of the search bar and select “Self-service” and page through the results or search for your software package’s name in the search bar. -4. **Download the software package**: -* **Option 1**: Click on the down-arrow next to the software package name in the list of self-service software packages to start an immediate download. -* **Option 2**: Click on the software package’s name to open the details page. Click on the “Actions” dropdown on the far right of the page, and then click on “Download” to download the software package to your computer. +1. Select the team to which you added the software from the dropdown in the upper left corner of the page. +2. Select **Software** in the main navigation menu. +3. Select the **All software** dropdown and choose **Self-service.** Page through the results to find your software or search for the software package name in the search bar. +4. Select the row containing the software’s name. +5. Press the 🗑️ icon to the right of the software package's filename, then press the "Delete" button to confirm. -### Deleting a self-service software package +### Install self-service software -1. **Navigate to the software details page for the software package**: Click “Software” in the main navigation menu. -2. **Select a team**: Click the dropdown in the upper left corner of the page and click on the team to which you added the software package. -3. **Filter by self-service**: Click on the dropdown to the left of the search bar and select “Self-service” and page through the results or search for your software package’s name in the search bar. -4. **Open the details page**: Click on the software package’s name. -5. **Open the actions dropdown**: Click on the “Actions” dropdown on the far right of the page. -6. **Delete the software package**: Click on “Delete” to remove the software package from Fleet. Confirm the deletion if prompted. +To install self-service software on a host: -### Installing self-service software packages +1. From the Fleet desktop icon in the OS menu bar, select **Self-service.** This will open your default web browser to the list of self-service software packages available to install. +2. Select **Install** to the right of the software title you'd like to install. -To install the self-service software package on the host: +### Uninstall self-service software -1. **Navigate to the “Self-service” tab**: Click on the Fleet Desktop icon in the OS menu bar. Click “Self-service”. This will point your default web browser to the list of self-service software packages in the “My device” page. -2. **Install the self-service software package**: Click the “Install” button for the software package you want to install. +To uninstall self-service software on a host: -### Using the REST API for self-service software packages +1. From the Fleet desktop icon in the OS menu bar, select **Self-service.** This will open your default web browser to the list of self-service software packages available to uninstall. +2. Select **Uninstall** to the right of the software title you'd like to uninstall. -Fleet provides a REST API for managing software packages, including self-service software packages. Learn more about Fleet's [REST API](https://fleetdm.com/docs/rest-api/rest-api#software). +### Use the REST API for self-service software -### Managing self-service software packages with GitOps +Fleet provides a REST API for managing software, including self-service software packages. Learn more about Fleet's [REST API](https://fleetdm.com/docs/rest-api/rest-api#software). -To manage self-service software packages using Fleet's best practice GitOps, check out the `software` key in the [GitOps reference documentation](https://fleetdm.com/docs/using-fleet/gitops#software). +### Manage self-service software with GitOps -> Note: with GitOps enabled, software packages uploaded using the web UI will not persist. +To manage self-service software using GitOps, check out the `software` key in the [GitOps reference documentation](https://fleetdm.com/docs/using-fleet/gitops#software). + +> Note: When managing Fleet via GitOps, software packages uploaded using the web UI will not persist unless they are also added in GitOps using the `hash_sha256` field. ## Conclusion @@ -86,6 +74,6 @@ Fleet’s self-service software feature not only simplifies software management - +