Setup Manager 1.4.1

• finishedScript and finishedTrigger now respect when DEBUG key is set and do nothing (#181)
• improved error detection and reporting in DEBUG mode (#150, #180)
• adjusted recon/Update Inventory workflow, to adapt to a change in jamf binary (#177)
• fixed custom JSON for Jamf Pro profile for Webhooks (#184)
• localization fixes

Setup Manager 1.4

While making sure that Setup Manager looks nice with macOS Tahoe and Liquid Glass, we have added a few more features to improve customization.

New Features

• User Interface
  • macOS Tahoe/Liquid Glass adaptions
  • new banner key allows you to provide a banner image that cover the top part of the Setup Manager window (details)
  • title and icon keys are now optional, when a banner key is set
  • action tiles can have a background color set with the top-level or per-action 'tileColor'key
  • banner and background can use hex or system colors
  • where colors are defined, you can use system color names. See 'Defining Colors' for details
• new profile keys:
  • networkQualityCheck suppresses network bandwidth calculation when set to false (#135)
  • finishedMessage for a customized message when Setup Manager workflow is complete (#128)
• logging:
  • new tab for configuration profiles in the log
  • detection of configuration profile installation and removal
  • image/icon load errors are now logged
  • logs a warning when Setup Manager detects it is launched for a second time
• switched launch tracking to a new service (see Launch Tracking for details)

Fixes and Improvements

• disabled check for Jamf.app as it could fail in some challenging network configs
• enrollmentUserID added to webhook data (#140)
• localization fixes (#149)
• elapsed time in Mac Info window stops counting when workflow is finished
• link to computer in Slack and Teams messages should work with Jamf School
• setting computer name with user entry or computerNameTemplate works with Jamf School
• updated uninstall.sh script (#156)
• (beta2) Localization:
  • added UK English (en-GB) localization (thanks to @philipross)
  • various localization fixes (#171)
• (beta2) fixed Network Info font color (#166)
• (beta2) waitForUserEntry action correctly runs a recon/Update Inventory (#168)
• (beta2) accentColor affects all items and controls (#170)
• (beta2) UI adjustments (#169)

Changes, deprecations and removals

• (1.4) userID top-level key name changed to enrollmentUserID
• (1.4) jssID key has been renamed to computerID
• (1.3) the minimum macOS requirement for Setup Manager is now macOS 13.5
• (1.2) showBothButtons option removed and non-functional, there will always be just one final action button displayed
• (1.1)the method for providing localized texts in the configuration profile changed in version 1.1. The previous method (by appending the two letter language code to the key) is considered deprecated. It will continue to work for the time being but will be removed in a future release. It is strongly recommended to change to the new dictionary-based solution

Notes

There are quite a few new options in Setup Manager 1.4 beta to configure and customize the new UI. There is a new option for a color or image banner across the top of the Setup Manager window. Action tiles can now be colored automatically or with specific colors. Colors can now be set anywhere that image sources are used and you get a list of named system colors.

While the description of all the keys in the repo has been updated, many of the keys, old and new, now work together for a variety of useful combinations.

Updating the profile to use 1.4 (beta) features

The good news first: we designed the update so that you can keep using the same profile from earlier versions and the Setup Manager window will look mostly the same on macOS Sequoia and earlier, and have the new “Liquid Glass” look and feel on macOS Tahoe.

To use the new UI options, set the new keys.

Banner

Setup Manager 1.4 introduces the option to show a color or image banner in the top of the Setup Manager window. This is controlled by the top-level banner key. The banner value is an image source, so it can be a reference to local image file, an image file hosted on a web server, or (also new in 1.4) a color designation.

Colors can be set with hex codes, e.g. #f00 or #f900a2 or with (new in 1.4) system color names, e.g. ##gray, ##red, etc.

The size of the banner area is 800x233 pixels (1600x466 @2x) on Sequoia and earlier and 800x247 (1600x494 @2x) on Tahoe (the liquid glass tool bar is taller). The image will be displayed with bottom-center alignment and not scaled, so you can add a few extra pixels at the top and the same image should work for all macOS versions.

The behavior of the icon and title keys changes depending on whether the banner has a value.

When no banner value is set, Setup Manager will show its app icon when an icon key is missing or empty. It will also show ‘Welcome’ or the localized equivalent when the title key is missing or empty.

When the banner is set, an empty or missing title or icon will simply not be shown. This lets you use the banner image for a completely customized experience.

Note that the banner value can be localized.

Action Tile Colors

Setup Manager 1.4 allows you to set a color for the action tiles. Use the top-level tileColor key to set the color for all action tiles. You can also set the tile color for an individual action with a tileColor key in the action.

When no tileColor is set, the default behavior is to use the window background color (gray on Sequoia and earlier, white on Tahoe, or the dark mode equivalent).

You can set the tileColor value (top-level and action level) to a hex color or system color name. There are a few special color names:

• ##automatic: calculates each tile's color from the average color of each action’s icon, icons defined with symbol:… will use the default color
• ##background: system window background (gray on Sequoia and earlier, white on Tahoe)
• ##clear: transparent or no background, works best when hideActionLabels is set to false

See tileColor and ‘Defining Colors’ in the documentation for details.

Profile Installation and Removal Logging

A new tab has been added to logging window which logs the installation and removal of configuration profiles. These events will also be logged to the main Setup Manager log, which allows you to see them in context of the entire workflow.

This can be especially useful to determine whether a particular profile disrupts the network and possibly the download of an important component. In the unified system log, these entries will have the profile category.

Setup Manager 1.4beta2

Same as the previous beta with these additional changes:

• Localization:
  • added UK English (en-GB) localization
  • various localization fixes (#171)
• fixed Network Info font color (#166)
• waitForUserEntry action correctly runs a recon/Update Inventory (#168)
• accentColor affects all items and controls (#170)
• UI adjustments (#169)

Setup Manager v1.4beta

While making sure that Setup Manager looks nice with macOS Tahoe and Liquid Glass, we have added a few more features to improve customization.

New Features

• User Interface
  • macOS Tahoe/Liquid Glass adaptions
  • new banner key allows you to provide a banner image that cover the top part of the Setup Manager window (details)
  • title and icon keys are now optional, when a banner key is set
  • action tiles can have a background color set with the top-level or per-action 'tileColor'key
  • banner and background can use hex or system colors
  • where colors are defined, you can use system color names. See 'Defining Colors' for details.
• new profile keys:
  • networkQualityCheck suppresses network bandwidth calculation when set to false (#135)
  • finishedMessage for a customized message when Setup Manager workflow is complete (#128)
• logging:
  • new tab for configuration profiles in the log
  • detection of configuration profile installation and removal
  • image/icon load errors are now logged
  • logs a warning when Setup Manager detects it is launched for a second time
• switched launch tracking to a new service (see Launch Tracking for details)

Fixes and Improvements

• disabled check for Jamf.app as it could fail in some challenging network configs
• enrollmentUserID added to webhook data (#140)
• localization fixes (#149)
• elapsed time in Mac Info window stops counting when workflow is finished
• link to computer in Slack and Teams messages should work with Jamf School
• setting computer name with user entry or computerNameTemplate works with Jamf School
• updated uninstall.sh script (#156)

Changes, deprecations and removals

• (1.4) userID top-level key name changed to enrollmentUserID
• (1.4) jssID key has been renamed to computerID
• (1.3) the minimum macOS requirement for Setup Manager is now macOS 13.5
  • Log window now uses Window
• (1.2) showBothButtons option removed and non-functional, there will always be just one final action button displayed
• (1.1)the method for providing localized texts in the configuration profile changed in version 1.1. The previous method (by appending the two letter language code to the key) is considered deprecated. It will continue to work for the time being but will be removed in a future release. It is strongly recommended to change to the new dictionary-based solution

Notes

There are quite a few new options in Setup Manager 1.4 beta to configure and customize the new UI. There is a new option for a color or image banner across the top of the Setup Manager window. Action tiles can now be colored automatically or with specific colors. Colors can now be set anywhere that image sources are used and you get a list of named system colors.

While the description of all the keys in the repo has been updated, many of the keys, old and new, now work together for a variety of useful combinations.

Updating the profile to use 1.4 (beta) features

The good news first: we designed the update so that you can keep using the same profile from earlier versions and the Setup Manager window will look mostly the same on macOS Sequoia and earlier, and have the new “Liquid Glass” look and feel on macOS Tahoe.

To use the new UI options, set the new keys.

Banner

Setup Manager 1.4 introduces the option to show a color or image banner in the top of the Setup Manager window. This is controlled by the top-level banner key. The banner value is an image source, so it can be a reference to local image file, an image file hosted on a web server, or (also new in 1.4) a color designation.

Colors can be set with hex codes, e.g. #f00 or #f900a2 or with (new in 1.4) system color names, e.g. ##gray, ##red, etc.

The size of the banner area is 800x233 pixels (1600x466 @2x) on Sequoia and earlier and 800x247 (1600x494 @2x) on Tahoe (the liquid glass tool bar is taller). The image will be displayed with bottom-center alignment and not scaled, so you can add a few extra pixels at the top and the same image should work for all macOS versions.

The behavior of the icon and title keys changes depending on whether the banner has a value.

When no banner value is set, Setup Manager will show its app icon when an icon key is missing or empty. It will also show ‘Welcome’ or the localized equivalent when the title key is missing or empty.

When the banner is set, an empty or missing title or icon will simply not be shown. This lets you use the banner image for a completely customized experience.

Note that the banner value can be localized.

Action Tile Colors

Setup Manager 1.4 allows you to set a color for the action tiles. Use the top-level tileColor key to set the color for all action tiles. You can also set the tile color for an individual action with a tileColor key in the action.

When no tileColor is set, the default behavior is to use the window background color (gray on Sequoia and earlier, white on Tahoe, or the dark mode equivalent).

You can set the tileColor value (top-level and action level) to a hex color or system color name. There are a few special color names:

• ##automatic: calculates each tile's color from the average color of each action’s icon, icons defined with symbol:… will use the default color
• ##background: system window background (gray on Sequoia and earlier, white on Tahoe)
• ##clear: transparent or no background, works best when hideActionLabels is set to false

See tileColor and ‘Defining Colors’ in the documentation for details.

Profile Installation and Removal Logging

A new tab has been added to logging window which logs the installation and removal of configuration profiles. These events will also be logged to the main Setup Manager log, which allows you to see them in context of the entire workflow.

This can be especially useful to determine whether a particular profile disrupts the network and possibly the download of an important component. In the unified system log, these entries will have the profile category.

Setup Manager 1.3.1

• updates to Polish localization
• improvements to launch process at login window
• logs macOS version at launch
• email addresses and urls in markdown text are not active links any more
• documentation updates and clarifications

Setup Manager 1.3

Notes added since 1.3beta are marked with '(release)'

New Features

• Logging
  • log output format has been cleaned up
  • Install log and Jamf Pro log (when available) can now be viewed in the Log window (#78, #130)
  • now also logs to macOS unified logging
  • new top-level default key to control action output logging
• Network Monitoring
  • changes to network interfaces are now logged, see the Notes section for details (#15)
  • network status can be shown in the top-right corner of the Setup Manager window
• new flag file /private/var/db/.JamfSetupStarted, which is created when Setup Manager starts. You can use this to scope Mac App Store apps and Jamf App Installers, which prevents these apps from installing early in the enrollment, slowing down the Jamf Pro configuration
• added a specific webhook to send a message to Slack (#104)
• two new defaults keys finishedScript and finishedTrigger allow to run custom behavior when Setup Manager has finished
• new option none for finalAction (#115)
• (release) Polish localization (Thanks to @bsojka)

Fixes and Improvements

• Jamf Pro: improved monitoring for Jamf Pro to complete its setup after enrollment
• webhook log entries correctly show status
• added -skipAppUpdates option to list of options for Jamf Pro policy actions, this should avoid some false "error 57" reports
• Jamf Pro policy will trigger 'Recurring Check-in' policies on empty string value
• (release) added name for macOS Tahoe 26
• (release) minor localization and UI fixes
• (release) disabled some undesirable keyboard shortcuts (#125)
• (release) arguments in installomator actions are now processed correctly
• (release) output to log is flushed immediately to avoid truncation on restart/shutdown (#129)
• (release) MDM Server address shown in extended "About this Mac" (#127)

Deprecations and Removals

• (1.3) the minimum macOS requirement for Setup Manager is now macOS 13.5
• (1.2) showBothButtons option removed and non-functional, there will always be just one final action button displayed
• the method for providing localized texts in the configuration profile changed in version 1.1. The previous method (by appending the two letter language code to the key) is considered deprecated. It will continue to work for the time being but will be removed in a future release. It is strongly recommended to change to the new dictionary-based solution

Notes

Logging

The format of the Setup Manager log file (in /Library/Logs/Setup Manager.log) has changed. The new format should be easier to read and parse with other tools. There are four columns:

• timestamp (in ISO8601)
• log level (default, error or fault)
• category (general, install, network, jamfpro)
• message

Setup Manager 1.3 also logs to the macOS unified system log. The subsystem is com.jamf.setupmanager. You can use the log command line tool to read the log.

For example:

sudo log show --last 30m --predicate 'subsystem="com.jamf.setupmanager"'

To clean up the log a little, Setup Manager 1.3 will only write the output of actions to the Setup Manager log file when an error occurred. You can control this behavior with a new top-level preference key actionOutputLogging.

Installation and Jamf Pro logs and summaries

The Log window (open with command-L) gained a new "Install" tab, which shows the system's installation log file (/var/log/install.log). When enrolling with Jamf Pro, there is another new "Jamf" tab, which shows the Jamf log (/var/log/jamf.log). By default, the Log window will be summarized to events relevant to the enrollment workflow. You can see the full log content by unchecking the 'Summarize' option.

Note that both logs will show events that were not initiated by Setup Manager. Nevertheless, these events may be relevant to your enrollment workflow.

These summarized events will also appear in the Setup Manager log tab and file, as well as the universal log entries. Having these events in context at the time they occur in the Setup Manager log is very helpful when trouble-shooting enrollment workflows.

Network change logging

Setup Manager 1.3 adds logging for changes to network interfaces. It is possible that there will multiple entries in the log with regards to the same network change. Most changes logged will be neutral and should not affect your deployment negatively.

However, it is possible that changes to the network configuration of a device can influence the deployment workflow. For example, when a configuration profile with the access information for a secure corporate Wifi is installed on the device, then the download access to required resources might change. Another example are security tools that might lead to restricted access for downloads (Installomator uses curl to download data, which might trigger security tools.)

Checking the log for network changes or outages during enrollment can be useful for troubleshooting.

Network Status icon/menu

Network status can also show with a new icon in the top-right corner of the Setup Manager window.

Note that Network Relay will only protect traffic to certain configured servers and services, not all traffic.

By default, the network icon will not be shown. You can activate it manually with the command-N keystroke.

When you click on the Network status icon, a popup will show:

• the current active network interface
• IPv4 and IPv6 addresses
• download and upload bandwidth (will take a while to appear)
• Network Relay hosts (when network relay profile is present)
• list of additional custom hosts, configured in the profile

Note that the connectivity check is quite basic and might not catch all functionality that is required for a service to work. It should provide an indication whether a service is reachable, but deeper trouble-shooting and monitoring might be required for reliable diagnostics.

Seen"Network Connectivity" for more detail.

Finished Script and Trigger

Setup Manager now includes functionality to launch a script or Jamf Pro custom policy trigger in a separate process when the main Setup Manager process is finished. This is useful for installations that might unexpectedly restart the computer or the context that Setup Manager is running in (most commonly, Setup Manager is running at login window, which the Jamf Connect installer will kill).

There are two keys relevant for this: finishedScript and finishedTrigger.

See "Running Scripts and Policies when Setup Manager finishes" for detail.

Setup Manager v1.3beta

v1.3beta

(2025-05-27)

New Features

• Logging
  • log output format has been cleaned up
  • Install log and Jamf Pro log (when available) can now be viewed in the Log window (#78)
  • now also logs to macOS unified logging
  • new top-level default key to control action output logging
• Network Monitoring
  • changes to network interfaces are now logged, see the Notes section for details (#15)
  • network status can be shown in the top-right corner of the Setup Manager window
• new flag file /private/var/db/.JamfSetupStarted, which is created when Setup Manager starts
• added a specific webhook to send a message to Slack (#104)
• two new defaults keys finishedScript and finishedTrigger allow to run custom behavior when Setup Manager has finished
• new option none for finalAction (#115)

Fixes and Improvements

• Jamf Pro: improved monitoring for Jamf Pro to complete its setup after enrollment
• webhook log entries correctly show status
• added -skipAppUpdates option to list of options for Jamf Pro policy actions
• Jamf Pro policy will trigger 'Recurring Check-in' policies on empty string value

Deprecations and Removals

• (1.3) the minimum macOS requirement for Setup Manager is now macOS 13.5
• (1.2) showBothButtons option removed and non-functional, there will always be just one final action button displayed
• the method for providing localized texts in the configuration profile changed in version 1.1. The previous method (by appending the two letter language code to the key) is considered deprecated. It will continue to work for the time being but will be removed in a future release. It is strongly recommended to change to the new dictionary-based solution

Notes

Logging

The format of the Setup Manager log file (in /Library/Logs/Setup Manager.log) has changed. The new format should be easier to parse with other tools. There are four columns:

• timestamp (in ISO8601)
• log level (default, error or fault)
• category (general, install, network, jamfpro)
• message

Setup Manager 1.3 also logs to the macOS unified system log. The subsystem is com.jamf.setupmanager. You can use the log command line tool to read the log.

For example:

sudo log show --last 30m --predicate 'subsystem="com.jamf.setupmanager"'

To clean up the log a little, Setup Manager 1.3 will only write the output of actions to the Setup Manager log file when an error occurred. You can control this behavior with a new top-level preference key actionOutputLogging.

Network change logging

Setup Manager 1.3 adds logging for changes to network interfaces. it is possible that there will multiple entries in the log with regards to the same network change. Most changes logged will be neutral and should not affect your deployment negatively.

However, it is possible that changes to the network configuration of a device can influence the deployment workflow. For example, when a configuration profile with the access information for a secure corporate Wifi is installed on the device, then the download access to required resources might change. Another example are security that might lead to restricted access for downloads (Installomator uses curl to download data, which might trigger security tools.)

Knowing that network changes or outages occurred during enrollment can be useful for troubleshooting.

Network Status icon/menu

Network status is also shown with a new icon in the top-right corner of the Setup Manager window.

Note that Network Relay will only protect traffic to certain configured servers and services, not all traffic.

By default, the network icon will not be shown. You can activate it manually with the command-N keystroke.

When you click on the Network status icon, a popup will show:

• the current active network interface
• IPv4 and IPv6 addresses
• download and upload bandwidth (will take a while to appear)
• Network Relay hosts (when network relay profile is present)
• list of additional custom hosts, configured in the profile

Note that the connectivity is very basic and might not catch all functionality that is required for a service to work. It should provide an indication whether a service is available, but deeper trouble-shooting and monitoring might be required for reliable diagnostics.

Setup Manager 1.2.2

• signed a helper script that could lead to unexpected background item prompts
• disabled command-W keystroke
• fixed a stall in waitForUserEntry with Jamf School
• fixed link to computer record in Teams message (#110)
• minor documentation fixes

Setup Manager 1.2.1

• updated included Installomator script to v10.8
• now tries for 15 seconds to reload local background image file (#105), this should help in situations where the image file is installed after Setup Manager
• improved monitoring of Jamf Pro enrollment process and completion during the "Getting Ready" phase
• minor documentation fixes (#106)

Setup Manager v1.2

New Features

• Setup Manager can send webhooks on start and finish, (#70)
  • (beta2) added a specific webhook to send a message to Microsoft Teams
• User Entry:
  • email, endUsername, realname, position and phone fields added. These will be submitted to Jamf Pro when Setup Manager finishes and during a waitForUserEntry action
  • you can set custom and localized labels for user entry fields in the profile with a label key
• User Data file now contains a list of enrollmentActions
• added 'restart' option to 'finalAction' (#38, #58)
• icon sources and accentColor can now have a dark mode alternative defined in the profile (#61)
• hitting the space bar while Setup Manager is the Active window will open a window with a scannable barcode of the serial number
• message and help:message now interpret markdown formatting (#46)

Fixes and Improvements

• (beta3 and release) return key connected to final action and save buttons (#93)
• (beta3) added an event field to standard webhook data, (#94)
• (beta3) "facts" in Teams message are no longer in random order
• (beta3) improved reliablity of running at login window (#77)
• (beta2) an empty userEntry dictionary in the profile no longer chokes the UI (#85)
• (beta2) MDM check more resilient to certain profile configs (#87)
• (beta2) the name field in WebHook data was shortened from SetupManagerFinished and SetupManagerStarted to Finished and Started
• (beta2) early log entry when debug mode is enabled
• icon for waitForUserEntry can be changed from the profile
• shell actions correctly show success or failure, depending on their exit code (#39)
• Jamf Pro policy actions show success or failure in most situations. Note that there are many things a policy can potentially do. Not all failures are caught. This registers failed pkg installations and policy scripts that return a non-zero exit code, which should cover most situations. Note also, these checks will only work on macOS 13 and higher. On macOS 12, Jamf policies will always be reported as success.
• read enrollment actions data from profile after user-initiated enrollments more reliably
• now tries for 15 seconds to reload images with local file paths, this should help in situations were the resources file are installed after Setup Manager
• many other fixes and improvements
• updated included Installomator to 10.7
• user data file will contain the enrollment user when the userID key is set
• battery warning threshold is now different for Intel (%50) and Apple silicon (%20) Macs. This matches Apple's warnings before applying software updates

Deprecations and Removals

• the minimum macOS requirement for Setup Manager will be raised to macOS 13 soon
• showBothButtons option removed and non-functional, there will always be just one final action button displayed
• the method for providing localized texts in the configuration profile changed in version 1.1. The previous method (by appending the two letter language code to the key) is considered deprecated. It will continue to work for the time being but will be removed in a future release. It is strongly recommended to change to the new dictionary-based solution.

Beta Features

Even though we are confident that the release is overall stable and ready to be used in production, we believe this feature may require more testing. When, after thorough testing in your environment, you conclude this works for your workflow, please let us know about success or any issues you might encounter.

• Setup Manager can now run over Login Window, instead of immediately after installation. This also allows Setup Manager to work with AutoAdvance. Use the new runAt key in the profile to determine when Setup Manager runs