# FAQ
Source: https://docs.zappl.co/about/FAQ
Frequently Asked Questions
> [accordion] What MDM platforms are supported?
>
> If your MDM platform allows you to deploy a Configuration Profile and a Package, Zappl will be supported. For advanced configuration and integration with your MDMs current application store i.e. Jamf Self Service, the MDM solution will need to support script deployments.
> [accordion] Where are the update packages hosted?
>
> With Zappl, we pride ourself on security and believe the safest place for you to obtain your application updates are from the vendors website itself. Our technology is designed to monitor your device, identify if an update is required, download from the software vendors website and install without impacting the users experience.
> [accordion] Do users need to logout or restart to apply the updates?
>
> **No.** We have always had a clear vision with Zappl, and that is the user experience must remain our focus. Zappl can be configured to your requirements as an administrator, but in its default form we will notify users that updates are required. If it is convenient, the apps will save the data, close the application, perform the update and re-open back where you were. **You don’t need to logout or restart** and it’s a great time to grab a coffee.
> [accordion] Does Zappl use Munki?
>
> **No.** Our aim was to develop Zappl from the ground up using Swift. We also wanted to move away from centrally hosting packages, and instead have the Zappl agent obtain any updates from the software vendors themselves.
> [accordion] How do we monitor our compliance?
>
> Zappl has a dedicated web portal that allows your team to monitor compliance of your devices. This is in the form of a compliance dashboard, device or application view, so you can quickly focus in on a group of users or applications. If you prefer a scheduled overview of your compliance, a PDF report can be scheduled to be emailed at your chosen date or time period.
> [accordion] Are un-managed applications updated too?
>
> **Yes.** Zappl runs independently to the MDM system and will monitor and update any 3rd party application that we currently support in our app catalog. With the increase of shadow IT practices within the enterprise, where users prefer to use their own applications and tools, we will actively patch these, even if they are not a company deployed application.
> [accordion] Are architecture-specific apps supported?
>
> **Yes.** We have a combination of universal and architecture-specific apps in our catalog. If the app has separate installers for Intel and Apple Silicon Macs, the Zappl agent determines the architecture of the computer and then downloads the relevant installer.
> [accordion] Does Zappl support apps that require Rosetta?
>
> **Yes.** Some apps are still designed to run only on Intel Macs. For this reason, we install Rosetta as part of the Zappl setup process on Apple Silicon Macs that don't already have it. This ensures these devices can install apps requiring Rosetta immediately after Zappl is installed.
> [accordion] What if the user is on a video call when Zappl runs?
>
> Zappl comes with a very customisable Configuration Profile that allows you to be very granular with your update notifications. In its simplest form you can configure Zappl not to run on a device if a particular application is in focus I.e. Zoom, Google Chat or Microsoft Teams. We can also schedule it to not interrupt users on specific times or days if you know you have a deadline to hit.
> [accordion] What security checks do you make?
>
> See our [Security](/about/security) page.
# Introduction
Source: https://docs.zappl.co/about/introduction
**Zappl is a comprehensive patch management solution written in Swift designed to provide automated updates for third-party applications across your macOS estate.**

## The Agent
> The product includes an agent, developed in Swift, that seamlessly manages automatic application updates, and a reporting portal that offers full visibility into the compliance levels across your entire estate.
> [card] [1100+ Apps Supported](https://zappl.co/app-catalog)
>
> We're always looking to add more applications.
> [card] MDM Integration
>
> Integrate into leading MDMs, and streamline deployment.
> [card] User Focused Experience
>
> Updates are installed while the user is logged-in and working.
> [card] Do Not Disturb
>
> Silently skip app updates if screen sharing or the camera is in use.
> [card] Update Deferrals
>
> Configure grace periods that users can use to delay app updates.
> [card] Custom Version Control
>
> Keep apps on particular versions with auto-update exclusions.
## The Portal
> Use the reporting portal to keep track of compliancy and generate automated scheduled email reports which comprehensively break down your estate compliancy levels.

> [card] Rich, detailed Reporting
>
> Generate ad-hoc compliance reports, or schedule regular reports delivered via email.
> [card] Eligible Compliance Metrics
>
> Zappl can provide Compliance statistics that excludes those Macs in storage, or on Annual Leave.
> [card] Detailed Device Information
>
> Dig into individual Macs, check which apps are out-of-date, and see if the user has recently deferred updates.
> [card] Shadow IT Detection
>
> Zappl can help you pinpoint apps that have been downloaded outside of your MDM solution, but being updated by Zappl.
# Requirements
Source: https://docs.zappl.co/about/requirements
Before Zappl is deployed in your estate, several requirements must be met to ensure a seamless and successful deployment.
**1. macOS Requirements**
> [!TIP]
>
> Zappl currently requires macOS Sequoia (15.0) or later to run. In line with Apple's support model, Zappl supports the current major version of macOS and the two previous major versions.
**2. Network Requirements**
> [!TIP]
>
> Zappl requires outbound network access to the `zappl.co` domain using port `443` (HTTPS).
> [!WARNING]
>
> Additionally, any software vendor’s public download URLs must be accessible.
**3. Mobile Device Management (MDM)**
> [!TIP]
>
> Zappl needs to be deployed and configured using a suitable MDM platform.
> Zappl integrates with most leading MDM solutions on the market. To get the most out of Zappl, ensure your MDM has the ability to send commands and/or scripts to computers. *Jamf Pro* and *Microsoft Endpoint Manager (Intune)* are two examples of MDMs which support this functionality.
# Security
Source: https://docs.zappl.co/about/security
A core focus of everything within Zappl.
**Zappl was developed with security at the forefront of our focus every step of the way. At DARE we are Cyber Essentials certified and maintain strict internal security protocols to ensure the security of our clients and their information.**
We constantly monitor our systems using trusted security solutions so that we can identify and address any security concerns that may come to our attention in a timely manner.
### Your Data
\[!NOTE] **We store all customer information securely in fully certified EU data centres which comply by data protection laws and implement strong security measures.**
When your data is being sent from client devices to the Zappl reporting portal, it is fully encrypted using complex RSA and AES encryption algorithms. This ensures your data is never exposed to any potential attackers. Two-factor authentication is mandatory and enforced for all accounts accessing the [Online Portal](/portal/accounts).
### App Verification
> [!NOTE]
>
> **We take a comprehensive approach to verifying that apps are legitimate before allowing installs, and we immediately cancel the installation of any software deemed unsafe.**
When our Zappl server identifies new updates for apps within our catalog, the software is downloaded on the server and checked for any Malware. If the software fails this check, the new version is **not added** to our database and will **not be downloaded** by the Zappl agent on any client computers.
If the software passes the above check, we proceed to add the new version to our app database. The Zappl agent (installed on client machines) will then attempt to download the software directly from the vendor. Prior to running the installation, we verify the developer signing information using either the signature on the .pkg file, or the signature of the .app file within a .dmg or .zip installer. If the signature **does not meet** the verified signature of the software vendor, the download is **immediately deleted** and the software is **not installed**.
As an additional security measure, we add an expected `sha256 hash` of each installer file to our app database. If a downloaded installer file **does not match** this expected file hash, the download is **immediately deleted** and the software is **not installed**.
# App Visibility
Source: https://docs.zappl.co/appbar/app-visibility
Control which apps are available for users to update and install via AppBar.
AppBar controls app visibility using your existing `com.dare.zappl.preferences` configuration profile — there is no separate configuration required.
* Apps available in the **Updates** tab are controlled by the **Allowed Updates** or **Excluded Updates** keys
* Apps available in the **Installs** tab are controlled by the **Allowed Installs** or **Excluded Installs** keys
If you have already configured any of these keys in your profile, AppBar will respect them automatically.
***
## Updates Tab
By default, AppBar will display all apps supported by Zappl in the Updates tab. You can use the **Allowed Updates** or **Excluded Updates** keys to limit which apps are shown.
> [accordion] Allowed Updates — Specify only the apps you want to allow
>
> Use this option if you want to show only a specific set of apps and restrict everything else. Specify the apps you wish to allow using their unique identifiers from the [Zappl App Catalog](https://zappl.co/app-catalog).
>
> Any app not included in this array will not appear in the Updates tab.
>
> > [!NOTE]
> >
> > If you specify an app in the **Allowed Updates** array that is also present in **Excluded Updates**, the exclusion will take precedence and the app will not be shown.
> [accordion] Excluded Updates — Allow everything except specific apps
>
> Use this option if you want to make all apps available but hide a small number. Specify the apps you wish to exclude using their unique identifiers from the [Zappl App Catalog](https://zappl.co/app-catalog).
>
> All other apps will remain visible in the Updates tab.
>
> > [!NOTE]
> >
> > If you specify an app in the **Excluded Updates** array that is also present in **Allowed Updates**, the exclusion will take precedence and the app will not be shown.
***
## Installs Tab
By default, the Installs tab is disabled. Users will see the message below when they navigate to it until you enable it by checking the [Installs Tab Enabled](/appbar/appbar-preferences#installs-tab-enabled) checkbox in the AppBar preferences.

Once enabled, the Installs tab will show the full [Zappl App Catalog](https://zappl.co/app-catalog) by default. For most organisations, you’ll want to limit this to a curated set of company-approved apps.
The example below shows AppBar when the **Allowed Installs** array in the `com.dare.zappl.preferences` profile includes only CodeRunner, Microsoft Edge, and Microsoft Teams.

> [accordion] Allowed Installs — Specify only the apps you want to allow
>
> Use this option if you want to show only a specific set of apps and restrict everything else. Specify the apps you wish to allow using their unique identifiers from the [Zappl App Catalog](https://zappl.co/app-catalog).
>
> Any app not included in this array will not appear in the Installs tab.
>
> > [!NOTE]
> >
> > If you specify an app in the **Allowed Installs** array that is also present in **Excluded Installs**, the exclusion will take precedence and the app will not be shown.
>
> 
>
> Example | Only Microsoft Edge, Teams and Coderunner are permitted for installs. All other apps in the catalog will not appear.
>
> 
> [accordion] Excluded Installs — Allow everything except specific apps
>
> Use this option if you want to make the full catalog available but hide a small number of apps. Specify the apps you wish to exclude using their unique identifiers from the [Zappl App Catalog](https://zappl.co/app-catalog).
>
> All other apps in the catalog will remain visible in the Installs tab.
>
> > [!NOTE]
> >
> > If you specify an app in the **Excluded Installs** array that is also present in **Allowed Installs**, the exclusion will take precedence and the app will not be shown.
>
> 
>
> Example | All apps in the catalog are available with the exception of WhatsApp and Facebook Messenger.
***
## Configuring the Profile
All four options are configured within the `com.dare.zappl.preferences` profile. If you haven't set this up yet, download the appropriate resource for your MDM and configure whichever keys apply to your needs.
> [card] [Jamf Pro — JSON Schema](https://latestinstaller.zappl.co/Resources/JSON%20Schema/Zappl%20Preferences.json?v=3.0.0)
>
> Download the JSON Schema to configure the Zappl preferences profile in Jamf Pro.
> [card] [Other MDMs — Sample Plist](https://latestinstaller.zappl.co/Resources/Minimal%20Plist/Zappl%20Preferences%20Sample.plist?v=3.0.0)
>
> Download a sample plist to configure the Zappl preferences profile in your MDM of choice.
For a full breakdown of all available keys in the Zappl preferences profile, see the [Preferences guide](/customise/preferences).
# AppBar Preferences
Source: https://docs.zappl.co/appbar/appbar-preferences
Customise AppBar by configuring the preference keys available in the JSON Schema. This guide covers every available preference key and its purpose.
The AppBar preferences are configured via a configuration profile using the preference domain `com.zappl.AppBar`.
> [card] [Jamf Pro — JSON Schema](https://latestinstaller.zappl.co/Resources/JSON%20Schema/AppBar%20Preferences.json?v=4)
>
> Download the JSON Schema to configure AppBar preferences directly within Jamf Pro.
> [card] [Other MDMs — Sample Plist](https://latestinstaller.zappl.co/Resources/Minimal%20Plist/AppBar%20Preferences%20Sample.plist?v=4)
>
> Download a sample plist to use as a starting point for configuring AppBar preferences in your MDM of choice.
## AppBar Preference Key Guide
> [accordion] Title
>
> **Key:** `Title`
>
> The title text displayed in the top left of the AppBar window.
>
> > [!NOTE]
> >
> > **Default value:**`AppBar`
>
> 
> [accordion] Title Font Size
>
> **Key:** `TitleFontSize`
>
> The font size of the title text displayed in the top left of the AppBar window. Accepts numerical values between `16` and `32`. Values outside of this range will fall back to the default value.
>
> > [!NOTE]
> >
> > **Default value:**`22`
>
> 
> [accordion] Custom Logo
>
> **Key:** `CustomLogo`
>
> The logo displayed to the left of the title text. This can be one of the following:
>
> * A **file path** to a local image on the device
> * A **URL** pointing to a remote image
> * An **SF Symbol** name (e.g. `app.badge.fill`)
> * Jamf Pro customers can use **selfService** to use the Jamf Self Service icon
>
> For a full list of available SF Symbols, refer to [Apple's SF Symbols reference](https://developer.apple.com/sf-symbols/).
>
> > [!NOTE]
> >
> > **Default value:**`app.badge.fill` SF Symbol — or the value set in [Custom Logo (Dark Mode)](/customise/appbar-preferences#custom-logo-dark-mode) if specified.
>
> 
> [accordion] Custom Logo (Dark Mode)
>
> **Key:** `CustomLogoDark`
>
> An alternative logo to display to the left of the title text when the user's macOS appearance is set to **Dark Mode**. Accepts the same values as [Custom Logo](/customise/appbar-preferences#custom-logo) — a file path, URL, or SF Symbol name. Jamf Pro customers can use **selfService** to use the Jamf Self Service icon
>
> > [!NOTE]
> >
> > If this preference is not set, AppBar will fall back to the value configured in [Custom Logo](/customise/appbar-preferences#custom-logo). If neither is set, the default `app.badge.fill` SF Symbol is used.
>
> 
> [accordion] Notification Logo
>
> **Key:** `NotificationIcon`
>
> A path or URL to a custom branding image displayed to the right-hand side of macOS notifications sent by AppBar.
>
> > [!NOTE]
> >
> > This preference works in conjunction with the notification preferences below. A [notifications configuration profile](https://latestinstaller.zappl.co/Resources/Configuration%20Profiles/Zappl%20-%20Notifications.mobileconfig?v=3.0.0) approving `com.zappl.AppBar` must be deployed for notifications to be displayed.
>
> 
> [accordion] Menu Bar Icon
>
> **Key:** `MenuBarIcon`
>
> The icon displayed in the macOS menu bar for AppBar. Accepts either:
>
> * A **path** to a local icon file (must be `16x16` points)
>
> * An **SF Symbol** name
>
> > [!NOTE]
> >
> > **Default value:**`square.and.arrow.down.on.square` SF Symbol
>
> 
> [accordion] Accent Colour
>
> **Key:** `AccentColor`
>
> A custom colour applied to buttons and highlighted elements throughout the AppBar interface. Accepts hex colour codes, e.g. `#0071E3`.
>
> > [!NOTE]
> >
> > If not specified, AppBar uses the **macOS system accent colour**.
> [accordion] Custom Categories
>
> **Key:** `CustomCategories`
>
> Customise the category that apps are assigned to within the **Installs** tab. By default, apps use the category defined in the [Zappl App Catalog](https://zappl.co/app-catalog). This preference allows you to override that on a per-app basis.
>
> To configure this, specify an array of objects each containing an `identifier` and a `category` label:
>
> * **App Identifier** (`identifier`) — The unique app identifier from the [Zappl App Catalog](https://zappl.co/app-catalog)
> * **Category Label** (`category`) — The custom category name to display for that app in the Installs tab
>
> 
> [accordion] Custom Descriptions
>
> **Key:** `CustomDescriptions`
>
> Customise the description shown for apps in the **Installs** tab. By default, apps display their description from the [Zappl App Catalog](https://zappl.co/app-catalog). This preference allows you to provide your own description on a per-app basis.
>
> To configure this, specify an array of objects each containing an `identifier` and a `description`:
>
> * **App Identifier** (`identifier`) — The unique app identifier from the [Zappl App Catalog](https://zappl.co/app-catalog)
> * **Description Text** (`description`) — The custom description text to display for that app
>
> 
> [accordion] Installs Tab Enabled
>
> **Key:** `InstallsTabEnabled`
>
> Determines whether app installs are allowed in the **Installs** tab. This option is disabled by default to prevent users from installing unapproved apps from the full Zappl catalog.
>
> 
>
> Check this option to allow app installs.
>
> > [!NOTE]
> >
> > **Default value:**`false`
>
> > [!NOTE]
> >
> > Once enabled, you can use the [Allowed Installs](/customise/preferences#allowed-installs) or [Excluded Installs](/customise/preferences#excluded-installs) options in your `com.dare.zappl.preferences` configuration profile to control which apps are approved for installs.
> [accordion] Installs Tab Hidden
>
> **Key:** `InstallsTabHidden`
>
> Completely hides the Installs tab from the UI when true. Disabled by default. Only takes effect when the 'Installs Tab Enabled' preference is unchecked. When this option is enabled, the Installs tab will not be visible to users at all. This removes the "Your administrator has not allowed app installs" dialogue shown when 'Installs Tab Enabled' is unchecked.
>
> > [!NOTE]
> >
> > **Default value:**`false`
>
> > [!NOTE]
> >
> > This preference is ignored when the above **Installs Tab Enabled** preference is enabled.
> [accordion] History Tab Enabled
>
> **Key:** `HistoryTabEnabled`
>
> Determines whether the **History** tab is visible within AppBar. The History tab shows users a log of recent updates, installs, and failures. Uncheck to hide this tab.
>
> > [!NOTE]
> >
> > **Default value:**`true`
> [accordion] Enable Update Status Text
>
> **Key:** `EnableUpdateStatusText`
>
> Determines whether the update status text is shown at the top of the **Updates** tab. When deferrals are configured, this shows the number of deferrals remaining (e.g. **2 deferrals remaining**); otherwise it shows the number of pending updates (e.g. **3 pending updates**) or **Up to date**. Uncheck to hide this text.
>
> > [!NOTE]
> >
> > **Default value:**`true`
> [accordion] Liquid Glass Enabled
>
> **Key:** `LiquidGlassEnabled`
>
> Enables the **Liquid Glass** visual effect introduced in macOS 26 (Tahoe). When enabled, AppBar adopts the Liquid Glass aesthetic consistent with macOS 26 system applications.
>
> > [!NOTE]
> >
> > **Default value:**`true` — This preference has no effect on macOS versions prior to macOS 26.
> [accordion] Allow Update Notifications
>
> **Key:** `AllowUpdateNotifications`
>
> When enabled, AppBar displays a macOS notification when Zappl has cached new updates that are available to install via AppBar.
>
> > [!NOTE]
> >
> > **Default value:**`true`
>
> > [!NOTE]
> >
> > A [notifications configuration profile](https://latestinstaller.zappl.co/Resources/Configuration%20Profiles/Zappl%20-%20Notifications.mobileconfig?v=3.0.0) approving `com.zappl.AppBar` must be deployed for this to function.
>
> 
> [accordion] Allow Install Notifications
>
> **Key:** `AllowInstallNotifications`
>
> When enabled, AppBar displays a macOS notification when an app install completes successfully.
>
> > [!NOTE]
> >
> > **Default value:**`true`
>
> > [!NOTE]
> >
> > A [notifications configuration profile](https://latestinstaller.zappl.co/Resources/Configuration%20Profiles/Zappl%20-%20Notifications.mobileconfig?v=3.0.0) approving `com.zappl.AppBar` must be deployed for this to function.
>
> 
> [accordion] Allow Failure Notifications
>
> **Key:** `AllowFailureNotifications`
>
> When enabled, AppBar displays a macOS notification if an install or update fails.
>
> > [!NOTE]
> >
> > **Default value:**`true`
>
> > [!NOTE]
> >
> > A [notifications configuration profile](https://latestinstaller.zappl.co/Resources/Configuration%20Profiles/Zappl%20-%20Notifications.mobileconfig?v=3.0.0) approving `com.zappl.AppBar` must be deployed for this to function.
>
> 
> [accordion] Enable Quit Button
>
> **Key:** `EnableQuitButton`
>
> Determines whether a **Quit** option is shown when right-clicking the AppBar menu bar icon. Uncheck to remove this option and prevent users from quitting AppBar via the menu bar.
>
> > [!NOTE]
> >
> > **Default value:**`true`
> [accordion] Enable About Button
>
> **Key:** `EnableAboutButton`
>
> Determines whether an **About** option is shown when right-clicking the AppBar menu bar icon. The About panel displays AppBar version information and other details. Uncheck to hide this option.
>
> > [!NOTE]
> >
> > **Default value:**`true`
# Deployment
Source: https://docs.zappl.co/appbar/deployment
Deploy AppBar to your fleet in two simple steps.
Deploying AppBar involves two steps. Follow each guide below to get AppBar up and running across your estate.
**1. Deploy an AppBar Preferences Configuration Profile**
Use the [AppBar Preferences guide](/appbar/appbar-preferences) to customise AppBar's appearance and behaviour via the `com.zappl.AppBar` preference domain before deploying to your users.
> [card] [AppBar Preferences JSON Schema](https://latestinstaller.zappl.co/Resources/JSON%20Schema/AppBar%20Preferences.json?v=3)
>
> Download the JSON Schema to configure AppBar preferences in Jamf Pro or your MDM of choice.
**2. Deploy the AppBar Installer**
Once Zappl is installed and activated, AppBar will be automatically installed if the [Automatically Install AppBar](/customise/preferences#automatically-install-appbar) preference key is enabled.
If you prefer to deploy AppBar manually, you can do so by disabling the above preference key and using the [Zappl install mechanism](/apps/installs) with `com.zappl.AppBar` as the app identifier.
> [!NOTE]
>
> We recommend deploying a Managed Login Item configuration profile to approve Zappl's Team ID (JTYACQP7Y5). If you have already done this as part of your existing Zappl deployment, no further action is required.
>
> Additionally, ensure you have the latest [Zappl PPPC](https://latestinstaller.zappl.co/Resources/Configuration%20Profiles/Zappl%20-%20PPPC.mobileconfig?v=3.0.0) configuration profile deployed to grant the AppBar privileged helper `com.zappl.ZapplHelper` full disk access. This is required to perform installs and updates via AppBar.
>
> A Notifications configuration profile approving `com.zappl.AppBar` is also required so that AppBar can notify users of available updates, completed installs, and any failures. This should already be deployed as part of your existing Zappl notifications profile.
# Introduction
Source: https://docs.zappl.co/appbar/introduction
Zappl's menu bar companion — putting app updates and installs in the hands of your users.
> [card] [See AppBar in Action](https://dare.tech/watch-a-demo/)
>
> As part of our Zappl interactive demo.

## What is AppBar?
AppBar is Zappl's menu bar companion, designed to empower users with simple, self-service options to update and install third-party applications on their Mac — without any admin credentials or password prompts.
Sitting quietly in the menu bar, AppBar gives users access to potentially **1,100+ apps**, all securely delivered by Zappl. Whether it's updating an existing app or installing something new from your company-approved catalog, AppBar makes the experience effortless for end users.
AppBar also provides users with full visibility of the **last 7 days of Zappl activity** — not just the updates and installs they initiate themselves, but silent background updates that Zappl performs automatically on apps which aren't in use. This gives your users confidence that Zappl is keeping everything compliant, exactly as it should be.
> [!NOTE]
>
> AppBar requires an active Zappl licence and **Zappl version 2.3.0 or later**. If you have disabled Zappl self-updates, please re-enable them or deploy the [latest Zappl installer](https://latestinstaller.zappl.co/ZapplInstaller-Latest.pkg) to your fleet manually before proceeding.
> [card] Self-Service Updates
>
> Users can update their apps on demand, without waiting for a scheduled prompt.
> [card] App Installs
>
> Browse and install from 1,100+ company-approved apps — no admin rights needed.
> [card] Activity History
>
> A full 7-day log of updates and installs, including silent background activity from Zappl.
# Installations
Source: https://docs.zappl.co/apps/installs
Ensure users always install the latest version of an app.
> **In addition to patching apps, Zappl can install applications. This feature is one of the Command Line Options available with the Zappl agent, making it easy to integrate into Jamf Pro policies using the Deploy Software Script.**
Traditionally, to deploy applications via Jamf Pro, administrators have to manually package the app installer and deploy it through a Jamf Pro policy. This approach quickly leads to outdated installers, requiring frequent updates to maintain compliance.
By replacing existing app deployment policies in Jamf Pro with Zappl policies, this issue is resolved. Zappl ensures the installation of the latest version of the app, eliminating the need for manual updates.
#### Creating an App Install Policy
**Step 1**
In Jamf Pro, navigate to *Computers > Policies* and click **New**.
**Step 2**
In the **General** payload, configure a suitable **Display Name**, **Category**, **Trigger** and **Execution Frequency**.

**Step 3**
Navigate to the **Scripts** payload and click **Configure**.
**Step 4**
Locate the **Zappl - Deploy Software** script and click **Add**.

**Step 5**
Enter the **Unique Identifier** as the **Application Identifier** parameter value (The unique identifier can be found in the [App Catalog](https://zappl.co/app-catalog)), then enter `install` as the **Action** parameter value for a silent install, or `install-showProgress` as the **Action** parameter value for an install with an installation progress prompt (useful for Jamf Self Service installs).

**Step 6**
Navigate to the **Scope** tab, configure your desired scoping target for the Application install and click **Save**.

# Updates
Source: https://docs.zappl.co/apps/updates
Customise and configure how Zappl handles app updates.
## Background Updates
By default, the Zappl agent regularly compares installed software versions on client machines to the latest available versions from vendors. When new updates are available, they are securely downloaded and cached locally. The Zappl agent's background update mechanism will then attempt to silently update the software without any user interaction.\
\
Most apps in our catalog can only be updated safely when they're not running.
> If the apps are closed, the Zappl agent will update the software in the background without interrupting the user.
> If an app is in use, the update remains cached locally, and the Zappl agent continues to attempt silent installation every time it runs.
For apps that users rarely close, Zappl employs two strategies: automatic [Scheduled Update Prompts](/apps/updates#scheduled-updates) and manual [Forced Updates](/apps/updates#forced-updates).
## Scheduled Update Prompts
> [!NOTE]
>
> Most apps in our catalog must be closed whilst updating in order to ensure the update installs safely. This feature supplements the hourly silent update attempts and ensures apps that are always running are updated regularly.
Generally speaking, apps such as web browsers, email clients and conferencing apps are rarely closed by users. The Zappl agent is called upon to give your users a nudge towards temporarily quitting the apps that need to update on a recurring interval. The user experience for this is highly customisable and easy to configure via the Zappl custom preferences configuration profile.
On a regular interval, the Zappl agent runs a scheduled update check in the background. As part of this check, it reads the `com.dare.zappl.preferences` configuration profile settings and determines whether to prompt the user based on the configured run limitations. The run limitation option ensures users are only prompted on your desired recurring interval, e.g., once every day, once every week etc. Additionally, the agent checks for any configured do not disturb settings before prompting users to ensure it only does so when convenient.
> [!NOTE]
>
> For more information on configuring the preferences configuration profile, see Configuring Custom Preferences.
#### User Experience
The image below shows a typical custom-branded scheduled update prompt displayed to users when deferrals are enabled and available.

The below prompt is the grace period prompt shown when deferrals are not available.

If configured, the below prompt is shown by default in the top right corner during updates.

If configured, the below macOS notification is shown in the top right corner once all apps have successfully updated.

## Forced Updates
> [!NOTE]
>
> The forced update option is a feature of the Zappl agent that allows you to install an app update more urgently than the Scheduled Update Prompts feature. This feature is particularly useful when a zero-day vulnerability has been identified, enabling you to patch the affected app as quickly as possible.
You can use the Deploy Software Script to mark apps for forced updates. The Zappl agent regularly checks for forced update receipts in the background. When it finds a receipt, it takes immediate action. If the app isn't in use, Zappl updates it silently. If the app is in use, Zappl prompts the user to quit the app before updating it.
#### Marking Apps for Forced Updates
> [!NOTE]
>
> This example demonstrates marking forced updates with **Jamf Pro**. Before proceeding, ensure you have added the latest [Deploy Software Script](/deploy/jamf-pro#deploy-software-script) to your Jamf Pro environment by following the steps outlined in the [Deploying Zappl](/deploy/jamf-pro) page.
**Step 1**
In Jamf Pro, navigate to *Computers > Policies* and click **New**.
**Step 2**
Within the **General** payload, set a suitable display name, select the **Zappl** category, select **Recurring Check-in** as the trigger and **Once per computer** as the Execution Frequency.

**Step 3**
Navigate to the **Scripts** payload and click **Configure**.
**Step 4**
Locate the **Zappl - Deploy Software** script and click **Add**.

**Step 5**
Add the **Unique Identifier** to the Application Identifier parameter for the App you are updating (this can be found in the [App Catalog](https://zappl.co/app-catalog) then set`update` as the Action parameter value. Optionally, set a custom grace period and any allowed deferrals with a Minimum Deferral Window (the amount of time the allowed between deferrals) if desired.

**Step 6**
Navigate to the **Scope** tab, configure your desired scoping target for the update and click **Save**.

> [!NOTE]
>
> The scoping target set above is the most basic target for this type of policy and initiates a one-off patch. If desired, create a [Smart Computer Group](https://learn.jamf.com/en-US/bundle/jamf-pro-documentation-11.9.0/page/Smart_Groups.html#ID-00032060) which defines computers running a specified vulnerable version of the App, then set the Execution Frequency as **Ongoing** to ensure that the known vulnerability is patched on an ongoing basis.
#### User Experience
The below prompt is a typical prompt shown when Firefox has been marked for a forced update and an update is required for Firefox. Deferrals have been configured for the forced update.

By default, the below prompt is shown during the forced update.

By default, the below macOS notification is shown after the forced update completes.

# Message Variables
Source: https://docs.zappl.co/customise/message-variables
If you choose to customise the text on any of the info button popovers on scheduled update prompts, you can use variables to include important information such as deferrals remaining, configured grace periods etc as part of your custom message.
#### Formatting Options
| Syntax | Description |
| :- | :- |
| `##Heading` | Displays text as a **bold section heading**. |
| `**Example Text**` | Displays text in **bold**. |
| `\n\n` | Adds a paragraph break. |
#### Variable Reference
| Variable | Description |
| :- | :- |
| `updateButton` | Displays the update button label. |
| `deferButton` | Displays the defer button label. |
| `deferCount` | Displays the number of remaining deferrals the user is allowed. |
| `updateCount` | Displays the number of pending app updates. |
| `appName` | Displays the name of the app with a pending update. Intended for use when only one app has a pending update. |
| `appList` | Displays a comma-separated list of apps with pending updates. Intended for use when more than one app has a pending update. |
| `gracePeriod` | Displays the configured grace period. \[!NOTE] There is no requirement to specify minutes/hours after the variable — this is already included. |
#### Default Message
The following is the default info popover text used when no custom message is configured:
```
##About Updates\n\nThe apps listed need to briefly quit in order to install their pending updates. Please save your work before clicking Update.\n\nUpdating should only take a few minutes, and you can use your apps again as soon as the updates complete.\n\n##Deferring\n\nNot ready to update right now? Click Defer to be reminded later.
```

#### Example Custom Message
The example below uses variables to dynamically include the app list, button labels, and remaining deferral count:
```
##About Updates\n\nThe following apps need to briefly quit to install updates:\n\n**appList**\n\nPlease save your work and click **updateButton**.\n\nUpdating should only take a few minutes.\n\n##Deferring\n\nNot ready right now? Click **deferButton** to be reminded later.\n\nYou have **deferCount** remaining deferrals.
```

# Preferences
Source: https://docs.zappl.co/customise/preferences
If you are looking to customise the JSON Schema in Jamf Pro or iMazing for other MDMs, you can use this guide to understand the purpose of each preference key.
> [!NOTE]
>
> The screenshots in this guide show the UI when using the custom preference schema for Jamf Pro, but each preference's underlying key name has also been included so non-Jamf Pro customers can still identify and configure the correct preference. If you're not using Jamf Pro, we'd recommend using [iMazing Profile Editor](https://imazing.com/profile-editor) to configure your preferences, or using our [sample plist](https://latestinstaller.zappl.co/Resources/Minimal%20Plist/Zappl%20Preferences%20Sample.plist?v=3.0.0) as a starting point.
#### Preference Structure
The configuration profile is comprised of three main preference dictionaries; the **General Options**, the **Scheduled Update Prompt Options** and the **Forced Update Prompt Options**.

The scheduled and forced update prompt options share identical preference keys that serve the same purpose for their respective prompt mechanisms, although the forced update prompt options require fewer preferences.
This is because deferrals and grace periods for forced update prompts are configured on a per-app basis when marking apps for forced updates, and because the forced update prompt feature requires slightly less functionality overall.
> [!NOTE]
>
> To customise AppBar preferences, refer to the [AppBar Preferences](/appbar/appbar-preferences) guide.
## Schema Preference Key Guide
#### General Options
> [accordion] Activation Token
>
> **Key:** `activationToken`
>
> \[!NOTE] **This key is required to activate and use Zappl.**
> Enter your unique customer activation token. If you do not know this, please [contact our Support team](mailto:helpdesk@dare.tech).
> [accordion] Public Key
>
> **Key:** `publicKey`
>
> \[!NOTE] **This key is required to activate and use Zappl.**
> Enter your unique customer public key. If you do not know this, please [contact our Support team](mailto:helpdesk@dare.tech).
> [accordion] Enable Compliance Reporting
>
> **Key:** `enableReporting`
>
> \[!NOTE] **This key is set to `true` by default.**
> By default, Zappl submits daily compliance reports to the [Zappl Portal](https://portal.zappl.co). To prevent Zappl from submitting compliance reports, uncheck this option.
>
> **This option requires at least v2.1.0**
>
> > [!NOTE]
> >
> > During your Zappl trial, it may be useful to put Zappl into "Report-Only" mode before allowing updates. This lets you see your compliance status before and after Zappl updates apps. To enable this, ensure this option is checked and that **Allow Background Updates** and **Allow Scheduled Update Prompts** are both unchecked. Once Zappl has collected compliance stats, simply enable these two options to allow Zappl to update apps and report your updated compliance status.
> [accordion] Allow Background Updates
>
> **Key:** `backgroundUpdates`
>
> \[!NOTE] **This key is set to `true` by default.**
> When enabled, Zappl attempts to silently update apps in the background on a recurring interval. If an app is not in use when an update is available, it will be updated without any prompts being shown to the user. Leaving this enabled is recommended to ensure updates are applied as quickly as possible with minimal user disruption.
>
> If you wish to disable all updates, this is the first of two settings that need to be unchecked, the second being the [Allow Scheduled Update Prompts](/customise/preferences#allow-scheduled-update-prompts) option.
> [accordion] Allow Scheduled Update Prompts
>
> **Key:** `updatePrompts`
>
> \[!NOTE] **This key is set to `true` by default.**
> By default, Zappl prompts users to quit Apps that need to update on a regular recurring interval which can be configured in the **Scheduled Update Prompt Options**.
>
> If you wish to disable the *recurring scheduled update prompts* and only attempt to install updates silently when Apps are not in use, uncheck this option and check the [Allow Background Updates](/customise/preferences#allow-background-updates) option only.
>
> If you wish to disable *all updates*, this is the second of two settings that need to be unchecked along with the [Allow Background Updates](/customise/preferences#allow-background-updates) option.
> [accordion] Download Stagger Window
>
> **Key:** `downloadStaggerWindow`
>
> \[!NOTE] **This key is set to `60` by default.**
> Sets a stagger window in minutes that spreads update downloads across your devices. Each device will randomly pick a time within this window to check for and download new updates after they are released. Increasing this value is recommended for large sites to reduce network load. The default and minimum value is 60 minutes and the maximum is 360 minutes (6 hours).
>
> > [!NOTE]
> >
> > Longer stagger windows (e.g., 6 hours) may directly impact compliance figures in the portal, as devices could take up to the configured window duration to download new updates after release.
> [accordion] Automatic Self Updates
>
> **Key:** `autoUpdate`
>
> \[!NOTE] **This key is set to `true` by default.**
> By default, Zappl will update itself when new major and point releases are available.
>
> If you wish to disable this and either stay on a specific Zappl version, or push out updates for Zappl manually, **uncheck** this option.
> [accordion] Automatically Install AppBar
>
> **Key:** `autoInstallAppBar`
>
> \[!NOTE] **This key is set to `true` by default.**
> When enabled, Zappl automatically installs the [AppBar](/appbar/introduction) menu bar application.
>
> Uncheck this option if you do not wish to use AppBar in your environment, or if you prefer to deploy AppBar manually.
>
> > [!NOTE]
> >
> > To customise AppBar preferences, refer to the [AppBar Preferences](/appbar/appbar-preferences) guide.
> [accordion] Enable Liquid Glass Effect
>
> **Key:** `enableLiquidGlass`
>
> \[!NOTE] **This key is set to `true` by default.**
> When enabled, Zappl update prompts use the macOS Liquid Glass visual style introduced in macOS 26 Tahoe. Uncheck to use the standard flat appearance on all supported macOS versions.
>
> > [!NOTE]
> >
> > This option has no effect on macOS versions prior to macOS 26 Tahoe.
> [accordion] Allowed Installs
>
> **Key:** `allowedAppInstalls`
>
> By default, all Apps within the Zappl [App Catalog](https://zappl.co/app-catalog/) are available for installs. If you prefer to limit which Apps can be installed by Zappl, specify the Apps you wish to allow in this array.
>
> You can specify as many unique identifiers as you wish, using the [App Catalog](https://zappl.co/app-catalog/) unique identifiers for each App.
>
> > [!NOTE]
> >
> > If you wish to allow installs for all Apps within the catalog with the exception of a select few Apps, skip configuring this setting and use the [Excluded Installs](/customise/preferences#excluded-installs) setting. If you specify an App in this list which is also in the [Excluded Installs](/customise/preferences#excluded-installs) list, the exclusion will override this setting.
>
> 
>
> Example | Only Zoom, Google Chrome and Microsoft Excel are allowed installs and any other App installs will not be allowed via Zappl.
> [accordion] Excluded Installs
>
> **Key:** `excludedAppInstalls`
>
> By default, all Apps within the Zappl [App Catalog](https://zappl.co/app-catalog/) are available for installs. If you wish to allow installs for all Apps in the catalog with the exception of only a few Apps, specify the Apps you wish to exclude in this array.
>
> You can specify as many unique App identifiers as you wish, using the [App Catalog](https://zappl.co/app-catalog/) unique identifiers for each App.
>
> > [!NOTE]
> >
> > If you wish to only allow installs for some specific Apps within our catalog, skip this setting and instead use the [Allowed Installs](/customise/preferences#allowed-installs) setting to create your allowed installations list. If you specify an App exclusion which is also in the [Allowed Installs](/customise/preferences#allowed-installs) list, only the exclusion will be respected.
>
> 
>
> Example | All Apps in the catalog can be installed by Zappl with the exception of WhatsApp and Facebook Messenger.
> [accordion] Allowed Updates
>
> **Key:** `allowedAppUpdates`
>
> By default, all Apps within the Zappl [App Catalog](https://zappl.co/app-catalog/) will be updated if installed. If you prefer to limit which Apps can be updated by Zappl, specify the Apps you wish to allow in this array.
>
> You can specify as many unique identifiers as you wish, using the [App Catalog](https://zappl.co/app-catalog/) unique identifiers for each App.
>
> > [!NOTE]
> >
> > If you wish to allow updates for all Apps within the catalog with the exception of a select few Apps, skip configuring this setting and use the [Excluded Updates](/customise/preferences#excluded-updates) setting. If you specify an App in this list which is also in the \[Excluded Updates]\(/customise/preferences#excluded-updates] list, the exclusion will override this setting.
>
> 
>
> Example | Zappl will only update Zoom, Google Chrome and Microsoft Excel and all other Apps will be ignored.
> [accordion] Excluded Updates
>
> **Key:** `excludedAppUpdates`
>
> By default, all Apps within the Zappl [App Catalog](https://zappl.co/app-catalog/) will be updated if installed. If you wish to allow updates for all Apps in the catalog with the exception of only a few Apps, specify the Apps you wish to allow in this array.
>
> You can specify as many unique App identifiers as you wish, using the [App Catalog](https://zappl.co/app-catalog/) unique identifiers for each App.
>
> > [!NOTE]
> >
> > If you wish to only allow updates for some specific Apps within our catalog, skip this setting and instead use the [Allowed Updates](/customise/preferences#allowed-updates) setting to create your allowed update list. If you specify an exclusion App which is also in the [Allowed Updates](/customise/preferences#allowed-updates) list, only the exclusion will be respected.
>
> 
>
> Example | All Apps within the App Catalog will be updated by Zappl if installed, with the exception of Jamf Connect and Cato Client.
#### ONLY Scheduled Update Prompt Options
> [accordion] Run Frequency Options
>
> **Key:** `runFrequency.runType`
>
> Although the scheduled cached update check is run on a frequent basis every day, the preferences in the Run Frequency Options dictionary ensure that users are only prompted to install updates on a specified frequency, e.g. once every week.
>
> First, use the **Run Frequency Option** dropdown to define a method of frequently prompting users to update.
>
> 
>
> [`Specify Patch Frequency`](/customise/preferences#specify-patch-frequency-preferences)
> Select this option if you prefer not to tie the updates to a specified weekday and instead run updates on a recurring frequency, *e.g. once every day, once every week etc*.
>
> [`Specify Recurring Patch Day`](/customise/preferences#specific-patch-day-preferences)
> Select this option if you want to specify a day of each week to prompt users if they have pending updates, *e.g. every Tuesday*.
>
> When you select one of these two options, preferences that relate to each option automatically populate.
>
> 
> [accordion] Specific Patch Frequency Preferences
>
> #### Frequency to Prompt Users
>
> **Key:** `runFrequency.frequencyOption`
>
> Use this dropdown to select how often you want to prompt users to update.
>
> 
>
> #### Frequency Elapsed Behaviour
>
> **Key:** `runFrequency.frequencyElapsedMode`
>
> This dropdown determines how Zappl should behave if the user defers the update. Selecting the `Single Prompt Mode` option will ensure that if the user defers the update, they will not get prompted to update again until the configured frequency has elapsed again, e.g. one week later.\
> Alternatively, select `Recurring Prompt Mode` if you prefer to prompt the user on a recurring basis after deferring until the update is installed.
>
> 
>
> > [!NOTE]
> >
> > When selecting `Recurring Prompt Mode`, the 'Recurring Prompt Mode Deferral Window - Patch Frequency' field (**Key:**`runFrequency.deferralWindow`) appears and allows you to define a minimum deferral period in minutes. 
> [accordion] Specific Patch Day Preferences
>
> #### Patch Day
>
> **Key:** `runFrequency.patchDay`
>
> Use this dropdown to select a day of the week to prompt users to update when updates are pending.
>
> 
>
> #### Missed Update Prompts
>
> **Key:** `runFrequency.missedUpdatePrompt`
>
> Selecting this option ensures that if a computer is offline on the defined weekly patch day, the user can be prompted to update at the next available opportunity as opposed to waiting until the next patch day. Leave this **unchecked** if you prefer to ensure that prompts are only ever displayed on the configured patch day.
>
> 
>
> #### Patch Day Prompt Frequency
>
> **Key:** `runFrequency.patchDayFrequency`
>
> This dropdown helps you determine how frequently users are prompted to update on the configured patch day when they defer an update.\
> Selecting the `Single Prompt Mode` option ensures that when a user defers the update, they won't get prompted to update until the following week on the configured patch day.\
> If you prefer to prompt the user to update on a recurring basis on the configured patch day, select the `Recurring Prompt Mode` option. 
>
> > [!NOTE]
> >
> > When selecting `Recurring Prompt Mode`, the `Recurring Prompt Mode Deferral Window (Patch Day)` field (**Key:**`runFrequency.patchDayDeferralWindow`) appears and allows you to define a minimum deferral period in minutes. 
>
> > [!WARNING]
> >
> > If Zappl finds no preferences configuration profile, the default behaviour is to prompt users to update **once every week** with **single prompt mode** enabled.
>
> #### Week(s) of Month
>
> **Key:** `runFrequency.patchDayWeeks`
>
> Allows you to select specific weeks of the month to prompt users on your configured patch day. By default, all weeks are enabled. If you prefer to prompt users less frequently, e.g., only on the first monthly occurence of your desired patch day, uncheck all other weeks.
> \[!NOTE] This option requires at least version 2.0.0 of Zappl.
>
> 
> [accordion] Deferral Options
>
> **Key:** `deferralConfiguration.deferralOption`
>
> > [!NOTE]
> >
> > Use this preference dictionary to configure your desired deferral behaviour.
>
> > [!NOTE]
> >
> > This preference is unique to the **Scheduled Update Prompt Options** dictionary. Deferral options for Forced Updates are configured when marking Apps for [Forced Updates](/apps/updates#forced-updates).
>
> #### Specify Deferral Limit
>
> **Key:** `deferralConfiguration.specifyLimit` (selected via `deferralConfiguration.deferralOption: specifyDeferralLimit`)
>
> Configuring a deferral limit for updates ensures that users cannot defer the update indefinitely. The deferral limit you configure here is how many times the user will be allowed to defer the update before being forced to install the update. Use the **Deferral Limit** field to specify your desired deferral limit.
>
> 
>
> #### Disable Deferral Limit
>
> **Key:** `deferralConfiguration.deferralOption: disableDeferralLimit`
>
> Selecting this option will allow users to defer the update indefinitely. We recommend only using this option if you plan to create a workflow which utilises forcing the update on demand.
>
> 
>
> #### Disable Deferrals
>
> **Key:** `deferralConfiguration.deferralOption: disableDeferrals`
>
> Selecting this option will mean that users will not be given any opportunity to defer and will instead be given a [Grace Period](/customise/preferences#grace-period) to save any work before the updates are automatically installed.
>
> 
> [accordion] Grace Period in Minutes
>
> **Key:** `gracePeriodMinutes`
>
> > [!NOTE]
> >
> > This preference is unique to the **Scheduled Update Prompt Options** dictionary. Deferral options for Forced Updates are configured when marking Apps for [Forced Updates](/apps/updates#forced-updates).
>
> This is the amount of time in **minutes** a user is given to save work before updates install automatically when deferrals are either not available or not configured.\
> By default this value is `15` minutes, therefore you only need to configure this preference if you wish to decrease or increase the default grace period.
>
> 
> [accordion] Multiple Apps Prompt Title
>
> **Key:** `multipleAppsTitle`
>
> > [!NOTE]
> >
> > This preference is only present in the **Scheduled Update Prompt Options** dictionary. This is because Forced Updates are always performed on a per-App basis, therefore all forced update prompts relate to a single App.
>
> Use this preference to customise the default title shown on any update prompt when more than one App updates are pending.
>
> 
> [accordion] App List Type
>
> **Key:** `appListType`
>
> > [!NOTE]
> >
> > This preference is only present in the **Scheduled Update Prompt Options** dictionary. This is because Forced Updates are performed on a per-App basis and therefore do not contain App lists.
>
> This preference determines how to list Apps that have pending updates on the update prompts displayed to the user.
>
> 
>
> #### Vertical List
>
> **Key:** `appListType: vertical`
>
> \[!NOTE] This is the default setting.
> When configured, Apps will be displayed at the bottom of the prompt in a vertical scrollable list along with their icon and the pending version that will be installed by the update.
>
> 
>
> #### Horizontal List
>
> **Key:** `appListType: horizontal`
>
> Select this option if you prefer to display Apps in a basic comma separated list.
>
> 
#### Scheduled **AND** Forced Update Prompt Options
> [accordion] Run Limitation Options
>
> **Key:** `runLimitations`
>
> You can use the Run Limitation Options dictionary to apply exclusions to the frequency options you previously configured for **Scheduled Updates**. The same options are also available in the **Forced Updates** dictionary to allow you to limit when Zappl is permitted to prompt users to update any Apps that have been marked for forced updates.\
> A checkbox is available and by default ticked for each day of the week. If there is a particular day of the week you want to ensure update prompts are never displayed to the user, simply **uncheck** the box next to the day. This is useful when using the [Specify Patch Frequency](/customise/preferences#specific-patch-frequency-preferences) option, or when specifying a patch day with the [Missed Update Prompts](/customise/preferences#specific-patch-day-preferences) option checked.
>
> 
>
> > [!NOTE]
> >
> > If you have specified a weekly patch day, and that patch day is then *unchecked* in the run limitation options, the run limitation for that day will be ignored and the user will still be prompted to update on the configured patch day.
>
> Each day also offers the option to define an allowed update time window. Selecting an allowed time window means that whenever Zappl runs outside of that window, update prompts will be skipped and Zappl will exit with no further action.\
> By default, the start time is `12.00am` and the end time is `11.59pm`, but you can easily change this on a per-day basis by modifying the values in the fields.
>
> 
>
> If you want to define an exclusion time window, e.g. do not prompt between `2pm` and `4pm` but allow prompts for the rest of the day, simply reverse the timestamps as shown below.
>
> 
> [accordion] Icon
>
> **Key:** `customIcon`
>
> By default, the icon displayed on the left hand side of the update prompts is your **Jamf Self Service icon** for *scheduled updates*, and the **App icon** for *forced updates*.
>
> 
>
> If you wish to change this to a different image, specify the path of an image to use in this field.
>
> 
> [accordion] Initial Prompt Icon Overlay
>
> **Key:** `initialPromptOverlayIcon`
>
> Configuring this option allows you to overlay a second icon on the bottom right corner of the main icon.
>
> By default, no icon overlay is configured, but you can specify a valid `.png`, .`jpg` or `.icns` file here to add one. To use the Jamf Self Service icon as the overlayed icon, type in `selfService`.
>
> 
>
> Here we're using this feature with a custom info icon.
> [accordion] Single App Prompt Title
>
> **Key:** `singleAppTitle`
>
> Use this preference to customise the default title shown on any update prompt when there is 1 pending App update. You can define the name of the App using the `appName` variable.
>
> 
>
> > [!NOTE]
> >
> > In the **Forced Update** options dictionary, this preference uses the key `customTitle` and is labelled `Title`. This is because forced updates are always performed on a per-App basis, so all forced update prompts relate to a single App.
> [accordion] Show Info Button
>
> **Key:** `showInfoButton`
>
> \[!NOTE] **This key is set to `true` by default.**
> When enabled, an info button is displayed on update prompts. Clicking this button opens a popover containing additional context about the update, such as what the update process involves and how deferrals work.
>
> Set this to `false` to hide the info button from all prompts.
>
> 
> [accordion] Initial Prompt Info Popover
>
> **Key:** `initialPromptInfoPopover`
>
> Use this preference to customise the text displayed in the info popover on the **initial update prompt** — the prompt shown when deferrals are available.
>
> If not configured, a default message is displayed that explains the update process and deferral behaviour.
>
> When writing your custom message, you can use formatting and variables to personalise the content. For all available options, see [Message Variables](/customise/message-variables).
>
> 
>
> > [!NOTE]
> >
> > This preference is available in both the **Scheduled** and **Forced Update** options dictionaries.
> [accordion] Grace Period Prompt Info Popover
>
> **Key:** `gracePeriodPromptInfoPopover`
>
> Use this preference to customise the text displayed in the info popover on the **grace period prompt** — the prompt shown when no deferrals are available and the countdown timer is active.
>
> If not configured, a default message is displayed that explains the update process.
>
> When writing your custom message, you can use formatting and variables to personalise the content. The `gracePeriod` variable is particularly useful here as it dynamically displays the configured grace period duration. For all available options, see [Message Variables](/customise/message-variables).
>
> 
>
> > [!NOTE]
> >
> > This preference is available in both the **Scheduled** and **Forced Update** options dictionaries.
> [accordion] Defer Button Label
>
> **Key:** `customDeferButton`
>
> Use this preference to change the label on the button used to defer updates.
>
> 
> [accordion] Update Button Label
>
> **Key:** `customUpdateButton`
>
> Use this preference to change the label on the button used to run updates.
>
> 
> [accordion] Prompt Refresh Interval
>
> **Key:** `refreshInterval`
>
> This is the length of time in seconds that the update prompts pull focus. Without the prompts regularly pulling focus, it is easy for the user to swipe away and ignore the update prompt without choosing to either defer or update.
>
> The default value is `60` seconds. If you find this too aggressive, you can change the value to suit your needs. The minimum allowed value is `30` seconds.
> [accordion] Do Not Disturb Applications
>
> **Key:** `acceptableAppBundleIDs`
>
> Use this preference to define any Apps which if detected as being in the foreground will cause the update prompt to skip.\
> It is recommended that you configure this preference and add any video conferencing or presentation software used across your estate. This will ensure that users don't get prompted to update whilst on a conference call or when presenting.\
> To define an App, you must first get the bundle identifier of the App. To do so, paste the below command into Terminal on a macOS computer that has the App installed (replacing `zoom.us.app` with the name of the App you want to define).
>
> ```bash theme={null}
> defaults read /Applications/zoom.us.app/Contents/Info.plist CFBundleIdentifier
> ```
>
> Copy the resulting bundle identifier to your clipboard and paste it into the `Do Not Disturb Application Bundle ID` preference. You can add as many App bundle identifiers as you require by clicking the **Add Do Not Disturb Application Bundle ID** button.
>
> 
> [accordion] Do Not Disturb Application Assertions
>
> **Key:** `acceptableAppAssertions`
>
> > [!TIP]
> >
> > An **application assertion** is when an app actively declares that it needs to use a specific system resource, like the microphone, camera, or location services.
>
> Use this preference to ensure that updates are skipped if an application is using assertions. If an application is using the system microphone or playing audio, it should be marked as using assertions.\
> This is useful in scenarios where a user may be in a meeting using a web-based client like Google Meets without a camera on, as the assertion used by the web browser would prevent the update from interrupting the meeting.\
> You can add as many assertion apps as you wish, ensuring to use the correct assertion name format. To get the required assertion name format, run `/usr/bin/pmset -g assertions` in Terminal while the application is running and using assertions.
>
> 
> [accordion] Respect Do Not Disturb Mode
>
> **Key:** `acceptableDNDMode`
>
> \[!NOTE] **This key is set to `true` by default.**
> Use this preference to ensure that if macOS Do Not Disturb mode is enabled, update prompts are skipped.\
> Setting this as `true` will skip the update prompts, setting as `false` will prompt users while Do Not Disturb mode is detected.
> [accordion] Do Not Disturb Camera Usage
>
> **Key:** `acceptableCameraUsage`
>
> \[!NOTE] **This key is set to `true` by default.**
> Use this preference to ensure that if the camera is detected as being actively in use, the update will be skipped.\
> We recommend setting this as `true` to ensure that users are not interrupted whilst on conference calls.
> [accordion] Do Not Disturb Screen Sharing
>
> **Key:** `acceptableScreenSharing`
>
> \[!NOTE] **This key is set to `true` by default.**
> Use this preference to ensure that if screen sharing is detected as being actively in use, the update will be skipped.
> [accordion] Show Update Progress Prompt
>
> **Key:** `updateProgressPrompt`
>
> \[!NOTE] **This key is set to `true` by default.**
> When enabled, a small progress prompt is displayed in the corner of the screen while updates are being installed. Disable to run updates silently without any progress indicator.
>
> 
> [accordion] Update Progress Prompt Position
>
> **Key:** `updateProgressPosition`
>
> The update progress prompt is the small prompt that contains an update progress bar and information around the update whilst the update is running.
>
> 
>
> The default position of this prompt is the `top right` corner of the screen. This position can be modified using the dropdown within this preference.
>
> 
> [accordion] Update Progress Prompt Overlay Icon
>
> **Key:** `updateProgressOverlayIcon`
>
> Use this preference to add an overlay icon to the update progress prompts. When updates are running, the main icon displayed is the icon for the App currently being updated. The overlay icon will be displayed on the bottom right corner of the App icon.\
> You can specify either a path to a valid `.png`, `.jpg` or `.icns` file, or use the `selfService` variable for the Jamf Self Service icon.
>
> 
> [accordion] Automatically Relaunch Apps
>
> **Key:** `autoRelaunchApps`
>
> \[!NOTE] **This key is set to `true` by default.**
> With this set as `true`, Zappl silently relaunches the app as soon as the update completes providing that the app was in use prior to the update.\
> Set this as `false` to skip relaunching apps.
> [accordion] Send Completion Notification
>
> **Key:** `displayCompletePrompt`
>
> \[!NOTE] **This key is set to `true` by default.**
> When enabled, a macOS notification is sent to the user once all updates are complete. Disable to suppress the completion notification.
>
> 
# Deploy Anywhere
Source: https://docs.zappl.co/deploy/deploy-anywhere
An MDM-agnostic quickstart guide to deploying Zappl. Need more help? Follow our deeper step-by-step instructions for your specific MDM provider from our sidebar.
> [!NOTE]
>
> Don't see your MDM listed in the sidebar? As long as it supports package and custom configuration profile deployment, you can follow the steps below to get Zappl up and running.
> [!WARNING]
>
> Before proceeding, make sure that your network can support Zappl's requirements, [documented here](/about/requirements). If Zappl cannot reach the necessary services then core product functionality will fail.
**1. Zappl Preferences Profile**
This is the most important one, and must contain your **Activation Token** and **Public Key**. You should have received these upon activation of your trial/purchased license. No other keys are necessary for Zappl to function.
> [card] [Custom Schema](https://latestinstaller.zappl.co/Resources/JSON%20Schema/Zappl%20Preferences.json?v=3.0.0)
>
> This option is perfect for **Jamf Pro**. If you need support with using the Custom Schema, check out our full Jamf Pro deployment guide.
> [card] [iMazing](https://imazing.com/profile-editor)
>
> We have a full payload in **iMazing**. This will provide you with a *.mobileconfig* file to upload to your MDM.
**2. Additional Profiles**
These additional profiles ensure that Zappl functions as expected, with the necessary permissions and background processes.
> [card] [Managed Login Items](https://latestinstaller.zappl.co/Resources/Configuration%20Profiles/Zappl%20-%20Managed%20Login%20Items.mobileconfig?v=3.0.0)
>
> Ensures Zappl can run in the background, and prevents users from disabling this feature.
> [card] [Privilege Preference Policy Controls](https://latestinstaller.zappl.co/Resources/Configuration%20Profiles/Zappl%20-%20PPPC.mobileconfig?v=3.0.0)
>
> Pre-approves the necessary access for Zappl (Full Disk Access).
> [card] [Notifications](https://latestinstaller.zappl.co/Resources/Configuration%20Profiles/Zappl%20-%20Notifications.mobileconfig?v=3.0.0)
>
> Approves notifications for Zappl and AppBar so users can be notified of available updates, completed installs, and any failures.
**3. Installer Package**
> [card] [Latest Zappl PKG](https://latestinstaller.zappl.co/ZapplInstaller-Latest.pkg)
>
> Download the latest current version of Zappl. Upload the PKG to your MDM or install it directly on a test Mac.
> [card] [Latest Zappl via Script](https://latestinstaller.zappl.co/Resources/Scripts/Install%20Zappl.zsh)
>
> Alternatively, you can deploy Zappl using this script. This ensures the latest version of Zappl will always be deployed
> [!WARNING]
>
> Zappl is a patch management tool that actively downloads and installs software updates in the background. When deploying to **large numbers of devices on the same network**, we strongly recommend **phasing your rollout in batches** rather than deploying to your entire fleet at once. Deploying to all devices on the same network in one go will result in all outdated apps downloading updates simultaneously on the first run, which may result in significant network load.
> [!NOTE]
>
> Ready to take your Zappl experience further? Check out our full deployment guides for [Jamf Pro](/deploy/jamf-pro), our wide range of [preference customisations](/customise/preferences) or how to [deploy applications](/apps/installs) using Zappl.
# Intune
Source: https://docs.zappl.co/deploy/intune
This guide provides step-by-step instructions on how to use Microsoft Intune to configure and deploy Zappl in your environment.
> [!NOTE]
>
> For a successful Zappl deployment with Intune, please follow the steps in the order outlined below. It is important that all configuration policies are deployed prior to the Zappl installer.
## Configuration Policies
### Zappl Preferences
> [!NOTE]
>
> We've utilised [iMazing Profile Editor](https://imazing.com/profile-editor) to provide an easy method of configuring Zappl preferences and generating a configuration profile for deployment.
**1. Open iMazing Profile Editor**
Download and open [iMazing Profile Editor](https://imazing.com/profile-editor). Find the **Zappl Application Domain** and add the payload.

**2. Add your activation credentials**
Add your **Zappl Activation Token** and **Public Key** to the payload. These are required to connect devices to the Zappl servers.
**3. Configure additional preferences**
Alter any other preferences as required. Refer to our [preferences documentation](/customise/preferences) for information on all available keys.
**4. Export the profile**
Name and save the profile. This generates a `.mobileconfig` file ready for deployment via Intune.
**5. Create a new policy in Intune**
In Intune, navigate to *Devices > macOS > Configuration* and click **Create**, then **New Policy**. Set **macOS** as the platform, **Templates** as the Profile Type, and **Custom** as the Template Name.
**6. Upload and deploy**
Give the profile a name and description, then upload your `.mobileconfig` file under **Configuration Settings**. Add your assignments (e.g. *All devices*), then review and **Create** the policy.

### Additional Policies
> [!NOTE]
>
> As of macOS 13 (Ventura), full disk access is required in order to update or remove macOS apps. The Zappl agent is responsible for performing all app updates, therefore full disk access (`SystemPolicyAllFiles`) needs to be granted to the agent via a configuration profile.
> [!NOTE]
>
> As of macOS 13 (Ventura), users can disable launch daemons through the Login Items option in System Settings. Zappl uses launch daemons to run automatically in the background, and these daemons must always be enabled for Zappl to function.
> [!NOTE]
>
> Zappl and AppBar use macOS notifications to alert users of available updates, completed installs, and any failures. These notifications must be pre-approved via a configuration profile, otherwise macOS will prompt users to allow them individually.
**1. Download the additional policies**
Download the following policies as JSON files:
* [Full Disk Access](https://latestinstaller.zappl.co/Resources/Intune%20Policies/Zappl_PPPC.json?v=3.0.1)
* [Managed Login Item](https://latestinstaller.zappl.co/Resources/Intune%20Policies/Zappl_Managed%20Login%20Items.json?v=3.0.0)
* [Notifications](https://latestinstaller.zappl.co/Resources/Intune%20Policies/Zappl_Notifications.json?v=3.0.0)
\[!TIP] You may need to right-click > download file.
**2. Import the policies in Intune**
In Intune, navigate to *Devices > macOS > Configuration* and click **Create**, then **Import**. Import each JSON file as a new policy, providing a name and description where necessary.
### AppBar Preferences
> [!WARNING]
>
> These steps are only necessary if you are choosing to automatically deploy AppBar alongside Zappl. See [this key](../customise/preferences#automatically-install-appbar) in the main Zappl Preferences for more information.
> [!NOTE]
>
> AppBar comes with its own preferences that can be configured for custom branding and behaviour options.
> [!NOTE]
>
> There are no **required** keys within AppBar's preferences. If you want to skip branding and behaviour customisation, you can skip these steps.
**1. Open iMazing Profile Editor**
Find the **Zappl AppBar Application Domain** and add the payload.

**2. Configure AppBar preferences**
Alter any preferences as required. Refer to our [AppBar preferences documentation](/appbar/appbar-preferences) for information on all available keys.
**3. Export the profile**
Name and save the profile. This generates a `.mobileconfig` file ready for deployment via Intune.
**4. Create a new policy in Intune**
In Intune, navigate to *Devices > macOS > Configuration* and click **Create**, then **New Policy**. Set **macOS** as the platform, **Templates** as the Profile Type, and **Custom** as the Template Name.
**5. Upload and deploy**
Give the profile a name and description, then upload your `.mobileconfig` file under **Configuration Settings**. Add your assignments (e.g. *All devices*), then review and **Create** the policy.

With all policies in place, you should have the following:
> [tab] Required (All Deployments)
>
> * **Zappl Preferences** — Custom Template
> * **Full Disk Access** — Imported JSON
> * **Managed Login Item** — Imported JSON
> * **Notifications** — Imported JSON
> [tab] Optional (AppBar Only)
>
> * **AppBar Preferences** — Custom Template

## Deploying Zappl
### Via Script (Recommended)
> [!TIP]
>
> Utilising our deployment script means that the latest version of Zappl will always be installed - **Because of this, it's our recommended option.**
**1. Download the deployment script**
Download our Zappl deployment script **[here](https://latestinstaller.zappl.co/Resources/Scripts/Install%20Zappl.zsh?v=3.0.0)**.
\[!TIP] You may need to right-click > download file.
**2. Edit the script variables**
Open the script in your script editor of choice and alter the following variables to match your environment (shown on lines 25 and 26 of the script):
* `activationToken` — Your Zappl Activation Token
* `publicKey` — Your Zappl Public Key

**3. Add the script in Intune**
In Intune, navigate to *Manage Devices > Scripts and remediations*, select the *Platform scripts* tab and **Add** a new macOS script. Provide a script name and description, and ensure you choose to **not** run the script as the logged-in user.

**4. Assign and review**
Assign to the relevant users/groups, then review and **Add**.

> [card] Congratulations!
>
> You're all set! With your configuration policies deployed and the Zappl installer pushed to your devices, Zappl is ready to manage and update apps across your Intune-managed fleet.
# Jamf Pro
Source: https://docs.zappl.co/deploy/jamf-pro
This guide provides step-by-step instructions on how to use Jamf Pro to configure and deploy Zappl in your environment.
> For a successful Zappl deployment with Jamf Pro, please follow the steps in the order outlined below. It is important that all configuration profiles are installed prior to the Zappl installer being deployed.
## Zappl Category
> [!NOTE]
>
> This category is not essential for deployment, but it can help keep your Jamf Pro environment neat and organised.
We’d recommend creating a new `Zappl` category for housing the necessary Configuration Profiles, Policies, Scripts etc.
**To add the category:**
**Step 1**
Navigate to *Jamf Pro > Settings > Categories* and click **New**.
**Step 2**
Type in **Zappl** for the Category name.

**Step 3**
**Save** the Category.
> [!TIP]
>
> The Zappl category is now ready to use throughout the Zappl deployment in Jamf Pro.
## Configuration Profiles
#### Adding the JSON Schema
**Step 1**
Open/download our [JSON file](https://latestinstaller.zappl.co/Resources/JSON%20Schema/Zappl%20Preferences.json?v=3.0.0).
**Step 2**
In Jamf Pro, navigate to *Computers > Configuration Profiles* and click **New**.
**Step 3**
In the general payload, give the new profile a name, assign it to a category, set the level as **Computer Level** and the distribution method as **Install Automatically**.

**Step 4**
Under the payload options, locate the **Application & Custom Settings** payload, select **External Applications** and select **Add**.

**Step 5**
Under the Source dropdown, select **Custom Schema**.

**Step 6**
Set the preference domain as `com.dare.zappl.preferences` and click **Add Schema**.

**Step 7**
Copy the entire JSON Schema that we opened in an earlier step, Paste it into the text area and click **Save**.

**Step 8**
### Customise Preferences
Configure your desired Zappl behaviour and user experience using the keys outlined in our [Preferences page](/customise/preferences).
**Step 9**
Scope the profile to all computers where you plan to deploy Zappl (e.g. *All Managed Clients*), then click **Save**.

#### Managed Login Items
> [!NOTE]
>
> As of macOS 13 (Ventura), users can disable launch daemons through the Login Items option in System Settings. Zappl uses launch daemons to run automatically in the background, and these daemons must always be enabled for Zappl to function.
> The following profile ensures Zappl can run in the background by preventing users from disabling Zappl's launch daemons. This is achieved by whitelisting Zappl's Team ID (`JTYACQP7Y5`).
**Step 1**
Download our [.mobileconfig file](https://latestinstaller.zappl.co/Resources/Configuration%20Profiles/Zappl%20-%20Managed%20Login%20Items.mobileconfig?v=3.0.0).
**Step 2**
In Jamf Pro, navigate to *Computers > Configuration Profiles* and click **Upload**.
**Step 3**
Click **Choose File**, then locate the `.mobileconfig` file you downloaded in the first step and click **Upload**.

**Step 4**
Click **Scope**, add your desired scope target for the profile and click **Save**.

#### Full Disk Access
> [!NOTE]
>
> As of macOS 13 (Ventura), full disk access is required in order to update or remove macOS apps. The Zappl agent is responsible for performing all app updates, therefore full disk access (`SystemPolicyAllFiles`) needs to be granted to the agent via a configuration profile.
> To ensure Zappl is allowed to perform updates, simply add the below configuration profile to your MDM and scope it out to devices which Zappl will be deployed to.
**Step 1**
Download our [.mobileconfig file](https://latestinstaller.zappl.co/Resources/Configuration%20Profiles/Zappl%20-%20PPPC.mobileconfig?v=3.0.0).
**Step 2**
In Jamf Pro, navigate to *Computers > Configuration Profiles* and click **Upload**.
**Step 3**
Click **Choose File**, then locate the `.mobileconfig` file you downloaded in the first step and click **Upload**.

**Step 4**
Click **Scope**, add your desired scope target for the profile and click **Save**.

#### Notifications
> [!NOTE]
>
> Zappl and AppBar use macOS notifications to alert users of available updates, completed installs, and any failures. These notifications must be pre-approved via a configuration profile, otherwise macOS will prompt users to allow them individually.
> To ensure Zappl and AppBar notifications are approved, simply add the below configuration profile to your MDM and scope it out to devices which Zappl will be deployed to.
**Step 1**
Download our [.mobileconfig file](https://latestinstaller.zappl.co/Resources/Configuration%20Profiles/Zappl%20-%20Notifications.mobileconfig?v=3.0.0).
**Step 2**
In Jamf Pro, navigate to *Computers > Configuration Profiles* and click **Upload**.
**Step 3**
Click **Choose File**, then locate the `.mobileconfig` file you downloaded in the first step and click **Upload**.

**Step 4**
Click **Scope**, add your desired scope target for the profile and click **Save**.

## Deploy the Installer
> [!NOTE]
>
> You can easily deploy the latest version of Zappl to your estate using our Zappl installer script. Follow the steps below to add the script to your Jamf Pro server and deploy Zappl using a policy.
**Step 1**
Download our [Zappl installer script](https://latestinstaller.zappl.co/Resources/Scripts/Install%20Zappl.zsh).
**Step 2**
In Jamf Pro, navigate to *Settings > Computer Management > Scripts* and click **New**.
**Step 3**
In the *General* tab, give the new script a name and assign it to a category.

**Step 4**
In the Script tab, drag and drop the `Install Zappl.zsh` script you downloaded in **Step 1** into the text area.

**Step 5**
In the **Options** tab, set the below parameter labels for parameter 4 and 5 and click **Save**.
**Parameter 4 |** `Activation Token (Optional, recommended)`
**Parameter 5 |** `Public Key (Optional, recommended)`

**Step 6**
Navigate to *Computers > Policies* and click **New**.
**Step 7**
In the **General** payload, give the policy a name, assign it to a category, set the trigger as **Recurring Check-in** and set the execution frequency as **Once per computer**.

**Step 8**
In the **Scripts** payload, click **Configure**, then locate the Deploy Zappl script you added in the previous steps and click **Add**.

**Step 9**
We recommend that you paste your customer-specific activation and public keys to the first 2 script parameters. This will ensure Zappl activates even if the configuration profile fails to install. If you do not know your activation and public keys, [contact our helpdesk](mailto:helpdesk@dare.tech).

**Step 10**
In the **Scope** tab, select your desired scoping target for the Zappl deployment and click **Save**.
> [!WARNING]
>
> Zappl is a patch management tool that actively downloads and installs software updates in the background. When deploying to **large numbers of devices on the same network**, we strongly recommend **phasing your rollout in batches** rather than deploying to your entire fleet at once. Deploying to all devices on the same network in one go will result in all outdated apps downloading updates simultaneously on the first run, which may result in significant network load.
## Additional Scripts
> [!NOTE]
>
> **The following scripts are optional for deploying Zappl but provide extra functionality.** It's recommended to add these scripts to your Jamf Pro environment while setting up the Zappl deployment, ensuring they're readily available when needed.
#### Deploy Software Script
> [!NOTE]
>
> **This script enables the installation of any app from our [app catalog](https://zappl.co/app-catalog).** It eliminates the need for Jamf Pro admins to manually package and deploy software. For instructions on using this script, refer to Adding Scripts to Jamf Pro below.
Download our [Deploy Software script](https://latestinstaller.zappl.co/Resources/Scripts/Zappl%20-%20Deploy%20Software.zsh), and utilise the Parameter Labels below.
> [accordion] Parameter 4
>
> Application Name (Use the Installation Format from the Zappl App Catalog - E.g. com.google.Chrome)
> [accordion] Parameter 5
>
> Action (Options are "install" to have Zappl install the App silently, "install-showProgress" to install with a progress prompt or "update" to mark an App for a forced update)
> [accordion] Parameter 6
>
> Grace Period in Minutes (Only applicable if specifying "update" as the action. This is the amount of time the user has to save and quit the App before it quits automatically. Leave blank for 15 minutes)
> [accordion] Parameter 7
>
> Deferrals Allowed (Only applicable if specifying "update" as the action. This is the amount of times a user can defer an update prompt before being forced to update. Leave blank for no deferrals and just a grace period timer)
> [accordion] Parameter 8
>
> Minimum Deferral Window (Only applicable if specifying "update" as the action. This is the minimum time in minutes Zappl will prompt users to update again after they defer. Leave blank for the the default value of 60 minutes)
#### Collect Logs Script
> [!NOTE]
>
> This script provides an easy method for collecting Zappl log files when troubleshooting. For instructions on using this script, refer to Adding Scripts to Jamf Pro below.
Download our [Log Collection script](https://latestinstaller.zappl.co/Resources/Scripts/Zappl%20-%20Collect%20Logs.zsh), and utilise the Parameter Labels below.
> [accordion] Parameter 4
>
> Jamf Pro URL
> [accordion] Parameter 5
>
> API Client ID
> [accordion] Parameter 6
>
> API Client Secret
#### Adding Scripts to Jamf Pro
> [!NOTE]
>
> Follow the steps below to add either of the above scripts to your Jamf Pro server.\\
>
> For information on using the Deploy Software script, see [Application Installations](/apps/installs).\\
>
> For information on using the Log Collection script, see [Logs and Errors](/other/logs-errors).
**Step 1**
In Jamf Pro, navigate to *Settings > Computer Management > Scripts* and click **New**.
**Step 2**
In the **General** tab, give the script a name and assign it to a category.

**Step 3**
In the **Script** tab drag and drop the downloaded script into the text area.

**Step 4**
In the **Options** tab, paste in the parameter labels outlined above into the relevant parameter fields, then click **Save**.

## Extension Attributes
> [!NOTE]
>
> **Jamf Pro offers extension attributes which provide better visibility into Zappl's status across your estate.** While the Zappl portal displays all necessary information for admins, adding Jamf Pro extension attributes can be beneficial for administrators who primarily use Jamf Pro and may not have access to your Zappl portal.
**Download our pre-configured Extension Attributes [here](https://latestinstaller.zappl.co/Resources/Extension%20Attributes/Zappl%20Extension%20Attributes.zip?v=3.0.0).**
> [accordion] Installation Status
>
> Displays whether Zappl is installed.
> [accordion] Cached Updates
>
> Displays which app updates are currently cached locally due to the app(s) being in use.
> [accordion] Deferrals Remaining
>
> Displays how many recurring update deferrals are remaining.
> [accordion] Last Run Result
>
> Displays the output from the most recent recurring background update or any forced updates. This can range from simple information, such as whether the user chose to defer or install updates, to details about any errors encountered during the update process.
> [accordion] Version Installed
>
> Displays the version of Zappl installed.
#### Adding Extension Attributes to Jamf Pro
> [!NOTE]
>
> Download the **Zappl Extension Attributes** above, then follow the steps outlined below to add the `.xml` files to your Jamf Pro server.
**Step 1**
In Jamf Pro, navigate to *Settings > Computer Management > Extension Attributes*.

**Step 2**
Click **Upload**.

**Step 3**
Click **Choose File**, then select the extension attribute you wish to add, and click **Upload**.

**Step 4**
Optionally, change the **Inventory Display** dropdown to the category you would like Zappl information to be stored.
**Step 5**
Finally, click **Save**.
# Command Line
Source: https://docs.zappl.co/other/command-line
The Zappl agent is essentially a macOS command line tool consisting of the following flags.

For the day to day running of Zappl, the recurring run launch daemon initiates background, scheduled and forced updates by utilising the command line options. Likewise, the **Zappl Software Deployment Script** which integrates with MDMs such as Jamf Pro utilises the command line options for features such as Application installs and marking Apps for forced updates.
The Zappl agent is located in the `/Library/Application Support/DARE/Zappl/Bin/` directory, and is symlinked at `/usr/local/bin/zappl`.
The command line options available are useful in scenarios such as when testing or troubleshooting Zappl workflows.
## Command Line Options
> [!NOTE]
>
> All options must be prefixed with `sudo zappl` (unless you push any of these options through an MDM which executes them as *root* - in that case `sudo` is not required).
> [accordion] --help | -h
>
> #### Show Help
>
> ```bash theme={null}
> --help
> ```
>
> Displays a Zappl help page. *This does not require elevated privileges.*
> [accordion] --update check | -u check
>
> #### Check for Application Updates
>
> ```bash theme={null}
> --update check
> ```
>
> This option is useful when testing update workflows as it tells Zappl to check for and download any available App updates. This option is automatically run in the background once every hour, and is responsible for silently installing updates for Apps that are not running and caching updates for Apps that are running. If you are testing scheduled or forced update workflows, ensure that the App you want to be prompted to update is open when you run this, otherwise the App will be silently updated immediately after the update has downloaded and no prompts will be displayed.
> [accordion] --update run | -u run
>
> #### Begin Recurring Run Mechanism
>
> ```bash theme={null}
> --update run
> ```
>
> \[!WARNING] **Not for general use.**
> This option is called upon once every **15 minutes** by the recurring run daemon located at `/Library/LaunchDaemons/com.dare.zappl.run.plist` and is responsible for checking for forced update receipts, checking for new updates on an hourly basis and running the scheduled update mechanism in line with any configured custom preferences.
> [accordion] --update "AppIdentifier" | -u "AppIdentifier"
>
> #### Update a Specific App
>
> ```bash theme={null}
> --update "AppIdentifier"
> ```
>
> Updates a specific app identifier (if applicable). This will force the app to close if it is running before proceeding with the update. This option is silent - no progress bar is shown during the update.
> [accordion] --update force | -u force
>
> #### Force Application Updates
>
> ```bash theme={null}
> --update force
> ```
>
> This option can be called manually to tell the agent to check for any Apps that have been marked for forced updates. If a forced update receipt is found, the agent will attempt the update. If no receipt is found, the agent will exit and take no further action.\
> To mark an App for a forced update, see [Forced Updates](/apps/updates#forced-updates). This option is also called automatically every **15 minutes** as part of the run flag by the main recurring run daemon located at `/Library/LaunchDaemons/com.dare.zappl.run.plist`.
> [accordion] --update prompt | -u prompt
>
> #### Prompt to Install Cached Updates
>
> ```bash theme={null}
> --update prompt
> ```
>
> This option can be called manually to tell the agent to check for any pending cached updates. If the agent finds cached updates, it then checks [Run Limitation Options](/customise/preferences#run-limitation-options) and if necessary prompts the user to install the pending cached updates.\
> Using this option at the command line will simulate what happens when the daemon calls the option. This is a good way to test the scheduled updates workflow on-demand after [Configuring Custom Preferences](/customise/preferences).\
> This option is also called automatically every **15 minutes** as part of the run flag by the main recurring run daemon located at `/Library/LaunchDaemons/com.dare.zappl.run.plist`.
> [accordion] --update testPrompt | -u testPrompt
>
> #### Prompt to Install Cached Updates and Override Limitations
>
> ```bash theme={null}
> --update testPrompt
> ```
>
> This is identical to the `sudo zappl --update prompt` flag, with the exception that all run and elapsed time limitations will be **ignored**. If you are using the command line options to test Zappl prompts, this flag is ideal as it can be used to repeatedly display the scheduled update prompts on-demand.
> [accordion] --update timerPrompt | -u timerPrompt
>
> #### On-Demand Cached Update Grace Period Prompt
>
> ```bash theme={null}
> --update timerPrompt
> ```
>
> When this option is called, the grace period prompt normally shown when all deferrals have been used is displayed. This option is mainly used during testing, or when creating custom bespoke workflows for forcing updates on set deadlines as opposed to the recurring automation that Zappl natively offers.
> [accordion] --update self | -u self
>
> #### Check for Zappl Component Updates
>
> ```bash theme={null}
> --update self
> ```
>
> This option checks for any available updates for Zappl and it’s components. In order to utilise this option, @Automatic Self Updates must be enabled.
> [accordion] --install "AppIdentifier" | -i "AppIdentifier"
>
> #### Silent Application Installs
>
> ```bash theme={null}
> --install "AppIdentifier"
> ```
>
> This is the option utilised by the @Deploy Software Script when performing a silent Application install. When calling this option via command line, replace *"AppIdentifier"* with the App's Unique Identifier which can be found in our [App catalog](https://zappl.co/app-catalog).
> [accordion] --installProgress "AppIdentifier" | -ip "AppIdentifier"
>
> #### Application Installs with Installation Progress
>
> ```bash theme={null}
> --installProgress "AppIdentifier"
> ```
>
> This is the option utilised by the @Deploy Software Script when using the `install-showProgress` action to perform an Application install which displays installation progress. When calling this option via command line, replace `"AppIdentifier"` with the App's Unique Identifier which can be found in our [App catalog](https://zappl.co/app-catalog).
> [accordion] --check “AppIdentifier” | -c “AppIdentifier”
>
> #### Validate an Application Installation Format
>
> ```bash theme={null}
> --check “AppIdentifier”
> ```
>
> \[!WARNING] **Not for general use.**
> Outputs whether the defined App installation format is valid. This is utilised by the @Deploy Software Script when validating if the defined App is valid before proceeding and marking the App for a forced update. For App installation formats, see the online [App Catalog](https://zappl.co/app-catalog).
> [accordion] --report submit | -r submit
>
> #### Send Report Information to Zappl
>
> ```bash theme={null}
> --report submit
> ```
>
> This will send updated report information to the Zappl server, on-demand, which allows up-to-date information on application versions and more to be viewed in the online [Zappl Portal](/portal/general).
> [accordion] --deferralsRemaining | -dr
>
> #### Output Deferral Count
>
> ```bash theme={null}
> --deferralsRemaining
> ```
>
> Displays the amount of remaining deferrals for scheduled updates
> [accordion] --version | -v
>
> #### Output Current Zappl Version
>
> ```bash theme={null}
> --version
> ```
>
> Displays the version of Zappl running on the computer. *This does not require elevated privileges.*
# Logs and Errors
Source: https://docs.zappl.co/other/logs-errors
The Zappl agent provides multiple options when it comes to retrieving logs and error information.
## Unified Logging
> [!NOTE]
>
> The Zappl agent sends log output to Apple’s Unified Log. This offers a simple way of collecting and filtering through logs with a set category or from a set timeframe.
> [!TIP]
>
> The [AppBar](appbar/introduction) logs can also be viewed/collected using the unified log, using 'com.zappl.AppBar' as the subsytem label
#### Streaming Logs
To stream all current Zappl logs with Terminal, launch Terminal and input the following command, then press **enter**.
```bash theme={null}
log stream --predicate 'subsystem == "com.dare.zappl"' --info --debug
```
Alternatively, you can stream the current Zappl logs using the Console app. To do so, launch Console, then in the filter field select `SUBSYSTEM` and enter `com.dare.zappl` as the subsystem name.

#### Historical Logs
You can use the Terminal app to run any of the below commands to gather historical Zappl logs using Apple’s unified logging.
> [!TIP]
>
> To alter the timeframe, change the last value. We use `1h` in the below examples for the last hour, but you could also specify days. e.g. `1d` for 1 day.
**Display all Zappl logs from the last \$timeframe**
```bash theme={null}
log show --predicate 'subsystem == "com.dare.zappl"' --info --debug --last 1h
```
**Export all Zappl logs from the \$timeframe to a .log file on the desktop**
```bash theme={null}
log show --predicate 'subsystem == "com.dare.zappl"' --info --debug --last 1h > ~/Desktop/ZapplLastHour.log
```
**Display all available errors outputted by the Zappl agent**
```bash theme={null}
log show --predicate 'subsystem == "com.dare.zappl"' --info --debug --last 1h > ~/Desktop/ZapplLastHour.log
```
**Display only logs relating to the scheduled update category from the last \$timeframe** (see the table below for a full list of available categories)
```bash theme={null}
log show --predicate 'subsystem == "com.dare.zappl" AND category == "ScheduledUpdates"' --info --debug --last 1d
```
| Category Name | Description |
| - | - |
| **Initialising** | Contains log information related to the Zappl agent's initialisation tasks such as the validation of license keys and connecting to the Zappl server. |
| **AppInstalls** | Contains log information about app installations. Please note this is not related to app updates. |
| **BackgroundUpdates** | Contains log information relating to silent updates which occur in the background for apps that are not in use. |
| **ForcedUpdates** | Contains log information relating to the forced update mechanism. |
| **Reporting** | Contains log information relating to the reporting mechanism responsible for collecting app and computer data and submitting data to the Zappl reporting portal. |
| **ScheduledUpdates** | Contains log information relating to the recurring scheduled updates mechanism responsible for prompting users to quit any apps which need to quit in order to update. |
## Zappl Log File
```
/var/log/zappl.log
```
> [!NOTE]
>
> This log stores the previous 4 weeks of historical information outputted by Zappl, from informational output to any errors and warnings encountered.
Filtering through the log using Error: as the search term will display any historical errors outputted by Zappl.
The excerpt below demonstrates log output displayed during a typical app installation.
```Plain Text theme={null}
Thu Oct 03 16:02:20 XG17QVWYLX zappl[17950]: Initialising the Application install mechanism...
Thu Oct 03 16:02:20 XG17QVWYLX zappl[17950]: Show progress flag specified
Thu Oct 03 16:02:23 XG17QVWYLX zappl[17950]: The Zappl server is reachable
Thu Oct 03 16:02:23 XG17QVWYLX zappl[17950]: This installation of Zappl is licensed to Acme LTD
Thu Oct 03 16:02:30 XG17QVWYLX zappl[17950]: Firefox found in the Zappl App catalog.
Thu Oct 03 16:02:30 XG17QVWYLX zappl[17950]: Initialising Firefox install...
Thu Oct 03 16:02:30 XG17QVWYLX zappl[17950]: Preventing idle sleep...
Thu Oct 03 16:02:30 XG17QVWYLX zappl[17950]: Checking for sufficient disk space for the Firefox install...
Thu Oct 03 16:02:30 XG17QVWYLX zappl[17950]: Sufficient free disk space for the Firefox install
Thu Oct 03 16:02:30 XG17QVWYLX zappl[17950]: Checking macOS version requirements...
Thu Oct 03 16:02:30 XG17QVWYLX zappl[17950]: 15.0.0 is the same or greater than the minimum required macOS version (10.15)
Thu Oct 03 16:02:30 XG17QVWYLX zappl[17950]: Downloading universal Firefox installer...
Thu Oct 03 16:02:37 XG17QVWYLX zappl[17950]: Download complete
Thu Oct 03 16:02:37 XG17QVWYLX zappl[17950]: Mounting disk image...
Thu Oct 03 16:02:47 XG17QVWYLX zappl[17950]: Successfully mounted the Disk Image
Thu Oct 03 16:02:47 XG17QVWYLX zappl[17950]: Extracting Firefox-v131.0.dmg...
Thu Oct 03 16:02:47 XG17QVWYLX zappl[17950]: Downloaded installer hash: cd243b44746f56ee2042572cccab2736c0c6d419f85f90ad163a4ba04979ccb2
Thu Oct 03 16:02:47 XG17QVWYLX zappl[17950]: The installer hash matches the expected sha256 hash. Continuing...
Thu Oct 03 16:02:47 XG17QVWYLX zappl[17950]: Verifying signing information...
Thu Oct 03 16:02:48 XG17QVWYLX zappl[17950]: Found signature: Mozilla Corporation (43AQ936H96)
Thu Oct 03 16:02:48 XG17QVWYLX zappl[17950]: Signing verification complete. The App matches the expected code signing. Continuing...
Thu Oct 03 16:02:48 XG17QVWYLX zappl[17950]: Writing Firefox.app to /Applications/Firefox.app...
Thu Oct 03 16:02:57 XG17QVWYLX zappl[17950]: Setting permissions - Mode: 755, Owner: root, Group: admin
Thu Oct 03 16:02:57 XG17QVWYLX zappl[17950]: Detaching disk image...
Thu Oct 03 16:02:57 XG17QVWYLX zappl[17950]: "disk18" ejected.
Thu Oct 03 16:02:57 XG17QVWYLX zappl[17950]: Removing downloads...
Thu Oct 03 16:02:57 XG17QVWYLX zappl[17950]: Allowing idle sleep...
Thu Oct 03 16:02:57 XG17QVWYLX zappl[17950]: Running post install tasks...
Thu Oct 03 16:02:58 XG17QVWYLX zappl[17950]: Firefox found at path: /Applications/Firefox.app
Thu Oct 03 16:02:58 XG17QVWYLX zappl[17950]: The Firefox install was successful.
Thu Oct 03 16:03:00 XG17QVWYLX zappl[17950]: Displaying install success message to the user. Asking if Firefox should be launched...
Thu Oct 03 16:03:07 XG17QVWYLX zappl[17950]: User clicked Yes. Launching Firefox...
Thu Oct 03 16:03:08 XG17QVWYLX zappl[17950]: Exiting...
```
## Zappl Portal Logs
The Zappl agent sends any errors or warnings it generates to the device records in the [Online Portal](/portal/general) . These records are stored for 30 days, providing an easy way to view issues without sifting through the main Zappl logs. For more information, see [Logs](/portal/device-records#logs).
## Capturing Logs via MDM
> [!NOTE]
>
> Using an MDM tool like Jamf Pro (which will be used as an example below), we can capture Zappl logs remotely from a Mac, and upload to the relevant Inventory Record for download and further investigation.
#### Script
> [!NOTE]
>
> The script used for Log Collection can be found [here](https://latestinstaller.zappl.co/Resources/Scripts/Zappl%20-%20Collect%20Logs.zsh).
#### API Client
**Step 1**
In Jamf Pro, navigate to *Settings > System > API Roles and Clients > API Roles*
**Step 2**
Create a new **API Role**, giving it a relevant name.
**Step 3**
The only privileges needed for this workflow are `Read Computers` and `Create Computers`.  We can then create an **API Client** which utilises this role.
**Step 4**
Navigate to *Settings > System > API Roles and Clients > API Clients.*
**Step 5**
Create a new **API Client**, giving it a relevant name.
**Step 6**
Choose the API Role you created in the prior step.
**Step 7**
Under the *Enable/disable API Client* option, click on **Enable API Client**. Upon clicking **Save**, this provides you with an option to Generate a Client Secret.
**Step 8**
Clicking on this option presents a popup. Click on **Create Secret** and you will be provided with a `Client ID` and `Client Secret`.
> [!NOTE]
>
> **Be sure to copy these details to your clipboard, as the Secret cannot be viewed again without rotating it.** We will be using these details with our Collect Logs script in the next steps.

> [!TIP]
>
> We're now ready to utilise this API Client in a Jamf Pro Policy.
#### Policy
**Step 1**
In Jamf Pro, navigate to *Computers > Policies*, and click on **Create New**.
**Step 2**
Give your Policy a relevant name, and choose how you want the Policy to trigger.
> [!TIP]
>
> We’d generally recommend a trigger of `Recurring Check-In`, with a frequency of `Once Per Computer`. This allows the script to trigger silently when the Mac next checks in with Jamf Pro, and requires no user-input.
**Step 3**
Click on the **Scripts** payload and select the `Collect Logs` script you should have uploaded earlier.
**Step 4**
Enter the necessary parameter details as follows;
> [accordion] Parameter 4 | Jamf Pro URL
>
> [https://acme.jamfcloud.com](https://acme.jamfcloud.com)
> [accordion] Parameter 5 | Client ID
>
> *Copied from the earlier API Client steps.*
> [accordion] Parameter 6 | Client Secret
>
> *Copied from the earlier API Client steps.*

**Step 5**
Set the Scope of the Policy to your preference, and **Save** the Policy.
> [!TIP]
>
> Once the policy has executed on the target Computer(s), you can proceed.
**Step 6**
Navigate to the relevant Inventory Record(s).
From here, in the `Inventory` tab select the **Attachments** option, and you should see a `Zappl Log` uploaded. 
**Step 7**
> [!TIP]
>
> You are then able to download this log to your own computer for further troubleshooting.
# Troubleshooting
Source: https://docs.zappl.co/other/troubleshooting
Solutions to the most frequently encountered Zappl issues.
## Frequently Encountered Issues
Below are some of the most common issues encountered when using Zappl, along with an explanation of each and how to resolve them.
> [accordion] The install Zappl script fails to install Zappl
>
> #### Symptom
>
> `Error: The Zappl deployment failed because the installer script is inaccessible. Please check the Zappl network requirements and try again.`
>
> #### Explanation
>
> The script was blocked when attempting to download the Zappl installer components from `zappl.co`.
>
> #### Remediation
>
> Verify that the network connection is stable and that the Zappl [Network Requirements](/about/requirements) have been met. Specifically, this requires outbound network access using port `443` (HTTPS) to `zappl.co`.\
> If the issue persists, the service could be experiencing a temporary outage.
> [accordion] App installation failure | Not enough disk space
>
> #### Symptom
>
> `Error: Not enough disk space available to download and install the $appName update.`
>
> #### Explanation
>
> The app installer size is greater than the available disk space on the computer, preventing it from being downloaded.
>
> #### Remediation
>
> Free up disk space on the computer. The Zappl log displays how much space is required for the particular update/install, however it is advisable to free up as much space as possible to prevent further installs/updates from failing.
> [accordion] App installation failure | Incompatible OS
>
> #### Symptom
>
> `Error: $appName is not compatible with this macOS version.`
>
> #### Explanation
>
> The installed version of macOS does not meet the macOS requirements for the app.
>
> #### Remediation
>
> Review the Zappl log to see the macOS requirement for the app.\
> If the installed macOS version is too far behind, upgrade the computer to the supported macOS version.\
> If the app can only be installed on older versions of macOS, limit installs of the app to computers which meet the required macOS criteria.
> [accordion] App installation failure | Could not download app
>
> #### Symptom
>
> `Error: The $appName installer could not be downloaded.`
>
> #### Explanation
>
> Zappl could not download the installer for the app in question.
>
> #### Remediation
>
> Verify that full network access is permitted to the software vendor’s public download URLs and try again.\
> If the issue persists, the vendor may be experiencing a temporary outage.
> [accordion] App installation failure | Could not mount disk image
>
> #### Symptom
>
> `Error: Could not mount disk image for $appName.`
>
> #### Explanation
>
> The disk image containing the software was successfully downloaded, but couldn’t be mounted.
>
> #### Remediation
>
> Remove any disk image restrictions. Disk images can be blocked using MDM configuration profiles and other third party security tools. Blocking disk images will cause any apps with .dmg installers to fail, therefore lifting these restrictions will resolve this issue.\
> If no restrictions are in place, the downloaded disk image may be damaged. In this case, retry the install/update and if the issue persists please [contact support](mailto:support@dare.tech).
> [accordion] Portal | Unable to send reports to email addresses
>
> #### Symptom
>
> `The email address is not associated with an existing Zappl user. Please create a new user and try again.`
>
> #### Explanation
>
> For extra security, only existing users in the Zappl portal can receive scheduled email reports. If you try to schedule an email report for an email address that is not linked to a user in the Zappl portal, this error will be seen.
>
> #### Remediation
>
> [Create a new user](/portal/accounts#creating-user-accounts) in the Zappl portal using the desired email address for the scheduled report, then try again.
> [accordion] Microsoft Defender | Version has not changed since the update attempt
>
> #### Symptom
>
> `Error: The Microsoft Defender version has not changed since the update attempt. Version installed: 101.25062.0005`
>
> #### Explanation
>
> In version 2506 (101.25062.0005) of Microsoft Defender, a bug caused tamper protection to prevent any future updates by any means (even via Microsoft AutoUpdate).
>
> #### Remediation
>
> [Follow Microsoft's guide](https://github.com/microsoft/mdatp-xplat/tree/master/macos/upgrade_from_2506_helper) to add a tamper protection exclusion for Microsoft's update helper, then run the helper PKG. Additionally, it is advised to create a second exclusion for Zappl in the same profile using "JTYACQP7Y5" as the team ID, and "com.dare.zappl" as the signing ID to ensure Zappl is excluded from tamper protection for future updates.
# Uninstall Zappl
Source: https://docs.zappl.co/other/uninstall
If you need to reinstall or completely uninstall Zappl, use the included `uninstall` executable.
> Zappl's `uninstall` executable is located at `/Library/Application Support/DARE/Zappl/Bin/uninstall` and can be run from the command line or as part of a script.
## Uninstalling Zappl with Terminal
To uninstall Zappl using the Terminal application; simply launch Terminal, input sudo /Library/Application\ Support/DARE/Zappl/Bin/uninstall and press enter.
**Step 1**
Launch **Terminal**
**Step 2**
Input `sudo /Library/Application\ Support/DARE/Zappl/Bin/uninstall`
\[!NOTE] Sufficient user privileges will be needed to run `sudo` commands.
**Step 3**
Press **Enter**.
> [!NOTE]
>
> To uninstall AppBar but keep all other Zappl components, first ensure the [Automatically Install AppBar](/customise/preferences#automatically-install-appbar) preference is unchecked - then use `sudo /Library/Application\ Support/DARE/Zappl/Bin/uninstall --appbar`
## Uninstalling Zappl with Jamf Pro
**Step 1**
In Jamf Pro, navigate to *Computers > Policies* and click **New**
**Step 2**
In the *General* payload, configure a suitable `Display Name`, `Category`, `Trigger` and `Execution Frequency`

**Step 3**
Navigate to the *Files and Processes* payload and click **Configure**
**Step 4**
In the *Execute Command* field, input `/Library/Application\ Support/DARE/Zappl/Bin/uninstall`

**Step 5**
Navigate to *Scope*, select your desired scope target for the Zappl uninstall and click **Save**.

# Accounts
Source: https://docs.zappl.co/portal/accounts
Manage access to your dedicated Zappl customer portal.
The first admin account in your online Zappl portal is created during the initial sign-up process.
> [!WARNING]
>
> This account becomes the super admin and cannot be deleted, so it's best to use a dedicated mailbox for this purpose — for example, [zappl@acme.corp](mailto:zappl@acme.corp) — rather than an individual's email address.
When you sign up, an email invitation is sent to the provided address. After accepting this invite, you'll be prompted to create a password and set up two-factor authentication. Once logged in, you can create additional admin and standard accounts using the steps outlined below.
#### Creating User Accounts
**Step 1**
On the navigation bar to the left, under **Management**, select **Accounts**, then select **Create New Account**.

**Step 2**
In the `Create Account` dialog, enter the email address, name, and select an account role from the dropdown. Once done, click **Create**.
\[!NOTE] The **Admin** role provides full access to manage user accounts and reports.\
The **Standard** role is read-only, allowing users to log in and view dashboards, but not manage users or reports.

**Step 3**
The new account will now be listed under the main accounts section and will have a `Pending` status until the user accepts the email invitation and successfully sets up their password and two-factor authentication.
\[!NOTE] To modify the email address for the user after creation, click the pencil icon, change the email address and click save. A new invite will be sent to the new email address.\
If the invite expires, simply click the bin icon on the user item to remove the user, and repeat the above account creation steps to send a new invite.

# Applications
Source: https://docs.zappl.co/portal/applications
The Applications page displays a comprehensive list of all applications in your estate that can currently be (and are currently being) patched by Zappl.It does not list every application available in our [App Catalog](zappl.co/app-catalog).
## Application List
This list shows your compliance from an application point of view, rather than based on your devices. It is sorted alphabetically by default, however you can sort all columns in this table - making it great for seeing options like your least-compliant applications, how many applications the computers have installed, and the latest updates that are available through Zappl.
You can also search for specific applications using the search bar, allowing you to quickly pinpoint what you need.
> [!NOTE]
>
> The search bar goes further than just application name - it will also search the **description**, **identifier**, **developer** and **more** against what you have typed in.

## Application Compliance
Within the Compliance column, you have the option to view filtered lists of which devices (that have the app installed) are compliant (left), or non-compliant (right).



## Application Details
Clicking on either the application name or the **Details** button will show you further information regarding that app, such as the install path, minimum OS required for install and the expected Code Signature that Zappl checks against when running it’s [Security checks](/about/security).

# Dashboard
Source: https://docs.zappl.co/portal/dashboard
The dashboard is the main landing page in the Zappl portal. Here, you will find an overview of your device and app compliance, as well as any relevant alerts.
## Devices
The device widget on the dashboard displays an average compliance level for all devices in your estate. Zappl calculates app compliance for each device, sums the percentages, and divides by the total number of devices to obtain the average figures.
There are two compliance figures that can be viewed using the tab — **Eligible Compliance** and **All Compliance**.

#### Eligible Compliance
Eligible Compliance is designed to calculate compliance **only for devices that meet specific eligibility criteria**. For a device to be considered eligible, it must meet the following requirements:
> [!TIP]
>
> The device has checked in within the last 14 days.
> [!TIP]
>
> The user hasn't deferred any pending updates on the device.
> [!TIP]
>
> Updates are enabled on the device (including silent updates, update prompts, and per-app updates).
This feature allows you to easily exclude irrelevant devices from your statistics, providing more accurate figures at the click of a button.
#### All Compliance
All Compliance represents the total device compliance, considering every device in your estate without excluding any from the calculations.
## Applications
The Applications widget displays average compliance on an application basis for all apps installed across your estate. Similar to device compliance, Zappl calculates this by determining compliance levels for each app found across your estate, summing them, and dividing by the total number of apps.
Application compliancy follows the same theme as the device based compliancy — **Eligible Compliance** and **All Compliance**.

#### Eligible Compliance
Eligible Compliance is designed to calculate compliance **only for apps that meet specific eligibility criteria**. For an app to be considered eligible, it must meet the following requirements:
> [!TIP]
>
> The app is installed on a device that has checked in within the last 14 days.
> [!TIP]
>
> The user hasn't deferred updates for the app.
> [!TIP]
>
> The app is installed on a device that has updates enabled (including silent updates, update prompts, and per-app updates).
This feature allows you to easily exclude irrelevant apps from your statistics, providing more accurate figures at the click of a button.
#### All Compliance
All Compliance represents the total app compliance, considering every app in your estate without excluding any from the calculations.
## Alerts
The alerts widget highlights the following scenarios:
* Computers with *total compliance* below **50%**
* Computers that *haven't checked in* for **7+ days**
* Computers with *errors* in the last **7 days**
* Computers with *warnings* in the last **7 days**
* Computers with **less than 10%** *available disk space*
* Computers where *updates* are **disabled**

Clicking the **Details** button shows the specific devices associated with each alert type. You can then click the device name to be taken to the [device record](/portal/device-records) to see more information.

# Device Records
Source: https://docs.zappl.co/portal/device-records
Zappl portal device records contain information specific to that device.
> [!NOTE]
>
> Clicking either the device name or the **View** button in the device list will take you to the device record.
## Device Information
The top half of each device record displays information about the device on the left hand column, and information relating to Zappl on the right hand column.
#### Information Breakdown
| Label | Description |
| :- | :- |
| `Name` | Displays the device name. |
| `Last User` | Displays the username of the last user logged in to the device. |
| `Full User Name` | Displays the full name of the last user logged in to the device. |
| `Model` | Displays the the device model, e.g., MacBook Pro. |
| `Serial Number` | Displays the unique serial number for the device. |
| `macOS Version` | Displays the version of macOS running on the device. |
| `FileVault` | Displays whether FileVault disk encryption is enabled on the device. |
| `SIP` | Displays whether system integrity protection is enabled on the device. |
| `Gatekeeper` | Displays whether Apple’s Gatekeeper is enabled on the device. |
| `Disk Space` | Displays the available and total disk space on the device. |
| `Zappl Version` | Displays the version of Zappl installed on the device. |
| `Self Updates` | Displays whether Zappl automatically updates itself when new versions are available. This setting is managed using the Automatic Self Updates preference. |
| `Prompts Allowed` | Displays whether the recurring Scheduled Update Prompts are enabled on the device. This setting is managed using the Allow Recurring Update Prompts preference. |
| `Deferrals Allowed` | Displays whether deferrals are configured for the Scheduled Update Prompts. This setting is managed using the Deferral Options preference. |
| `Background Updates` | Displays whether automatic silent App Updates are enabled on the device. This setting is managed using the Allow Hourly Attempt Updates preference. |
| `Deferral Limit` | Displays the configured allowed deferral count for Scheduled Update Prompts. This setting is managed using the Deferral Options preference. |
| `Deferrals Remaining` | Displays the number of deferrals remaining on the device. |
| `Last Check-In` | Displays the time and date the device last checked in and submitted report data to the Zappl portal. |
| `Last Prompt` | Displays the time and date the Scheduled Update Prompts feature last prompted the user to install pending updates. |
| `Next Prompt` | Displays the time and date the Scheduled Update Prompts feature will start attempting to install updates by prompting the user again. |
| `Last Prompt Result` | Displays the result of the last Scheduled Update Prompts interaction, e.g. User Deferred. |
> [!WARNING]
>
> From the above table, **macOS Version**, **FileVault**, **SIP**, **Gatekeeper**, and **Disk Space** are not controlled by Zappl. We display this data for informational purposes only. Use your MDM to enforce things like macOS Updates, FileVault etc.
#### Example
In the *ACME* Zappl environment, we've determined from the dashboard view that while eligible device compliance is **100%**, total device compliance is only **88%**.
A closer look at the devices list reveals this is due to `Sophia's MacBook` having a remarkably low compliance score of just **7%**.
Upon examining the device record, we see that this device hasn't affected the eligible compliance because it's considered *non-eligible* due to the user deferring pending updates when prompted.

> [!NOTE]
>
> `Prompts Allowed` or `Background Updates` showing as disabled, or the `Last Check-in` timestamp being older than 14 days ago would also cause the device to become non-eligible.\
> For additional app-based context related to the example scenario above, please refer to the **Applications** section below.
## Applications
Below the device information header, you'll find a tab that lets you switch between the device-specific Applications and Logs views. The Applications view is selected by default.

The Applications view displays a list of all apps installed on the device, offering context about their status and reasons for non-compliance.
To inspect a specific app, use the **Search Applications** field to filter the list.

You can also sort by the `Name`, `Latest Version`, `Date Released` and `Compliance` columns.
In the following example, we examine the scenario above more closely to understand why `Sophia's MacBook` has such low compliance. The image reveals that Sophia has 15 apps installed, with only VLC player running the latest available version — making it the sole compliant application.

For a more detailed inspection of each app, click the **Details** button in the corresponding row. Clicking this button reveals additional details, such as the app's macOS requirements, whether updates have been permitted for the app, and whether an update is cached locally because the app is currently in use.
The image below shows that the Firefox update is cached locally because the user is currently running the application. As a result, it couldn't be updated silently and required a user prompt, which Sophia then deferred.

> [!NOTE]
>
> If **Updates Allowed** is set to false for a given application, it renders that app ineligible for both device-based and app-based compliance calculations. To enable updates for the app, see Allowed Installs and Excluded Installs.
## Logs
The Logs view displays error or warning messages generated by the Zappl agent within the last 30 days. This feature is invaluable for troubleshooting app update or install issues, as it provides quick access to relevant errors and warnings without the need to sift through the full Zappl logs.

By default, all errors and warnings are displayed together. To view only errors or only warnings, simply click the **Errors** or **Warnings** filter buttons.

You can utilise the **Search Logs** field to quickly filter out logs using key words.

> [!WARNING]
>
> All logs are purged from the portal after 30 days. To view older logs, refer to [Logs and Errors](/other/logs-errors).
# Devices
Source: https://docs.zappl.co/portal/devices
The Devices page displays a comprehensive list of all devices in your estate.
The Zappl portal provides an overview of each device's compliance levels and essential information, including device name, associated user, macOS version, app count, and last check-in date. Clicking on a device takes you to the individual [Device Records](/portal/device-records).
## Device List
You can use the search field at the top of the page to quickly locate a specific device within your estate.

The following device attributes are all searchable in this field:
* **Device Name**
* **Last User** (This is the local username)
* **User Full Name**
* **Serial Number**
Each column in the device list allows sorting of devices either alphanumerically or by compliance levels. An arrow indicates the currently sorted column, pointing up or down to show the sort direction.

In the compliance column, beneath the blue compliance bar, you'll find two figures. The left figure represents the number of compliant apps, while the right figure shows the number of non-compliant apps. Clicking either figure filters the app list for that device. For example, clicking the **compliant apps** figure displays all compliant apps for that specific device.

Clicking either the device name or the **View** button takes you to individual [Device Records](portal/device-records).
# Introduction
Source: https://docs.zappl.co/portal/general
The Zappl portal enables you to effortlessly monitor your app compliance status across your entire estate.
> To log in to the Zappl portal, visit **[portal.zappl.co](https://portal.zappl.co)**.

Unlike traditional patch management tracking methods, Zappl considers both device and app eligibility. This makes it simple to toggle between total compliance and eligible compliance—the latter filtering out update deferrals, offline devices, and other exceptions.
Leverage the built-in compliance and application reports by scheduling recurring email updates to your security team members. This feature allows them to stay informed about compliance levels without needing to log in to the portal.
# Reports
Source: https://docs.zappl.co/portal/reports
The Reports section allows you to schedule email reports or manually download detailed analyses of your compliance levels.
Reports are particularly useful for keeping other stakeholders, such as security personnel, up to date on compliance without requiring them to log into the portal manually.
There are two report types — **Compliance** and **Application**.
## Compliance Report
The compliance report provides a summary of all key information highlighted by the Zappl portal in PDF format.
The report consists of the following sections:
> [accordion] Application Summary
>
> Displays eligible and total app compliance in your estate as shown on the [Dashboard](/portal/dashboard).
> [accordion] Most Used Application Compliance
>
> Lists the 25 most-used apps in your estate, showing their eligible and total app compliance. The list is sorted from most to least installations.
> [accordion] Least Compliant Applications
>
> Lists the 10 least compliant apps in your estate, with the least compliant app appearing at the top of the list.
> [accordion] Device Summary
>
> Displays eligible and total device compliance in your estate as shown on the [Dashboard](/portal/dashboard).
> [accordion] Devices with Highest App Count
>
> Displays the top 10 devices with the most apps installed in your estate and their compliance figures.
> [accordion] Least Compliant Devices
>
> Displays the 10 least compliant devices in your estate, with the least compliant device at the top of the list.
> [accordion] Alert Summary
>
> Displays the same alert summary found on the [Dashboard](/portal/dashboard), plus information on devices with updates disabled, devices with zero remaining deferrals, and devices with Zappl self-updates disabled.

## Application Report
The Application report offers a comprehensive breakdown of eligible and total compliance for every application in your estate. This report is organised by software categories.

## Scheduling Email Reports
To set up a recurring scheduled email report for either of the above reports:
**Step 1**
Navigate to **Reports**.
**Step 2**
Under `Type`, select which report you want to schedule (e.g. `Compliance Report`).
**Step 3**
Set a `Frequency` for the report (daily, weekly, or monthly).
**Step 4**
Under `Time`, select when you want the report sent (e.g. 13:00).
**Step 5**
Under `Day of week` specify the day of the week you want the report to be sent (e.g. Tuesday).
**Step 6**
Under `Recipient Email`, input the recipient's email address.
**Step 7**
Click **Schedule**.
> [!TIP]
>
> A dialog will appear in the top right corner to confirm that the report has been scheduled.

The report will then be listed under the `Active Scheduled Reports` section. To modify any aspect of the report, click the **pencil icon** to make amendments. Use the **bin icon** to delete the scheduled report.

> [!WARNING]
>
> For security reasons, the recipient's email address must be registered with Zappl. \
> Use the [Accounts](/portal/accounts) section to ensure the email address you wish to send reports to has an active Zappl account before scheduling the report.
## Downloading Reports
If you prefer to download a one-off report as opposed to scheduling an email report, simply navigate to `Reports`, then under `Download Report`, select the report type you wish to download and click **Download**.

# Settings
Source: https://docs.zappl.co/portal/settings
Make basic account changes and updates, add a company logo or delete your account.
## Account Information
Here, you are able to add your company Logo to provide branding in the bottom left corner as you navigate the Portal. It is also used as add custom branding to Zappl [Reports](/portal/reports).
In addition, you can edit the email address associated with your account and your name.

## Password Changes
You can update your account password here, ensuring that it matches our requirements;
> [card] Minimum of 8 characters
As well as at least one of the following;
> [card] Lowercase Letter
> [card] Uppercase Letter
> [card] Number
> [card] Special Charcacter

## Deleting Your Account
Finally, you have the option to delete your Zappl Portal account.
> [!WARNING]
>
> Only do this if you are certain that the account is no longer needed.\
> **Your information will not be recoverable if you delete your account.**

# Apps added to Catalog
Source: https://docs.zappl.co/updates/app-catalog-additions
New apps are added to the [Zappl App Catalog](https://zappl.co/app-catalog) on a regular basis.
> [!NOTE]
>
> If you're a Zappl customer and would like to request an app to be added to the Catalog, please email [support@zappl.co](mailto:support@zappl.co).
**November 2026**
| **ThinkRail** | `ai.thinkrail.app` |
| **Goose** | `com.electron.goose` |
| **Supercut** | `build.float.Supercut` |
| **Viktor** | `com.viktor.desktop` |
| **Littlebird** | `com.genos.littlebird` |
**October 2026**
| **Burp Suite** | `com.install4j.6592-1155-2163-3973.70` |
| **LucidLink** | `com.lucidlink.app` |
| **Prisma Access Browser** | `com.talon-sec.Work` |
| **Glean** | `com.glean.desktop` |
| **Marked 3** | `com.brettterpstra.marked` |
| **Inkdrop** | `info.pkpk.inkdrop` |
| **AWS Wickr** | `com.wickr.WickrProMac` |
| **Grok Bot** | `com.anysphere.sand` |
| **Mintlify Desktop** | `com.mintlify.electron` |
| **Gitify** | `com.electron.gitify` |
| **MindManager 26** | `com.mindjet.mindmanager.26` |
| **Kaleidoscope** | `app.kaleidoscope.v4` |
| **Retcon** | `garden.lemon.Retcon` |
| **KiroCrew** | `com.amazon.kiro.crew` |
| **SketchUp 2027** | `com.sketchup.SketchUp.2027` |
| **Amazon Corretto 27** | `com.amazon.corretto.27` |
| **Azul Zulu Open JDK 27** | `com.azul.zulu.27.jdk` |
**September 2026**
| **Perplexity** | `ai.perplexity.macv3` |
| **CapCut** | `com.lemon.lvoverseas` |
| **macshot** | `com.sw33tlie.macshot.macshot` |
| **Flameshot** | `org.flameshot.Flameshot` |
| **Parallels Desktop 27** | `com.parallels.desktop.27` |
**August 2026**
| **Monotype Connect** | `com.extensis.connect` |
| **Dragonframe** | `com.dzed.dragonframe2026` |
| **Azul Zulu Open JDK 25 LTS** | `com.azul.zulu.25.jdk` |
| **Amazon Corretto 25** | `com.amazon.corretto.25` |
| **Amazon Corretto 26** | `com.amazon.corretto.26` |
| **Azul Zulu Open JDK 26** | `com.azul.zulu.26.jdk` |
| **macOSLAPS** | `edu.psu.macOSLAPS` |
| **Wave Link** | `com.elgato.WaveLink3` |
| **Elgato Studio** | `com.elgato.studio` |
| **Elgato Control Center** | `com.corsair.ControlCenter` |
| **LogMeIn Resolve Desktop Console** | `com.goto.resolve.desktopconsole` |
| **LastPass for Desktop** | `com.lastpass.lastpass-electron` |
| **OmniFocus** | `com.omnigroup.OmniFocus4` |
| **WalkMe Editor** | `com.walkme.editor` |
| **License Store** | `com.apptorium.License-Store-Paddle` |
| **Desktop Composer** | `com.apptorium.DesktopComposer` |
| **LiquidFetch** | `com.apptorium.LiquidFetch-Direct` |
| **Cursor Teleporter** | `com.apptorium.CursorTeleporter-Paddle` |
| **ThemeEdit** | `com.apptorium.ThemeEdit` |
| **ScreenFocus** | `com.apptorium.ScreenFocus-dm` |
| **Expressions** | `com.apptorium.Expressions-dm` |
| **NoteApp** | `com.apptorium.NoteApp` |
| **OpenCode** | `ai.opencode.desktop` |
| **Attention** | `com.attention.widget` |
| **Reveal** | `com.ittybittyapps.Reveal2` |
| **Amadeus Pro 3** | `com.HairerSoft.AmadeusPro3` |
| **Slite** | `com.slite.desktop` |
| **OpenLogi** | `org.openlogi.openlogi` |
| **Shure MOTIV Mix** | `com.shure.motivmix` |
| **OBSBOT Center** | `com.obsbot.OBSBOT_Center` |
**July 2026**
| **RealVNC Connect Viewer** | `com.realvnc.rvncconnect` |
| **ChatGPT** | `com.openai.codex` |
| **ChatGPT Classic** | `com.openai.chat` |
| **Geekbench 7** | `com.primatelabs.parkdale` |
| **Gemini** | `com.google.GeminiMacOS` |
| **TypeWhisper** | `com.typewhisper.mac` |
| **oMLX** | `app.omlx` |
| **Kiro** | `dev.kiro.desktop` |
**June 2026**
| **SketchUp 2026** | `com.sketchup.LayOut.2026` |
| **Willow Voice** | `com.seewillow.WillowMac` |
| **jamf-cli** | `com.jamf.concepts.jamf-cli` |
| **Morphic** | `org.raisingthefloor.Morphic` |
| **SecureSafe Files** | `com.dswiss.secure-safe-files` |
| **Aglide Desktop** | `com.todesktop.231029cd6y8emey` |
**May 2026**
| **Conductor** | `com.conductor.app` |
| **Notepad++** | `org.notepadplusplus.mac` |
| **cmux** | `com.cmuxterm.app` |
| **Nextpad++** | `org.nextpadplusplus.mac` |
**April 2026**
| **Tella** | `tv.tella.Tella` |
| **LinearMouse** | `com.lujjjh.LinearMouse` |
| **SteerMouse** | `jp.plentycom.app.SteerMouse` |
| **DynamicHorizon** | `SuperEvilCorp.DynamicHorizon` |
| **LaunchNext** | `LaunchNext` |
| **NotchFlow** | `com.benshih.notchFlow` |
| **Thaw** | `com.stonerl.Thaw` |
| **boringNotch** | `theboringteam.boringnotch` |
| **Droppy** | `iordv.Droppy` |
| **MiddleClick** | `art.ginzburg.MiddleClick` |
| **Kitty** | `net.kovidgoyal.kitty` |
| **MiddleDrag** | `app.middledrag.MiddleDrag` |
| **DockDoor** | `com.ethanbills.DockDoor` |
| **Tuna** | `com.brnbw.Tuna` |
| **AxM Jamf Sync** | `com.karthikmac.axmjamfsync` |
| **Auto-Claude** | `com.autoclaude.ui` |
| **Pique** | `io.macadmins.pique` |
| **Space Capsule** | `com.knollsoft.Space-Capsule` |
| **Twingate** | `com.twingate.macos` |
| **Elevate24** | `com.jigsaw24.Elevate24` |
| **Parallels Desktop 26** | `com.parallels.desktop.26` |
| **Okta Verify** | `com.okta.mobile` |
| **Wispr Flow** | `com.electron.wispr-flow` |
**March 2026**
| **Paper** | `com.todesktop.2601167vjw8xe` |
| **Dell Display Manager** | `Qisda.DDPM` |
| **Genesys Cloud** | `com.inin.purecloud.directory` |
| **Slido** | `com.slido.SlidoApp` |
| **Sim Daltronism** | `com.michelf.sim-daltronism` |
| **Blankie** | `com.codybrom.blankie` |
| **LocalSend** | `org.localsend.localsendApp` |
| **Background Music** | `com.bearisdriving.BGM.app` |
| **Loop** | `com.MrKai77.loop` |
| **Keycastr** | `io.github.keycastr` |
| **AutoRaise** | `com.sbmpost.AutoRaise` |
| **Handy** | `com.pais.handy` |
| **Sigma AI Browser** | `com.sigmabrowser.sigmabrowser` |
| **Files.com Desktop** | `com.files.desktop` |
| **GitHub Copilot for Xcode** | `com.github.CopilotForXcode` |
| **Haptyk** | `com.olidev.haptyk.app` |
**February 2026**
| **Windsurf** | `com.exafunction.windsurf` |
| **BentoBox** | `org.friendlyventures.BentoBox` |
| **ClaudeBar** | `com.tddworks.claudebar` |
| **Google AntiGravity** | `com.google.antigravity` |
| **Kosmik** | `path.lithium.kosmik` |
| **Notion Mail** | `notion.mail.id` |
| **ChatGPT Atlas** | `com.openai.atlas` |
| **Dia Browser** | `company.thebrowser.dia` |
| **Fellou AI** | `com.fellou.ai` |
| **Granola** | `com.granola.app` |
| **Ecosia** | `org.ecosia.browser` |
**January 2026**
| **Logi G Hub** | `com.logi.ghub` |
| **Logi Options+** | `com.logi.optionsplus` |
# AppBar Updates
Source: https://docs.zappl.co/updates/appbar-changelog
> [!TIP]
>
> Keep up with our Changelog with the [RSS Feed](https://docs.zappl.co/updates/appbar-changelog/rss.xml).
**v1.1.0**
2026-10-08
Added support for the new [Enable Update Status Text](/appbar/appbar-preferences#enable-update-status-text) preference, which hides the deferrals remaining / pending updates text in the Updates tab. This requires the latest [AppBar Preferences JSON Schema](https://latestinstaller.zappl.co/Resources/JSON%20Schema/AppBar%20Preferences.json?v=4).
Improved button visibility when using dark mode and Liquid Glass.
**v1.0.4**
2026-07-17
Fixed a bug where badge updates and notifications weren't triggering, present since Zappl v3.0.0. Fixed a bug where notifications were triggered when updates for the AppBar app were available. Added more spacing between the app icon and the header text.
**v1.0.3**
2026-06-05
Added support for [Zappl v3](https://zappl.co/blog/zappl-v3-here-s-whats-new) in preparation for it's official release on Wednesday 1st July.
**v1.0.2**
2026-04-23
Added support for the new [Installs Tab Hidden](/appbar/appbar-preferences#installs-tab-hidden) preference which hides the installs tab when it is disabled.
This requires the latest [AppBar Preferences JSON Schema](https://latestinstaller.zappl.co/Resources/JSON%20Schema/AppBar%20Preferences.json?v=4).
**v1.0.1**
2026-04-20
Added the option for **selfService** to be used as a Custom Logo variable for Jamf Pro customers.
**v1.0.0**
2026-04-17
Official AppBar public release.
# Zappl Updates
Source: https://docs.zappl.co/updates/changelog
> [!TIP]
>
> Keep up with our Changelog with the [RSS Feed](https://docs.zappl.co/updates/changelog/rss.xml).
**v3.1.3**
2026-10-28
AppBar is now only automatically installed during Zappl's regular background run, and no longer during app installs.
Added more detailed logging to show where the AppBar auto-install preference comes from (the default or a configuration profile).
**v3.1.2**
2026-10-12
Improved the handling of licence key validation.
**v3.1.1**
2026-10-09
Fixed a keychain prompt shown when Zappl was installed via Jamf Pro Self Service.
Fixed an issue on macOS 27 where the Zappl log file no longer displayed the full date on log entries.
**v3.1.0**
2026-10-08
Zappl now requires macOS Sequoia (15.0) or later. macOS Sonoma is no longer supported by Apple, so devices running Sonoma will remain on Zappl v3.0.3, which continues to work, and will not receive further Zappl updates.
Improved the resilience of app updates. DMG and ZIP updates are now prepared alongside the existing app and swapped into place in a single step, so the existing app remains usable until the new version is ready.
Improved the handling of simultaneous Zappl processes.
Replaced deprecated features in preparation for their removal in macOS 28.
**v3.0.3**
2026-09-08
Improved the reliability of internet connectivity checks performed on each Zappl run.
**v3.0.2**
2026-08-18
Scheduled update prompts now respect the download stagger window when background updates are disabled, ensuring updates are downloaded before users are prompted rather than immediately surfacing carried-over updates from previous patch days.
**v3.0.1**
2026-07-22
Removed deprecated logic that recorded network status following download issues.
The Zappl daemon now points directly to the Zappl app path rather than the symlink, ensuring the Zappl app and its icon are correctly displayed under Login Items in System Settings.
**v3.0.0**
2026-07-14
Zappl v3 introduces a completely redesigned user interface, rebuilt in SwiftUI to match [AppBar](/appbar/introduction)'s look and theme. As part of this, the Zappl agent has migrated from a command line tool to a SwiftUI app, though it continues to support all the same command line options.
Update prompts now display each pending update as an app card, alongside a new customisable info popover explaining the update and deferral process. The update progress prompt is smaller and more subtle, and the update completion prompt has been replaced by a native macOS notification. Self Service update prompts have also been deprecated - running `zappl -u selfService` now redirects users to AppBar instead.
A number of preferences have been deprecated, and several new ones added, including `enableLiquidGlass`, `showInfoButton`, `initialPromptInfoPopover` and `gracePeriodPromptInfoPopover`. Zappl v3 remains backwards compatible with existing configuration profiles - deprecated preferences are simply ignored, and new preferences retain their defaults until configured. If you're a Jamf Pro customer, it's recommended you update to the latest [JSON schema](https://latestinstaller.zappl.co/Resources/JSON%20Schema/Zappl%20Preferences.json?v=3.0.0). For all other MDMs, refer to the updated [preferences documentation](/customise/preferences) and [sample plist](https://latestinstaller.zappl.co/Resources/Minimal%20Plist/Zappl%20Preferences%20Sample.plist?v=3.0.0).
Because Zappl is now an app rather than a standalone binary, an updated PPPC profile and a new combined Zappl and AppBar Notifications profile are required - without these, users may see permission and notification prompts when Zappl runs. Both are available from our [Deploy Anywhere guide](/deploy/deploy-anywhere). Jamf Pro customers using the Installation Status extension attribute should also update to the latest revision, which checks for the new app bundle path.
For full details on everything that's changed, [read the blog post](https://zappl.co/blog/zappl-v3-here-s-whats-new).
**v2.6.2**
2026-06-19
Fix added for a bug introduced in 2.6.0 whereby, on clean installs, on-demand Self Service updates immediately after Zappl is installed do not override the scheduled background stagger check.
Please note, Self Service updates are deprecated as of July 14th when Zappl v3 releases - [more info](https://zappl.co/blog/zappl-v3-here-s-whats-new).
**v2.6.1**
2026-06-17
Added forward compatibility for the new Zappl v3 preferences to suppress errors caused by the changed preferences. The new schema will be released in the coming weeks, ahead of Zappl v3's official release on Wednesday, July 1st. For more information on Zappl v3 - [click here](https://zappl.co/blog/zappl-v3-here-s-whats-new).
**v2.6.0**
2026-06-02
The download stagger window now applies to scheduled update prompts when background updates are disabled. The dependency between the two keys has also been removed, so `downloadStaggerWindow` can be configured independently regardless of whether background updates are enabled.
To better reflect this behaviour, the preference key has been renamed from `backgroundUpdateWindow` to `downloadStaggerWindow`.
Additionally, the `hourlyCheck` preference key has been renamed to `backgroundUpdates` since background updates now operate on the stagger window rather than a fixed hourly interval.
Both old keys are deprecated but will continue to work.
If you're a Jamf Pro customer, it's recommended you update your Zappl preferences configuration profile to use the latest [JSON schema](https://latestinstaller.zappl.co/Resources/JSON%20Schema/Zappl%20Preferences.json?v=3.0.0). For all other MDMs, refer to the updated [sample plist](https://latestinstaller.zappl.co/Resources/Minimal%20Plist/Zappl%20Preferences%20Sample.plist?v=3.0.0) to see the new key labels in use.
**v2.5.1**
2026-04-23
Increased the refresh frequency of local AppBar data via Zappl
**v2.5.0**
2026-04-20
Official support for AppBar added. Zappl now automatically deploys AppBar when the [Automatically Install AppBar](/customise/preferences#automatically-install-appbar) preference is configured.
`--appbar` flag added to the Zappl uninstaller binary to allow AppBar uninstalls.
**v2.4.1**
2026-04-15
Prevented Zappl from attempting to download additional components on first run when no internet connection is detected, avoiding misleading errors in the Zappl portal.
Improved the handling of post-install scripts during app installations.
**v2.4.0**
2026-03-26
Added a new [Background Update Stagger Window](/customise/preferences#background-update-stagger-window) option. This option requires the latest [JSON schema](https://latestinstaller.zappl.co/Resources/JSON%20Schema/Zappl%20Preferences.json?v=3.0.0) for Jamf Pro customers. All other customers can refer to the updated [preferences document](/customise/preferences) and the [sample plist](https://latestinstaller.zappl.co/Resources/Minimal%20Plist/Zappl%20Preferences%20Sample.plist?v=3.0.0).
Added a new feature to automatically clear all entries older than 4 weeks in `/var/log/Zappl.log` to prevent performance issues when viewing the log.
**v2.3.3**
2026-03-12
Minor improvements made to the handling of PKG installers.
**v2.3.2**
2026-03-10
Fixed a bug introduced in v2.1.1 whereby the Jamf Pro Self Service update prompts do not respect "Horizontal List Mode" when there are multiple pending updates.
**v2.3.1**
2026-03-09
Improved the logging messages sent to [AppBar](/appbar/introduction).
**v2.3.0**
2026-02-26
Added further support for the new [AppBar](/appbar/introduction) menu bar app.
**v2.2.1**
2026-02-25
Fixed an issue where devices without an internet connection would generate misleading errors in the portal. Fixed an issue where devices in trial mode without an internet connection would incorrectly attempt to validate the trial license via the server. Fixed an issue where the Next Prompt date displayed in the portal was incorrect when using the Patch Day Weeks configuration option.
**v2.2.0**
2026-02-17
Added support for the new [AppBar](/appbar/introduction) menu bar app.
Changed default icon logic to fall back to SF Symbol if no Jamf Self Service icon is found and no custom icon is defined.
**v2.1.2**
2026-01-29
Fixed a bug with DND mode not being detected in macOS Tahoe.
**v2.1.1**
2026-01-13
Added support for Zappl to install and run commands outside of a user console session. This allows Zappl to run with integrations which run pre-login (such as Jamf Setup Manager etc) without keychain error prompts.
Added more verbosity to Jamf recons being run via Zappl, and added logic to kill any recons which hang.
Further security enhancements made to the backend infrastructure.
**v2.1.0**
2025-12-03
Added support for the new "Enable Compliance Reporting" option which allows you to disable report submission to the Zappl portal. This is useful for test devices or environments where portal reporting is not required.
This requires the latest [JSON schema](https://latestinstaller.zappl.co/Resources/JSON%20Schema/Zappl%20Preferences.json?v=3.0.0) if you are using Jamf Pro. Other customers can refer to the updated [preferences document](https://docs.zappl.co/customise/preferences) and the [sample plist](https://latestinstaller.zappl.co/Resources/Minimal%20Plist/Zappl%20Preferences%20Sample.plist?v=3.0.0).
**v2.0.4**
2025-11-26
Added further support for locales and fixed a bug introduced in v2.0.3 with some disk images not mounting.
**v2.0.3**
2025-11-24
Added universal support for locales.
**v2.0.0**
2025-11-10
Enhancements made to the backend infrastructure to improve security and overall performance. As part of this change, Jamf Pro customers who wish to continue to utilise the "Deferrals Remaining" extension attribute must update to the [latest revision](https://latestinstaller.zappl.co/Resources/Extension%20Attributes/Zappl%20Extension%20Attributes.zip?v=3.0.0) of this extension attribute.
Improvements made to the appearance and default behaviour of update prompts.
Improvements made to file download functionality.
Added new command line flag to update specific apps on demand. For more info, see the [command line options](https://docs.zappl.co/other/command-line).
Added support for the new "Week(s) of Month" option which allows you to specify which weeks in the month users are prompted to update on the configured patch day (e.g. Tuesday on the first week of each month) when "Specify Recurring Patch Day" is configured as your desired Run Frequency Option. This requires the latest [JSON schema](https://latestinstaller.zappl.co/Resources/JSON%20Schema/Zappl%20Preferences.json?v=3.0.0) if you are using Jamf Pro. Other customers can refer to the updated [preferences document](https://docs.zappl.co/customise/preferences) and the [sample plist](https://latestinstaller.zappl.co/Resources/Minimal%20Plist/Zappl%20Preferences%20Sample.plist?v=3.0.0).
**v1.4.0**
2025-10-13
Added support for Jamf Self Service+ icons to be shown on update prompts. Improved the update prompt appearance for macOS Tahoe.
**v1.3.1**
2025-07-10
Enhanced the download URL retrieval process.
**v1.3.0**
2025-06-17
Additional post install checks added for app bundles.
**v1.2.9**
2025-06-16
Improvements to the backend code and various log outputs.
**v1.2.8**
2025-06-06
Adds support for apps that install into the User’s Applications directory (\~/Applications).
**v1.2.7**
2025-05-28
Added additional folder structure checks to the initial error handling mechanism.
**v1.2.6**
2025-05-12
Made improvements to PKG signature verification.
**v1.2.5**
2025-04-28
Fixed bug whereby DMG with EULA installers fail file hash check because we were checking the hash of the converted .cdr image. Resolved by keeping the original DMG and verifying the hash of that before removing it.
**v1.2.4**
2025-04-28
Fixed bug with installs not exiting after deleting the app when the installer hash doesn't match. This caused a failed install as the app had been removed.
**v1.2.3**
2025-04-17
Fixed bug where patch day calculations are used when patch day isn't configured.
**v1.2.2**
2025-04-11
Added support for Apps which have DMGs nested in ZIP files.
**v1.2.1**
2025-03-27
Added option to skip automatic permissions setting to allow it to be done with a delay through the post-install script. This is for apps where gatekeeper takes a while to finish verification. Also added logic to allow app installs to make up to 10 API calls daily if the specified app was not found in the offline app catalog.
**v1.2.0**
2025-03-13
Improved internal backend logic, and fixed some user `full name` output bugs.
**v1.1.2**
2025-03-11
Bug fixes, including a loop bug where `'components could not be verified'`.
**v1.1.1**
2025-02-19
Zappl will now conduct 2 App Catalog API calls per day, reducing the network activity from Zappl without affecting the end user experience of effectiveness of Zappl.
**v1.1.0**
2025-01-17
Moved some API infrastructure in our backend system.