Skip to main content

Configure Nudge Using a Custom External JSON Schema

Updated over a month ago

Description

There are a number of ways to update macOS versions on computers but finding one standard workflow that is reliable can be difficult. Nudge is an open-source, third-party application created by the MacAdmin’s Slack Community that prompts users to install updates using built in Apple methods: System Preferences/System Settings > Software Update or standalone macOS installer.

Note: for major upgrades using the installer, users must be admin users. Standard macOS users will not be able to run the installer.

Custom user deferrals are offered so that the user can update the computer with the built-in macOS UI when it is convenient for them while not sacrificing putting off the update entirely.

This guide covers a basic setup and deployment method of Nudge using the Custom JSON Schema option in Jamf Pro. The alternative is to upload a plist that is outlined in Setting up and Configuring Nudge using plist. Check out Nudge's Wiki page for more info on how it works and the different configurations that can be deployed.

Article Contents

Configuring Nudge with a Custom External JSON Schema

Packages

  1. Download the Nudge package and Launch Agent package from https://github.com/macadmins/nudge/releases

  2. Upload the two packages to Jamf Pro: Settings > Computer Management > Packages > New > Choose File > select package from Step 1. Repeat for the second package.

  3. Create a policy in Jamf Pro to deploy the Nudge package. Note, Nudge is extremely safe to install. Nothing will be apparent on the computer after installation until a configuration profile is deployed.

    1. Navigate to Computers > Policies > New.

    2. Give the policy a name.

    3. Set the execution frequency to Once per computer and choose the desired trigger (Once Per Computer is recommended in most cases).

    4. On the package payload, select Configure.

    5. Select the Add button next to the Nudge installation package from step 2.

    6. Select the + symbol to the right of the Nudge installation package.

    7. Select the Add button next to the Nudge Launch Agent package.

    8. Scope the policy to a test computer.

    9. Click Save.

This photo shows where you will perform the steps above and click Save in the bottom right corner.

The Custom JSON Schema Profile

Create the Nudge configuration Profile in Jamf Pro using the Custom JSON Schema by following the steps below.

  1. In Jamf Pro, navigate to Computers > Configuration Profiles and click New.

  2. Fill out the Display Name in the General payload.

  3. Select the Application & Custom Settings payload, click External Applications, and click the +Add button in the upper-right corner.

  4. For Source, choose Custom Schema from the dropdown box. In the Preference Domain field paste use the domain: com.github.macadmins.Nudge

  5. Click +Add schema, paste the text output from this link: https://raw.githubusercontent.com/macadmins/nudge/main/Schema/jamf/com.github.macadmins.Nudge.json

    This photo shows where you are supposed to +Add schema that is custom for you.

  6. Click Save.

  7. Configuring the Nudge options desired. The list of options can be found on the Nudge Wiki. For this example we are just going to use the "osVersionRequirements" option with sub-options "requiredInstallationDate" and "targetedOSVersions" which are the minimum options required for Nudge to work.

    1. Under osVersionRequirements use the dropdown to select Configured.

    2. Under osVersionRequirement 1 click add/remove properties and deselect the top Properties box.

    3. Select the requiredInstallationDate and targetedOSVersions check boxes and click Apply.

    4. Change the requiredInstallationDate and targetedOSVersions drop downs to Configured.

    5. Under requiredInstallationDate we need to set the value similar to the following: 2024-10-03T19:00:00Z.

      • This value is set with the format like YYYY-MM-DDT00:00:00Z. The first set of numbers after the 'T' is the hours in 24 hour format followed by minutes and lastly Seconds.

    6. Set targetedOSVersions to the value of OS version we are looking to install - for example: 13.6.

  8. Click Scope and scope this profile to the same test computer from step 3 in the first section in the article, Packages.

This photo shows where you will perform the steps above.

​

Nudge Notifications (Optional)

This profile will help alter users if Nudge/MacOS failed to update their computer, such as:

This photo shows the pop-up that you may be experiencing, if so perform the steps below.

To create the Notification profile in Jamf Pro, follow the steps below.

  1. Navigate to Computers > Configuration Profiles > New.

  2. On the General payload, specify this profile as being a Nudge Notifications Profile and installing at the Computer Level.

  3. Select the Notifications payload and click the +Add button.

  4. Set the App Name as Nudge. Set the Bundle ID to com.github.macadmins.Nudge.

  5. Select the desired settings for the notification payload.

  6. Scope this profile to the same test computer from Step 3 in the first section of the article, Packages.

This photo shows where you will perform the steps above.

Related Articles
FileVault Configuration Profile Certificate in Jamf Pro
Deploying 3rd Party Options for macOS Software Updates using Jamf Pro
Keeping Macs up-to-date using a Jamf Pro Configuration Profile
Setting up and Configuring Nudge in Jamf Pro using plist
Jamf School and Nudge for macOS updates
Did this answer your question?