mirror of
https://github.com/jamf/Setup-Manager.git
synced 2026-02-05 15:02:14 +00:00
Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7d10473cc4 | ||
|
|
a7823b92d3 | ||
|
|
531d170abb |
24
ChangeLog.md
24
ChangeLog.md
@@ -1,5 +1,29 @@
|
||||
# Setup Manager - Change Log
|
||||
|
||||
## 1.4.3
|
||||
|
||||
(2026-02-04)
|
||||
|
||||
- fixed a bug where `finalCountdown` could not be disabled (#192)
|
||||
- added a key to override the "Getting Ready…" message (#191)
|
||||
- battery popup is nicer and localized
|
||||
- added `uploadThroughput` and `downloadThroughput` to the webhook event data
|
||||
- fixed quoting in preinstall script
|
||||
- Polish localization updates
|
||||
- minor UI and localization fixes
|
||||
|
||||
## 1.4.2
|
||||
|
||||
(2026-01-20)
|
||||
|
||||
- Turkish localization 🇹🇷 (thanks to @nurox999)
|
||||
- Portuguese (Brazil) localization 🇧🇷 (thanks to Eric M)
|
||||
- Export Logs button in log window which copies relevant log files to a new folder in `/Users/Shared/`
|
||||
- fixed an issue where the finishing webhook was sent twice (#188)
|
||||
- newlines are no longer stripped out of `message` and `help.message` values in the profile
|
||||
- minor documentation fixes and updates
|
||||
|
||||
|
||||
## 1.4.1
|
||||
|
||||
(2025-12-22)
|
||||
|
||||
@@ -205,6 +205,8 @@ Disable the countdown:
|
||||
<integer>-1</integer>
|
||||
```
|
||||
|
||||
**Note** the `integer` tag. When you accidentally set the type to `string` its value will not be interpreted correctly.
|
||||
|
||||
#### `finalAction`
|
||||
|
||||
(String, optional, default: `continue`)
|
||||
@@ -433,6 +435,21 @@ Example:
|
||||
<string>**Finished** – _Enjoy your %model%!_</string>
|
||||
```
|
||||
|
||||
#### `startingMessage`
|
||||
|
||||
(String, optional, localized, substitutions, markdown, v1.4.3, default: "Getting Ready…")
|
||||
|
||||
Custom message shown while Setup Manager is "Getting Ready…", i.e. waiting for the Jamf framework to be installed
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<key>startingMessage</key>
|
||||
<string>Waiting for management framework installation. Please remain patient!</string>
|
||||
```
|
||||
|
||||
**Note:** if the "Getting Ready…" phase in your enrollment is taking significantly more than 1-3 minutes (on a decent network connection) then there are issues in your enrollment workflow that [can almost certainly be improved](Docs/FAQ.md#jamf-pro-getting-ready-is-taking-very-long-several-minutes-what-is-happening-and-can-i-do-something-to-make-it-faster).
|
||||
|
||||
## Actions
|
||||
|
||||
All actions should have these keys:
|
||||
@@ -1220,12 +1237,24 @@ In some fields, markdown formatting can be used to generate rich, formatted text
|
||||
|
||||
The `Please be patient.` text will be shown bolded. You can find details on markdown formatting in the [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/).
|
||||
|
||||
Note that while you _can_ embed links to websites in the markdown using the `[…](…)` syntax they will not work while running over Setup Assistant or Login Window.
|
||||
If you want to insert a line break, you need to insert two line breaks into the markdown text. Note also, that property lists don't understand \n as an escape character, so you have to insert two actual line breaks.
|
||||
|
||||
```xml
|
||||
<key>startingMessage</key>
|
||||
<string>Waiting for things to get ready.
|
||||
|
||||
**This may a moment!** Please remain patient.</string>
|
||||
```
|
||||
|
||||
|
||||
Note that while you _can_ embed links to websites in the markdown using the `[…](…)` syntax they will not work.
|
||||
|
||||
These keys can use markdown:
|
||||
|
||||
- `message`
|
||||
- Help: `message`
|
||||
- `finishedMessage`
|
||||
- `startingMessage`
|
||||
|
||||
## Defining Colors
|
||||
|
||||
|
||||
17
Docs/FAQ.md
17
Docs/FAQ.md
@@ -48,16 +48,25 @@ You can open the log window (command-L) or review the [log file](Extras.md#loggi
|
||||
|
||||
## (Jamf Pro) Getting Ready is taking very long (several minutes). What is happening and can I do something to make it faster?
|
||||
|
||||
The "Getting Ready" phase prepares some steps and waits for all essential Jamf Pro components (the jamf binary, certificates, Jamf.app, etc.) to be installed and configured before starting with the actual enrollment workflow. Depending on the network connection this might take a while.
|
||||
The "Getting Ready" phase prepares some steps and waits for all essential Jamf Pro fraemwork components (the jamf binary, certificates, Jamf apps, etc.) to be installed and configured before starting with the actual enrollment workflow. Depending on the network connection this can take a while, but there are several steps you can take to order your enrollment workflow to avoid conflicts and timeouts which should speed things up.
|
||||
|
||||
Note that you can see the individual steps and the timing for each step in the [Setup Manager log file](Extras.md#logging)].
|
||||
You can see the individual steps and how much time is spent on each step in the [Setup Manager log](Extras.md#logging)].
|
||||
|
||||
Once Jamf Pro's enrollment workflow is complete, Setup Manager runs a full update inventory/recon. In general, if the recon takes a long time, you should review the inventory collection settings. Calculating home directory sizes and gathering fonts can take a lot of time and CPU power, and speed up things significantly when turned off, not just during enrollment with Setup Manager. You should also review extension attributes, for how long each one runs.
|
||||
If the "Getting Ready…" phase in your enrollment is taking significantly more than 1-3 minutes (on a decent network connection) then there are issues in your enrollment workflow that can almost certainly be improved.
|
||||
|
||||
Mac App Store/VPP and Jamf App Installer apps that are scoped to the computer will also begin installing _immediately_ after enrollment. Since macOS will only perform one installation at a time, these might delay the installation of essential Jamf Pro components. You can create smart groups to defer these installations.
|
||||
Mac App Store/VPP and Jamf App Installer apps that are scoped to the computer will begin installing _immediately_ after enrollment. Since macOS will only perform one installation at a time, these might delay the installation of essential Jamf Pro components. You can create [smart groups to defer these installations](https://github.com/jamf/Setup-Manager/blob/main/Docs/Extras.md#jamf-pro-useful-smart-groups).
|
||||
|
||||
Verify that no policies are being triggered by `enrollmentComplete` when using Setup Manager. This can lead to policies running in parallel, which, at best, will lead to delays, but at worst can lead to unexpected bahavior or deadlocks.
|
||||
|
||||
With Setup Manager 1.3 and higher, you can check whether apps are getting installed before Setup Manager starts the actions in the Setup Manager log.
|
||||
|
||||
Any configuration profiles that affect network settings can lead to a brief drop of the network connection which can slow down or completely interrupt the download and configuration of the Jamf Pro framework. The Setup Manager (1.3 and later) log will show changes to network or outages. When you see those in connection with long delays, you should look for profiles that are installed before that might affect the network. Setup Manager 1.4 and higher log will show profile installations and removals. Profiles that affect Wifi, firewall, VPN settings or the installation of security tools that affect or change network access are ciritical here and should be deferred to [be installed at a later stage with scoping](https://github.com/jamf/Setup-Manager/blob/main/Docs/Extras.md#jamf-pro-useful-smart-groups).
|
||||
|
||||
Once Jamf Pro's enrollment workflow is complete, Setup Manager runs a full update inventory/recon. In general, if the recon takes a long time, you should review the [inventory collection settings in Jamf Pro](https://learn.jamf.com/en-US/bundle/jamf-pro-documentation-11.24.0/page/Computer_Inventory_Collection_Settings.html). Calculating home directory sizes and gathering fonts can take a lot of time and CPU power, and speed up things significantly when turned off, not just during enrollment with Setup Manager. You should also review extension attributes, for how long each one runs.
|
||||
|
||||
Gathering software update information in inventory collection may lead to long recon times or even stalls. Since recent versions of macOS use DDM status channels for both reporting of the current macOS version and the status of software updates, you do not generally require this information in the inventory collection.
|
||||
|
||||
If the time for the recon remains in the minutes after reviewing the settings, you should review the custom extension attributes in your Jamf Pro. Dan Snelson has an helpful [blog post](https://snelson.us/2025/10/jnuc-2025-jamf-pro-performance-tuning-extension-attribute-audit/) and [recorded JNUC session (YouTube)](https://www.youtube.com/watch?v=o1V4kCEUJUs) on this topic.
|
||||
|
||||
## Can I set the wallpaper/desktop picture or dock with Setup Manager?
|
||||
|
||||
|
||||
19
Docs/JamfPro-UIE.md
Normal file
19
Docs/JamfPro-UIE.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Running Setup Manager at User Initiated Enrollment
|
||||
|
||||
While we strongly recommend to use Automated Device Enrollment where possible, we understand there are many situations where manual enrollment is still required. Setup Manager works fine after profile based device enrollment (also called User-initiated enrollment or UIE), but there are few things to consider.
|
||||
|
||||
## Installation at User Initiated Enrollment
|
||||
|
||||
Since Prestage enrollment packages are only installed during Automated Device Enrollment, you need to create a policy which installs the Setup Manager pkg and attach that to the `enrollmentComplete` trigger.
|
||||
|
||||
Create the Setup Manager profile and make sure it is scoped in a way that it will reach the device immediataly at enrollment. For example, you can create a smart group on the criterium `Enrolled via Automated Device Enrollment` `is` `No` to gather all Macs _not_ enrolled with ADE.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
With UIE, there _will_ be an unvoidable short delay between the enrollment and when Setup Manager launches. If the pause is very long, you will need to analyse jamf.log and install.log to see where the time is spent. Setup Manager logs will show some events that occur even before Setup Manager is installed and launches, but the time information might be lost or not represented. Use the suggestions here for reducing the time to launch.
|
||||
|
||||
## Workflow and Profile
|
||||
|
||||
Once Setup Manager launches it will work through the actions in the profile same as with Automated Device Enrollment. We recommend setting a `background` to block access to other apps while Setup Manager is running. If you don't have a custom background/wallpaper image, you can set `background` to `/System/Library/CoreServices/DefaultDesktop.heic` to use the default wallpaper.
|
||||
|
||||
Even though Setup Manager works basically the same, there are enough differences between the environment after User Initiated Enrollment, where the system is already set up, the user account already exists, and the user may have already done installations and configuration that you should revisit your enrollment workflow actions in Setup Manager and consider them in this context. You will likely use a modified workflow and Setup Manager workflow for manual enrollment.
|
||||
@@ -72,6 +72,8 @@ The data for the `finished` webhook includes the same as above, with some additi
|
||||
"duration": 53, // integer
|
||||
"finished": "2025-01-14T15:12:20Z", // time Setup Manager finished, date as string, iso8601
|
||||
"computerName": "Mac-123456" // computer name, only when set through Setup Manager
|
||||
"downloadThroughput": 698497408 // integer, when it could be measured
|
||||
"uploadThroughput": 67450904 // integer, when it could be measured
|
||||
"userEntry": { // data entered by the user
|
||||
"department": "IT",
|
||||
"computerName": "IT-ABC123",
|
||||
|
||||
@@ -44,7 +44,7 @@ Setup Manager provides:
|
||||
|
||||
- Jamf Pro
|
||||
- [JamfPro-Quick Start](Docs/JamfPro-QuickStart.md)
|
||||
- zero-touch and user-initiated deployments (forthcoming)
|
||||
- [Manual User-initiated deployments](Docs/JamfPro-UIE.md)
|
||||
- [extra installations based on user data entry](Docs/JamfPro-TwoPhase.md)
|
||||
- [Single-touch workflow with user re-assignment using Jamf Connect](Docs/JamfProConnect-SingleTouch.md)
|
||||
- [handsfree deployment with AutoAdvance and Setup Manager at login window](Docs/JamfPro-LoginWindow.md)
|
||||
@@ -72,4 +72,4 @@ Setup Manager requires macOS 13.5 or higher. It will work only with Jamf Pro or
|
||||
|
||||
---
|
||||
|
||||
Please report issues, feature requests, and feedback (positive and negative) [as an issue.](https://github.com/jamf/Setup-Manager/issues)
|
||||
Please report issues, feature requests, and feedback [as an issue.](https://github.com/jamf/Setup-Manager/issues)
|
||||
|
||||
Reference in New Issue
Block a user