jamf/Setup-Manager
1
0
Fork 0
mirror of https://github.com/jamf/Setup-Manager.git synced 2026-02-03 14:13:24 +00:00
Code Issues 37 Actions Packages Projects Releases Wiki Activity

updated for 1.4beta

Browse Source
This commit is contained in:
Armin Briegel
2025-10-28 15:25:13 +01:00
parent 741bcb47e7
commit 09016086f7
8 changed files with 387 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
Docs/Extras.md
View File

@@ -5,15 +5,15 @@
Note that the Setup Manager window does not activate to receive keystrokes automatically when running over Setup Manager. You have to click in the Setup Manager window first.
| Shortcut | Action |
| --- | --- |
| Shortcut | Action |
| ----------------------- | ------ |
| shift-control-command E | ["exit"/quit Setup Manager](#Quit), use only in emergencies as it will leave installations in an indeterminate state |
| command-L | open [Log window](#Logging) |
| command-B | toggle Battery status icon in Setup Manager window |
| command-N | toggle [Network status icon](Network.md) in Setup Manager window |
| space | show [serial number bar code window](#scannable-serial-number-barcode) |
| i | show "About this Mac" popup |
| h | show "Help" popup, when present |
| command-L | open [Log window](#Logging) |
| command-B | toggle Battery status icon in Setup Manager window |
| command-N | toggle [Network status icon](Network.md) in Setup Manager window |
| space | show [serial number bar code window](#scannable-serial-number-barcode) |
| i | show "About this Mac" popup |
| h | show "Help" popup, when present |
| hold option key when clicking "About this Mac" | shows more info |
## Custom JSON Schema for Jamf Pro
@@ -41,17 +41,17 @@ The command-Q keyboard shortcut to quit the app is disabled. Use `shift-control-
While Setup Manager is running you can open a log window with command-L.
There are two or three tabs, one for the main Setup Manager log, one showing output from `/var/log/install.log` and (Jamf Pro only) one tab showing output from `/var/log/jamf.log`. By default, these log tabs will be summarized to events relevant to the enrollment workflow. You can see the full log content by unchecking the 'Summarize' option.
There are two or three tabs, one for the main Setup Manager log, one showing output from `/var/log/install.log`, one showing configuration profile installation and removal, and (Jamf Pro only) one tab showing output from `/var/log/jamf.log`. Some log tabs 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.
Note that the extra logs (Install, Profiles, and Jamf) show events that were not initiated by Setup Manager. Nevertheless, these events can be relevant to your enrollment workflow.
These summarized events will also appear in the Setup Manager log tab and log 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.
These extra events will also appear in the Setup Manager log tab and log 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.
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, jamfpro)
- category (general, install, network, profile, jamfpro)
- 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`.
@@ -185,3 +185,9 @@ The finished script or custom trigger are configured in the Setup Manager config
The SetupManagerFinished daemon logs its output (and the output of the policy and scripts to `/private/var/log/setupManagerFinished.log`.
## macOS Version support
| Setup Manager | Minimum macOS | Platforms |
|---------------|---------------|-------------------------|
| up to 1.2.2 | 12.0 | Intel and Apple silicon |
| 1.3 and later | 13.5 | Intel and Apple silicon |

14
Docs/FAQ.md
View File

@@ -12,10 +12,14 @@ Yes, use the top-level `background` key and point it to a local image file or a
There can be many causes for this. A few common causes are:
- you need at least one of the 'Setup Assistant Options' in the prestage to be set to _not_ skip. Location Services is a good choice that you generally want to leave up the user anyway. Otherwise, Setup Assistant may quit before Setup Manager can launch and do its actions.
- when running at 'enrollment,' you need at least one of the 'Setup Assistant Options' in the Prestage to be set to _not_ skip. 'Location Services' or 'Terms & Conditions' are a good choice that you generally want to leave up the user anyway. Otherwise, Setup Assistant may quit before Setup Manager can launch and do its actions.
- when using a distribution point other than Jamf Cloud Distribution Point, you need [to provide a manifest](https://appleshare.it/posts/use-manifest-file/)
- Jamf Pro:
- check that Setup Manager is added to your prestage and the package does not have the label "Availability pending" in Settings> Packages
- in Prestage > Enrollment Packages verify that the Distribution Point is set correctly (it resets to "none" when you remove the last enrollment package)
- check that Setup Manager is added to your Prestage and the package does not have the label "Availability pending" in Settings> Packages
- in Prestage > Enrollment Packages verify that the Distribution Point is set correctly (it resets to "none" when you remove the last enrollment package, so this is easy to miss)
- you can try deleting the Setup Manager pkg from Packages and re-uploading it
- verify that the pkg is not installed during Prestage by checking for the presence of `Setup Manager.app` in `/Applications/Utilities`, if the app does not exist, the Prestage is not installing Setup Manager
- when the above steps do not remedy the issue, please engage Jamf Support.
## Does Setup Manager require Jamf Connect
@@ -62,10 +66,10 @@ What you can do is run a script at login which sets the desktop (using [desktopp
There are several options:
- custom launch agent
- [outset](https://github.com/macadmins/outset/)
- Jamf Pro: [Self Service macOS Onboarding](https://learn.jamf.com/en-US/bundle/jamf-pro-documentation-current/page/macOS_Onboarding.html)
- Jamf Pro: [policy with a login trigger](https://learn.jamf.com/en-US/bundle/jamf-pro-documentation-current/page/Login_Events.html)
- custom launch agent
- [outset](https://github.com/macadmins/outset/)
## Can Setup Manager run at first login, rather than right after enrollment?

2
Docs/JamfPro-LoginWindow.md
View File

@@ -1,7 +1,5 @@
# Jamf Pro: Run Setup Manager at Login Window
**Beta** _We believe the run at login window feature may require more testing, especially in some edge cases. When, after thorough testing, you believe this works in your workflow, feel free to deploy it, and please let us know about success or any issues you might encounter._
By default, Setup Manager launches as soon as the installation completes. You can defer launching Setup Manager to launch when the macOS Login Window appears, instead.
When the `runAt` key in the profile is set to `loginwindow`, Setup Manager will not launch immediately after installation but when Login Window appears. In combination with the 'AutoAdvance' feature for automated device enrollment, this allows for completely 'hands-off' enrollment and configuration workflows.

27
Docs/LaunchTracking.md Normal file
View File

@@ -0,0 +1,27 @@
# Launch and Completion Tracking in Setup Manager
Setup Manager sends tracking signals to a service we use to gather usage data. Currently (since 1.4) the service is [TelemetryDeck](https://telemetrydeck.com/). Older versions use [pendo.io](https://pendo.io).
In the ping, some data is transferred to the service, and the time and date of the signal are recorded.
This is the data in the signal:
- macOS system version and build
- Setup Manager version
- Device management service: Jamf Pro or Jamf School
- A hash of the device management server url. This allows us to see how many devices are enrolled with a particular device management server, but we _cannot_ identify _which_ particular customer or server it is
Setup Manager version 1.4 adds the following info to the signal.
- Device information (model identifier, architecture)
- Language and Region settings, preferred and actual
- Color scheme choice: dark or light mode
- Duration of the Setup Manager workflow
- Running after enrollment, at login window, or over user space
- Fatal errors (Setup Manager giving up completely, individual errors in actions are **not** tracked)
No signals are sent when `DEBUG` is set to `true`. The signal is sent to `nom.telemetrydeck.com`.
We use this data to determine the usage of Setup Manager and where to focus future development, so we appreciate when you let us gather this data.
You can suppress the tracking signal by setting the `PLEASE_DO_NOT_TRACK' boolean key to `true` in the configuration profile.