Nudge

—

All optional features to enhance and customize the Nudge experience for your employer's needs.

The required components necessary to enforce an Operating System version through Nudge. Specify one array to enforce a single Operating System version across all machines or specify multiple arrays for specific enforcements.

All features related to how Nudge refreshes and defines the user experience

All features related to how Nudge defines the user interface.

When configuring Nudge using a JSON-formatted preferences file located outside of the default location, set this key to the custom location using either a remote (https://) or a local (file://) URL, and leave other keys in this payload unset. Leave this key unset when configuring Nudge using the other keys in this payload.

When a major upgrade is required, Nudge will attempt to download it through the softwareupdate binary.

The application Bundle ID which Nudge allows without taking focus. (You can specify one or more Bundle ID.)

When enabled, Nudge will not activate or re-activate when assertions are currently set.

The application names using assertions which Nudge allows without taking focus. (You can specify one or more applications. To find the names please run /usr/bin/pmset -g assertions in terminal while the application is open and running)

When enabled, Nudge will not activate or re-activate when the camera is on.

When enabled, Nudge will not activate or re-activate when screen sharing is active.

When disabled, Nudge will not hide all non-acceptableApplicationBundleIDs after the requiredInstallationDate or allowedDeferrals.

When disabled, Nudge will not create a blurred background when the user is past the deferral window.

When disabled, Nudge will wait for Software Update to finish downloading (if any) updates before showing the UI.

When enabled, Nudge will attempt to block application launches after the required installation date. This key must be used in conjunction with blockedApplicationBundleIDs

The application Bundle ID which Nudge disallows from launching after the required installation date. (You can specify one or more Bundle ID.)

When utilizing a SOFA feed and disableNudgeForStandardInstalls is true, Nudge will only enforce updates with published CVEs. Defaults to false.

When disableSoftwareUpdateWorkflow is true, Nudge will not attempt to run the softwareupdate process. Defaults to false.

When enabled, Nudge will enforce minor updates. This should likely never be disabled.

When enabled, Nudge will terminate the applications listed in blockedApplicationBundleIDs upon initial launch.

When enabled, Nudge will not activate or re-activate when an update is being downloaded, prepared or staged.

When disabled, Nudge will no longer compare the current device against the SOFA feed for the required update. If the device cannot install this update, Nudge will not present the Unsupported UI

A url path to use a custom SOFA feed.

When enabled, Nudge will not activate or re-activate when a user is in DoNotDisturb/Focus status. This feature is expiremental and may not work in all user settings.

When enabled, Nudge will honor the current cycle timers when user's press the `Quit` button.

The maximum age the cached SOFA feed file can be on disk. When this file age expires, Nudge will re-assess the SOFA feed for updates. Please be mindful of changing this value as there is an associated cost for maintaining the SOFA service.

When enabled, Nudge will utilize the SOFA feed url for update data.

—

—

—

—

A single URL, enabling the More Info button URL path. While this accepts a string, it must be a valid URL (http://, https://, file://). Note: If this value is passed with aboutUpdateURLs, the aboutUpdateURLs key will be ignored.

The aboutUpdateURL - per country localization.

The app path for a major upgrade.

The required installation date for Nudge to enforce the required operating system version. You must follow a standard date string as YYYY-MM-DDTHH:MM:SSZ - Example: 2021-09-15T00:00:00Z. Required for Nudge versions 1.1.16 and below.

The required minimum operating system version. Note: When passing versions such as `11.2.0`, it will be normalized to `11.2`. It is recommended to remove the trailing zero from the version number.

The versions of macOS that require a security update. You can specify single version or multiple versions.

The OS string rule for targeting Nudge events. You can target with "default", the full OS version (example: "11.5.1"). or the major OS version (example: "11").

A path to a URI for opening alternative actions, like Jamf self service items.

When a major upgrade is under active exploit, this is the amount of days a user has to install the update.

When a minor update is under active exploit, this is the amount of days a user has to install the update.

When a major upgrade is not under active exploit but contains CVEs, this is the amount of days a user has to install the update.

When a minor update is not under active exploit but contains CVEs, this is the amount of days a user has to install the update.

When a major upgrade has no known CVEs, this is the amount of days a user has to install the update.

When a minor update has no known CVEs, this is the amount of days a user has to install the update.

A single URL, enabling the More Info button URL path when using the unsupported UI. While this accepts a string, it must be a valid URL (http://, https://, file://). Note: If this value is passed with aboutUpdateURLs, the aboutUpdateURLs key will be ignored.

The unsupportedURL - per country localization.

The amount of minor versions a device can be behind before the requiredInstallationDate is recalculated against a previous update.

—

The targeted language locale for the user interface. Note: For a list of locales, please run the following command in Terminal: /usr/bin/locale -a

The URL for the More Info button. While this accepts a string, it must be a valid URL (http://, https://, file://).

—

—

The targeted language locale for the user interface. Note: For a list of locales, please run the following command in Terminal: /usr/bin/locale -a

A single URL, enabling the More Info button URL path when using the unsupported UI. While this accepts a string, it must be a valid URL (http://, https://, file://). Note: If this value is passed with aboutUpdateURLs, the aboutUpdateURLs key will be ignored.

This will disable all functionality related to the `userExperience` preference domain.

The number of times a user can defer Nudge (change it from the currently active window) before the "aggressive user experience" is enabled.

Allows a device to modify the requiredInstallationDate logic and launch behavior. Useful for new device provisioning.

Allows the user to specify when they will next be prompted by Nudge. (Set to `False` to maintain v1.0.0 behavior.) When using this feature, Nudge will no longer adhere to your LaunchAgent logic as the user is specifying their own execution time for the next Nudge event.(See: `~/Library/Preferences/com.github.macadmins.Nudge.plist`.)

The amount of time in hours Nudge will extend the requiredInstallationDate for newly provisioned devices.

The amount of time in hours Nudge will bypass launching for newly provided devices.

The path of the file Nudge will read and assess for allowGracePeriods.

The amount of time in seconds Nudge will use as a timer to refresh the user interface if it is not the currently active window. This key is directly tied to its partner key `imminentWindowTime` to know when to trigger this timer.

The number of times a user can defer Nudge (change it from the currently active window) before both quit buttons need to be actioned.

The amount of time in seconds Nudge will use as a timer to refresh the user interface if it is not the currently active window. This key is directly tied to its partner key `approachingWindowTime` to know when to trigger this timer.

The amount of time in hours Nudge will use to determine that the `requiredInstallationDate` is "approaching".

The amount of time in seconds Nudge will use as a timer to refresh the user interface if it is not the currently active window. This key is triggered once the `requiredInstallationDate` has expired.

—

The amount of time in hours Nudge will use to determine that the `requiredInstallationDate` is "imminent".

The amount of time in seconds Nudge will use as a timer to refresh the user interface if it is not the currently active window. This key is triggered for all Nudge launches until the `approachingWindowTime` has been passed.

The maximum amount of delay Nudge will utilize before launching the UI. This is useful if you do not want your users to all receive the Nudge prompt at the exact time of the LaunchAgent. Note: This functionality only applies when also enabling `randomDelay`.

The amount of time in seconds Nudge will use as its core timer to refresh all the core code paths. Note: While you can lower this setting, it could make Nudge too aggressive. Be mindful of decreasing this value.

Enables an initial delay Nudge before launching the UI. This is useful if you do not want your users to all receive the Nudge prompt at the exact time of the LaunchAgent.

Allows the user to press the `Later` button through the custom deferrals UI

Allows the user to move the Nudge window.

Utilize the approachingWindowTime or imminentWindowTime for calendar deferrals.

The identifier of the Nudge LaunchAgent. Only set this if you use a custom identifier

Loads the Nudge LaunchAgent using macOS Ventura's SMAppService API (macOS 13+ required).

When a new major upgrade is posted to the SOFA feed, this can artificially delay the SOFA nudge events by x amount of days.

When a new minor update is posted to the SOFA feed, this can artificially delay the SOFA nudge events by x amount of days.

Enables Nudge to launch in the simplified user experience.

Force the built-in ScreenShot icon to render in the UI if a ScreenShot path is not passed.

Enables or disables the deferral count of the current Nudge event.

Only display one quit button regardless of proximity to the due date.

A path to a local jpg, png, icns that contains the icon for dark mode. This will replace the Apple logo on the left side of Nudge.

A path to a local jpg, png, icns that contains the icon for light mode. This will replace the Apple logo on the left side of Nudge.

A path to a local jpg, png, icns that contains the screen shot for dark mode. This will replace the Big Sur logo on the lower right side of Nudge.

A path to a local jpg, png, icns that contains the screen shot for light mode. This will replace the Big Sur logo on the lower right side of Nudge.

A path to a URI for opening alternative actions, like Jamf self service items.

The language to revert to if no localizations are available for the device's current language.

Force the custom localizations to the value of `fallbackLanguage`.

The individual buttons and text elements that can be customized for your employer's needs. This includes per country localization.

A local image path for the notification event when Nudge terminates and application.

When utilizing showRequiredDate, set a custom display format. Be aware that the format you desire may not look good on the UI.

When disabled, Nudge will not show the Actively Exploited CVEs in the left sidebar.

When disabled, Nudge will not show the `Days Remaining To Update:` item on the left side of the UI.

When enabled, Nudge will also show the requiredInstallationDate as string formatted date.

—

The targeted language locale for the user interface. Note: For a list of locales, please run the following command in Terminal: /usr/bin/locale -a

Modifies the customDeferralButtonText, also known as the "Custom" button.

customDeferralDropdownText, also known as the "Defer" button.

Modifies the oneDayDeferralButtonText, also known as the "One Day" button.

Modifies the oneHourDeferralButtonText, also known as the "One Hour" button.

Modifies the informationButton, also known as the "More Info" button.

Modifies the mainContentHeader. This is the "Your device will restart during this update" text.

Modifies the mainContentSubHeader. This is the "Updates can take around 30 minutes to complete" text.

Modifies the `mainContentText`. This is the "A fully up-to-date device is required to ensure that IT can your accurately protect your device." text. (See the Wiki for information on adding line breaks.)

Modifies the mainContentNote. This is the "Important Notes" text.

Modifies the `mainHeader`. This is the "Your device requires a security update" text.

Modifies the actionButton, also known as the "Update Device" button.

Modifies the `primaryQuitButton`, also known as the "Later" button.

Modifies the `secondaryQuitButton`, also known as the "I understand" button.

Modifies the `subHeader`. This is the "A friendly reminder from your local IT team" text.

Modifies the primaryQuitButton, also known as the "Update Device" button when using the Unsupported UI.

Modifies the terminated application notification title.

Modifies the terminated application notification body.

Modifies the mainContentHeader. This is the "Your device is no longer capable of receiving critical security updates" text when using the Unsupported UI.

Modifies the mainContentNote. This is the "Important Notes" text when using the Unsupported UI.

Modifies the mainContentSubHeader. This is the "Please work with your local IT team to obtain a replacement device" text when using the Unsupported UI.

Modifies the `mainContentText`. This is the "A fully up-to-date device is required to ensure that IT can your accurately protect your device." text when using the Unsupported UI. See the Wiki for information on adding line breaks.

Modifies the `mainHeader`. This is the "Your device requires a security update" text when using the Unsupported UI.

Modifies the accessible hover over on screen shots.

Modifies the `subHeader`. This is the "A friendly reminder from your local IT team" text when using the Unsupported UI.