From 0b3edcdaa6483a2c61b3cb8a0d950e7fac745cf6 Mon Sep 17 00:00:00 2001 From: Marko Lisica <83164494+marko-lisica@users.noreply.github.com> Date: Fri, 23 Jan 2026 16:37:33 +0100 Subject: [PATCH] [Guide] Set custom display name for software (#37696) Related: - #31354 In addition to the changes regarding the display name story, I updated the entire guide because the software details UI has changed slightly. I also made the instructions more concise. --------- Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com> --- articles/deploy-software-packages.md | 103 ++++++++------------------- articles/fleet-maintained-apps.md | 2 +- articles/install-app-store-apps.md | 12 ++-- 3 files changed, 36 insertions(+), 81 deletions(-) diff --git a/articles/deploy-software-packages.md b/articles/deploy-software-packages.md index 5cf95118a2..b8d559cfd4 100644 --- a/articles/deploy-software-packages.md +++ b/articles/deploy-software-packages.md @@ -18,23 +18,17 @@ Learn more about automatically installing software [the Automatically install so ## Add a custom package -* **Navigate to the Software page**: Click on the "Software" tab in the main navigation menu. - -* **Select a team**: Select a team "No team" to add a software package. - +* Navigate to the **Software** page. +* Select a team (or "No team") > Software cannot be added to "All teams." - -* Click the “Add Software” button in the top right corner. - -* Select the "Custom package" tab. - +* Click the **Add software** button in the top right corner. +* Select the **Custom package** tab. * Choose a file to upload. `.pkg`, `.msi`, `.exe`, `.rpm`, `.deb`, `.ipa`, `.tar.gz`, `.sh`, and `.ps1` files are supported. +* If you check the **Automatic install** box, Fleet will create a policy that checks for the existence of the software and will automatically trigger an install on hosts where the software does not exist. -* If you check the "Automatic install" box, Fleet will create a policy that checks for the existence of the software and will automatically trigger an install on hosts where the software does not exist. Note: Automatic install is not supported for payload-free packages (`.sh` and `.ps1` files). - -* To allow users to install the software from Fleet Desktop, check the "Self-service" checkbox. - -* To customize installer behavior, click on “Advanced options.” +> **Note:** Automatic install is not supported for payload-free packages (`.sh` and `.ps1` files). +* To allow users to install the software from Fleet Desktop, check the **Self-service** checkbox. +* To customize installer behavior, click on **Advanced options**. > After the initial package upload, all options, except for automatic install, can be modified. This includes the self-service setting, pre-install query, scripts, and the software package file. However, if the installer package needs to be replaced, the new package must be of the same file type (such as .pkg, .msi, .exe, .deb, .rpm, or .ipa) and for the same software as the original. Files in .dmg or .zip formats cannot be edited or uploaded for replacement. If you want to enable automatic installs after initial package upload, follow the steps in our [automatic software install guide](https://fleetdm.com/guides/automatic-software-install-in-fleet) to add an automatic install policy. @@ -100,39 +94,21 @@ Fleet also provides an `$UPGRADE_CODE` placeholder for MSIs. This placeholder is After a software package is added to a team, it can be installed on hosts via the UI. -* **Navigate to the Hosts page**: Click on the "Hosts" tab in the main navigation menu. - -* **Navigate to the Host details page**: Click the host you want to install the software package. - -* **Navigate to the Host software tab**: In the host details, search for the tab named “Software.” - -* **Find your software package**: Use the dropdown to select software “Available for install” or use the search bar to search for your software package by name. - -* **Install the software package on the host**: In the rightmost column of the table, click on “Actions” > “Install.” Installation will happen automatically or when the host comes online. - -* **Track installation status**: by either - - * Checking the status column in the host software table. - - * Navigate to the “Details” tab on the host details page and check the activity log. +* Navigate to the **Hosts** page. +* Select the host where you want to install the software package. +* Select **Software > Library** on the host details page. +* Use the dropdown to select software **Available for install** or use the search bar to search for your software by name. +* Select **Install** action in the rightmost column of the table. Install will happen automatically or when the host comes online. +* Check install status in the **Host > Software > Library > Status column** or the **Host > Details > Activity**. Once the package is installed, Fleet will automatically refetch the host's vitals and update the software inventory. ## Edit the package -* **Navigate to the Software page**: Click on the "Software" tab in the main navigation menu. - -* **Select a team**: Select a team (or "No team") to switch to the team whose software you want to edit. - -* **Find your software**: using the filters on the top of the table, you can choose between: - - * “Available for install” filters software can be installed on your hosts. - - * “Self-service” filters software that users can install from Fleet Desktop. - -* **Select software package**: Click on a software package to view details. - -* **Edit software package**: From the Actions menu, select "Edit." You can edit the package's [self-service](https://fleetdm.com/guides/software-self-service) status, change its target to different sets of hosts, or edit advanced options like pre-install query, install script, post-install script, and uninstall script. +* Navigate to the **Software** page, choose a team, and select the software you want to edit. + * Use a dropdown above the table to filter software **Available for install** or software available in **Self-service**. +* On the **Software details** page select **Actions > Edit software** to edit the software's [self-service](https://fleetdm.com/guides/software-self-service) status, change its target to different sets of hosts, or edit advanced options like pre-install query, install script, post-install script, and uninstall script. +* Select **Actions > Edit appearance** to edit the software's icon and display name. The icon and display name can be edited for software that is available for install. The new icon and display name will appear on the software list and details pages for the team where the package is uploaded, as well as on **My device > Self-service**. If the display name is not set, then the default name (ingested by osquery) will be used. > Editing the advanced options cancels all pending installations and uninstallations for that package. Installs and uninstalls currently running on a host will complete, but results won't appear in Fleet. The software's host counts will be reset. @@ -140,39 +116,20 @@ Once the package is installed, Fleet will automatically refetch the host's vital After a software package is installed on a host, it can be uninstalled on the host via the UI. -* **Navigate to the Hosts page**: Click on the "Hosts" tab in the main navigation menu. +* Navigate to the **Hosts** page. +* Select the host from which you want to uninstall the software package. +* Select **Software > Library** on the host details page. +* Use the dropdown to select software **Available for install** or use the search bar to search for your software by name. +* Select the **Install** action in the rightmost column of the table. Uninstall will happen automatically or when the host comes online. +* Check the uninstall status in the **Host > Software > Library > Status column** or the **Host > Details > Activity**. -* **Navigate to the Host details page**: Click the host you want to uninstall the software package. +## Delete the package -* **Navigate to the Host software tab**: In the host details, search for the tab named “Software.” +* Navigate to the **Software** page, choose a team, and select the software you want to edit. + * Use the dropdown above the table to filter software **Available for install** or software available in **Self-service**. +* On the **Software details** page, select the **Delete** icon next to the uploaded package file. -* **Find your software package**: Use the dropdown to select software “Available for install” or use the search bar to search for your software package by name. - -* **Uninstall the software package from the host**: In the rightmost column of the table, click on “Actions” > “Uninstall.” - -* **Track uninstallation status**: by either - - * Checking the status column in the host software table. - - * Navigate to the “Details” tab on the host details page and check the activity log. - -## Remove the package - -* **Navigate to the Software page**: Click on the "Software" tab in the main navigation menu. - -* **Select a team**: Select a team (or "No team") to switch to the team whose software you want to remove. - -* **Find your software**: using the filters on the top of the table, you can choose between: - - * “Available for install” filters software can be installed on your hosts. - - * “Self-service” filters software that users can install from Fleet Desktop. - -* **Select software package**: Click on a software package to view details. - -* **Remove software package**: From the Actions menu, select "Delete." Click the "Delete" button on the dialog. - -> Removing a software package from a team will cancel pending installs for hosts that are not in the middle of installing the software but will not uninstall the software from hosts where it is already installed. +> Deleting a software package from a team will cancel pending installs for hosts that are not in the middle of installing the software, but will not uninstall the software from hosts where it is already installed. ## Manage packages with Fleet's REST API @@ -184,7 +141,7 @@ Software packages can be managed via `fleetctl` using [GitOps](https://fleetdm.c Please refer to the documentation for [managing software with GitOps](https://fleetdm.com/docs/using-fleet/gitops#software), for a real-world example, [see how we manage software at Fleet](https://github.com/fleetdm/fleet/tree/main/it-and-security/teams). -> When managing software installers via GitOps, the Fleet server receiving GitOps requests (**not** the machine running fleetctl as part of the GitOps workflow) will download installers from the specified URLs directly. +> When managing software packages via GitOps, the Fleet server receiving GitOps requests (**not** the machine running fleetctl as part of the GitOps workflow) will download installers from the specified URLs directly. diff --git a/articles/fleet-maintained-apps.md b/articles/fleet-maintained-apps.md index 2571d01ba1..6d30a12aea 100644 --- a/articles/fleet-maintained-apps.md +++ b/articles/fleet-maintained-apps.md @@ -55,7 +55,7 @@ Fleet will run the uninstall script configured for the software title. For macOS The uninstallation process is also visible in the **Activities** section on the **Details** tab of this **Host Details** page. -## Update the app +## Update app To get the latest version of a Fleet-maintained app, diff --git a/articles/install-app-store-apps.md b/articles/install-app-store-apps.md index e8ecd7604e..6f4132971c 100644 --- a/articles/install-app-store-apps.md +++ b/articles/install-app-store-apps.md @@ -30,15 +30,13 @@ You can also manage which Google Play Store apps are available for self-service 3. Select **Add software > App store**, choose the Android platform, then enter the application ID. -## Edit or remove an app +## Edit or delete the app 1. In Fleet, head to the **Software** page and select a team in the teams dropdown. - -2. Search for the app you want to remove and select the app to head to it's **Software detail**s** page. - -3. To edit the app, on the **Software details** page, select the pencil (edit) icon. - -4. To remove the app, on the **Software details** page, select the trash can (delete) icon. +2. Search for the app you want to delete and select the app to head to its **Software details** page. +3. On the **Software details** page, select **Actions > Edit software** to edit the app's [self-service](https://fleetdm.com/guides/software-self-service) status and categories, or to change its target to different sets of hosts. +4 On the **Software details** page, select **Actions > Edit appearance** to edit the apps's icon and display name. The icon and display name can be edited for software that is available for install. The new icon and display name will appear on the software list and details pages for the team where the package is uploaded, as well as on **My device > Self-service**. If the display name is not set, then the default name (ingested by osquery) will be used. +5. To delete the app, on the **Software details** page, select the trash can (delete) icon. ## Install an app