Skip to content

Jamf-Concepts/Setup-Manager

Repository files navigation

Setup Manager Icon

Setup Manager

"Every Assistant has a Manager"

Setup Manager Logo

Please report issues, feature requests as an issue.

We have opened the discussions area for questions and more generic feedback.

Updates will be published in the 'Releases' section of the repo. There you can also download the latest pkg installer. You can subscribe to notifications for the repo using the 'Watch' button above.

What it does

There are many enrollment progress tools available for Mac admins, each with their own strengths. Jamf Setup Manager approaches the problem from the perspective of an IT service provider.

Setup Manager offers many of the same features of these utilities but is especially useful for the case where an IT department or provisioning depot wants to ensure that a new Mac is properly configured and assigned before sending the device to its new user. It runs over Setup Assistant before a user is created so it won't interfere with MDM-capable user or the secure token flow for FileVault. You can control which policies and installations Setup Manager runs with a configuration profile.

Setup Manager provides:

  • a nice modern UI
  • configuration with a configuration profile, no need to modify shell scripts or json
  • works with different deployment workflows
    • zero-touch (user-driven)
    • single-touch (tech-driven)
    • user initiated enrollment
  • customized branding
  • localized interface and custom text
  • support for Jamf Pro and Jamf School

setup manager progress dialog

Installation and Configuration

Jamf Pro

  1. Upload the Setup Manager installer pkg file to Jamf Pro
  2. Create a custom configuration profile with the preference domain com.jamf.setupmanager. See documentation for the profile contents here.
  3. Scope the configuration profile to the computers
  4. Add the pkg and the configuration profile to the Prestage

Setup Manager can be used for various zero-touch and tech-driven single-touch deployments with Jamf Pro and (optionally) Jamf Connect. One single-touch workflow with Jamf Connect where the tech can re-assign the Mac to a different end user is described here.

Jamf School

Setup with Jamf School

Configuration Profile

The structure of the configuration profile is documented here.

Notes

Requirements

Setup Manager requires macOS 12.0.0 or higher. It will work only with Jamf Pro or Jamf School.

Known Issues

  • Setup Manager will not launch with Auto-Advance enabled
  • Setup Manager may not launch or launch and quit quickly when you disable all Setup Assistant screens
  • Policies that are triggered by enrollmentComplete may disrupt Setup Manager running from Prestage/Automated Device Enrollment. To avoid this, disable or unscope policies triggered by enrollmentComplete on devices using Setup Manager.
  • In some deployments, Setup Manager attempts to start while Jamf is still installing. Try adding a 30-60 second wait action as the first action. We are working on a solution.
  • SVG and PDF files don't work with download URLs. workaround: convert files to PNG or use local SVG or PDf files instead.
  • With Jamf School, there will a few seconds after the remote management dialog where Setup Assistant shows before Setup Manager launches. With the Jamf School enrollment architecture, this is unavoidable.

Quit

The command-Q keyboard short cut to quit the app is disabled. You can use shift-control-command-E instead. This should only be used when debugging as it may leave the client in an undetermined state when installations are aborted.

Logging

Setup Manager logs to /Library/Logs/Setup Manager.log.

While it is running you can open a log window with command-L.

Flag file

Setup Manager creates a flag file at /private/var/db/.JamfSetupEnrollmentDone when it finishes. If this file exists when Setup Manager launches, the app will terminate immediately and without taking any action. You can use this flag file in an extension attribute in Jamf to determine whether the enrollment steps were performed. (Setup Manager does not care if the actions were performed successfully.)

When DEBUG is set to YES in the defaults/configuration profile, the flag file is ignored at launch, but still created when done.

Final action and shutdown

When the app is not running as root (for testing or from Xcode) or when the DEBUG preference is set, shutdown will merely quit.

"About This Mac…" window

When you hold the option key when clicking on "About This Mac…" you will see more information.


Please report issues, feature requests, and feedback (positive and negative) as an issue.