5 Commits

Author SHA1 Message Date
Armin Briegel
005efccec5 v1.4.6 2026-06-23 08:35:39 +02:00
Armin Briegel
d2cfe7dd36 v1.4.5 2026-03-12 10:02:08 +01:00
Armin Briegel
586e17b526 updated for Setup Manager 1.4.4 2026-02-10 15:53:46 +01:00
Armin Briegel
7d10473cc4 some more clarifications on time spent on 'Getting Ready' 2026-02-05 09:54:52 +01:00
Armin Briegel
a7823b92d3 fixed a wrong default for new key 2026-02-04 17:11:32 +01:00
5 changed files with 55 additions and 10 deletions

View File

@@ -1,5 +1,28 @@
# Setup Manager - Change Log
## 1.4.6
(2026-06-22)
- fixed a potential crashing issue in log parsing (#217, #219)
- webhook urls are now abreviated in the log, unless the `DEBUG` key _in_ the `webhooks` dictionary is set to `true`
## 1.4.5
(2026-03-12)
- removed redundant recon when setting computer name (#201)
- shortened some wait times in "Getting Ready…" for Jamf Pro deployments
- fixed a crash which might occure when opening the log window twice (#197, #204)
- log entry when battery is below warning threshold
## 1.4.4
(2026-02-10)
- fixed a bug that could prevent the final recon from finishing (#196)
- added horizontal padding to starting and finished messages
## 1.4.3
(2026-02-04)

View File

@@ -437,7 +437,7 @@ Example:
#### `startingMessage`
(String, optional, localized, substitutions, markdown, v1.4.3, default: "Getting Started…")
(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
@@ -448,6 +448,8 @@ Example:
<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:
@@ -1235,7 +1237,15 @@ 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/).
If you want to insert a line break, you need to insert two line breaks into the markdown text.
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.

View File

@@ -57,7 +57,7 @@ Setup Manager logs to `/Library/Logs/Setup Manager.log`. There are four columns:
- timestamp (in ISO8601)
- log level (default, error or fault)
- category (general, install, network, profile, jamfpro)
- category (general, install, network, profile, jamfpro, battery)
- message
To clean up the main log a little, Setup Manager 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`.

View File

@@ -48,19 +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 in Jamf Pro. 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.
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.
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).
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.
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).
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 critical 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?

View File

@@ -163,4 +163,10 @@ You can send multiple services per event:
### Webhooks in Debug mode
Webhooks are generally _not_ sent when DEBUG is set to true. However, if you set a `DEBUG` key to `true` _inside_ the webhooks dictionary to true, webhooks will be sent, even when global DEBUG is enabled.
Webhooks are generally _not_ sent when `DEBUG` is set to true. However, if you set a `DEBUG` key to `true` _inside_ the `webhooks` dictionary, webhooks will be sent, even when global `DEBUG` is enabled.
### Logging
Since the webhook URLs may contain codes you don't necessarily want to share, only the url scheme, host, and port are printed in the log, unless the `DEBUG` key inside the `webhooks` dictionary is set to `true`.
Note that the full URL for the webhook will always be visible in the profile, which will be visible to every user on the device in System Settings or with other tools. If you want to prevent the user seeing the webhook urls, you need to remove the Setup Manager profile after enrollment (using smart group scoping) or use a middleware server to indirectly talk with the webhook service.