mirror of
https://github.com/jamf/Setup-Manager.git
synced 2026-02-03 22:23:23 +00:00
Compare commits
32 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
09016086f7 | ||
|
|
741bcb47e7 | ||
|
|
cc3e7cbfc6 | ||
|
|
c26f42bda7 | ||
|
|
7720d56ea7 | ||
|
|
fb4d6c84e0 | ||
|
|
d647234e37 | ||
|
|
dd25148186 | ||
|
|
552f8e7fc1 | ||
|
|
290c68cfe2 | ||
|
|
44f4c4513c | ||
|
|
29489d9b6f | ||
|
|
9368026e74 | ||
|
|
3f6198a30f | ||
|
|
9ea8e84f6b | ||
|
|
407d7f32dc | ||
|
|
89d9033c15 | ||
|
|
996058a776 | ||
|
|
2f3bdaa93d | ||
|
|
d9ec69df04 | ||
|
|
0eb0916a2f | ||
|
|
c5d5798f4e | ||
|
|
97f11bab6b | ||
|
|
675469b197 | ||
|
|
d3cec3276e | ||
|
|
6645a7a926 | ||
|
|
d1d7b1f569 | ||
|
|
960c06c5a5 | ||
|
|
c2fcc38faf | ||
|
|
d71f2ca6f1 | ||
|
|
8623f85487 | ||
|
|
e3d908747a |
361
ChangeLog.md
361
ChangeLog.md
@@ -1,5 +1,366 @@
|
||||
# Setup Manager - Change Log
|
||||
|
||||
## v1.4beta
|
||||
(2025-10-28)
|
||||
|
||||
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](ConfigurationProfile.md#banner))
|
||||
- `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'](ConfigurationProfile.md#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](Docs/LaunchTracking.md) 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](ConfigurationProfile.md#localization)
|
||||
|
||||
### 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](ConfigurationProfile.md) 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](ConfigurationProfile.md#banner). The `banner` value is an [image source](ConfigurationProfile.md#icon-sources), 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](ConfigurationProfile.md#defining-colors).
|
||||
|
||||
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](ConfigurationProfile.md#tilecolor) 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](ConfigurationProfile.md#tilecolor-1).
|
||||
|
||||
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](ConfigurationProfile.md#defining-colors). 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`](ConfigurationProfile.md#tilecolor-1) and [‘Defining Colors’](ConfigurationProfile.md#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.
|
||||
|
||||
|
||||
|
||||
## 1.3.1
|
||||
(2025-07-17)
|
||||
|
||||
- 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
|
||||
|
||||
## 1.3
|
||||
(2025-07-08)
|
||||
|
||||
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](Docs/Webhooks.md#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](ConfigurationProfile.md#localization)
|
||||
|
||||
### 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"](Docs/Network.md) 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"](Docs/Extras.md#running-scripts-and-policies-when-setup-manager-finishes) for detail.
|
||||
|
||||
## 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](Docs/WebHooks.md#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](ConfigurationProfile.md#localization)
|
||||
|
||||
## v1.2.2
|
||||
(2025-04-17)
|
||||
- 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
|
||||
|
||||
## v1.2.1
|
||||
(2025-04-02)
|
||||
|
||||
- updated included Installomator script to [v10.8](https://github.com/Installomator/Installomator/releases/tag/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)
|
||||
|
||||
|
||||
## v1.2.2
|
||||
(2025-04-17)
|
||||
- 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
|
||||
|
||||
## v1.2.1
|
||||
(2025-04-02)
|
||||
|
||||
- updated included Installomator script to [v10.8](https://github.com/Installomator/Installomator/releases/tag/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)
|
||||
|
||||
|
||||
v1.2
|
||||
(2025-03-17)
|
||||
|
||||
### New Features
|
||||
- Setup Manager can send [webhooks](Docs/Webhooks.md) on start and finish, (#70)
|
||||
- (beta2) added [a specific webhook to send a message to Microsoft Teams](Docs/WebHooks.md#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](Docs/Extras.md#user-data-file) now contains a list of enrollmentActions
|
||||
- added 'restart' option to ['finalAction'](ConfigurationProfile.md#finalAction) (#38, #58)
|
||||
- [icon sources](ConfigurationProfile.md#icon-source) and [`accentColor`](ConfigurationProfile.md#accentColor) can now have [a dark mode alternative defined in the profile](ConfigurationProfile.md#dark-mode) (#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](ConfigurationProfile.md#markdown) (#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](ConfigurationProfile.md#localization).
|
||||
|
||||
### 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](ConfigurationProfile.md#runAt) in the profile to determine when Setup Manager runs
|
||||
|
||||
|
||||
## v1.1.1
|
||||
(2025-01-28)
|
||||
|
||||
- updated included Installomator script to [v10.7](https://github.com/Installomator/Installomator/releases/tag/v10.7)
|
||||
|
||||
## v1.1
|
||||
(2024-10-23)
|
||||
### New Features
|
||||
|
||||
- new action [`waitForUserEntry`](ConfigurationProfile.md#wait-for-user-entry) which allows for two-phase installation workflows in Jamf Pro. When Setup Manager reaches this action it will wait for the user entry to save the data entry, then it will run a recon/Update Inventory. Policy actions that follow this, can then be scoped to data from the user entry. (Jamf-Concepts/Setup-Manager#11)
|
||||
- data from user entry is now written to a file when Setup Manager submits data. See details in [User Entry](Docs/Extras.md#user-data-file) (Jamf-Concepts/Setup-Manager#9)
|
||||
- use token substitution in the `title`, `message`, and action `label` values (as well as `computerNameTemplate`)
|
||||
- token substitution can extract center characters with `:=n`
|
||||
- localization of custom text in the configuration profile has been simplified. The previous method still works, but is considered deprecated. [Details in the documentation](ConfigurationProfile.md#localization). The [plist and profile example files](Examples) have been updated.
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
1.1beta:
|
||||
|
||||
- icons using `symbol:` that end in `.app` now work properly
|
||||
- Elapsed time is shown in "About this Mac…" Start time is shown with option key.
|
||||
- svg and pdf images used for `icon`s should now work
|
||||
- general fixes in user entry setup
|
||||
- improved rendering in Help View (Jamf-Concepts/Setup-Manager#12)
|
||||
- fixes to json schema
|
||||
- improved and updated documentation
|
||||
- included Installomator script updated to [v10.6](https://github.com/Installomator/Installomator/releases/v10.6)
|
||||
- added Setup Manager version and macOS version and build to tracking ping
|
||||
- fixed UI glitch in macOS Sequoia
|
||||
|
||||
1.1 release:
|
||||
|
||||
- documentation updates and fixes (Jamf-Concepts/Setup-Manager#35, Jamf-Concepts/Setup-Manager#44, Jamf-Concepts/Setup-Manager#48, Jamf-Concepts/Setup-Manager#51)
|
||||
- custom `accentColor` now works correctly with SF Symbol icons (Jamf-Concepts/Setup-Manager#41)
|
||||
- setting a `placeholder` no longer overrides a `default` in `userEntry` (Jamf-Concepts/Setup-Manager#43)
|
||||
- more UI updates
|
||||
- Hebrew localization
|
||||
|
||||
### Beta features
|
||||
|
||||
Even though we are confident that the 1.1 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](ConfigurationProfile.md#runAt) in the profile to determine when Setup Manager runs (Jamf-Concepts/Setup-Manager#18)
|
||||
|
||||
### Deprecations
|
||||
|
||||
These features are marked for removal in a future release:
|
||||
|
||||
- localized labels and text by adding the two-letter language code to key. Switch to [localization with dictionaries](ConfigurationProfile.md#localization).
|
||||
- `showBothButtons` key and functionality
|
||||
|
||||
|
||||
## v1.1beta
|
||||
(2024-09-09)
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
133
Docs/Extras.md
133
Docs/Extras.md
@@ -1,5 +1,21 @@
|
||||
# Extras and Notes
|
||||
|
||||
|
||||
## Keyboard Shortcuts
|
||||
|
||||
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 |
|
||||
| ----------------------- | ------ |
|
||||
| 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 |
|
||||
| hold option key when clicking "About this Mac" | shows more info |
|
||||
|
||||
## Custom JSON Schema for Jamf Pro
|
||||
|
||||
- create a new profile
|
||||
@@ -11,25 +27,59 @@
|
||||
- for the ‘Variant’, select ‘Setup Manager.json’
|
||||
- fill in your fields!
|
||||
|
||||
The custom schema does not contain all keys and options available in the [configuration profile](../ConfigurationProfile.md). Specifically, the `wait` action and the option to [localize values](../ConfigurationProfile.md#localization) are not available.
|
||||
|
||||
When you reach the limits of the custom schema, use the XML it generates as a starting to building a custom XML.
|
||||
|
||||
Note that the custom schema can become confused when you switch between enrollment action types and you will need to clean up extra empty fields.
|
||||
|
||||
## 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.
|
||||
The command-Q keyboard shortcut to quit the app is disabled. Use `shift-control-command-E` instead. This should only be used when debugging and troubleshooting, as it will leave the client in an undetermined state when installations are aborted.
|
||||
|
||||
## Logging
|
||||
|
||||
Setup Manager logs to `/Library/Logs/Setup Manager.log`. While Setup Manager is running you can open a log window with command-L.
|
||||
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`, 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 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 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, 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`.
|
||||
|
||||
Setup Manager 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"'
|
||||
```
|
||||
|
||||
## Debug mode
|
||||
|
||||
When you set the `DEBUG` key to `true` in the profile or locally with the `defaults` command Setup Manager will not perform any tasks that actually perform installations or otherwise change the system.
|
||||
When you set the `DEBUG` key to `true` in the profile or locally with the `defaults` command Setup Manager will not perform any tasks that actually perform installations or otherwise change the system. When in DEBUG mode, Setup Manager will also read settings from the local settings (i.e. `~/Library/Preferences/com.jamf.setupmanager.plist`) which simplifies iterating through different settings. If you want to run Setup Manager on an unmanaged Mac, you may need to provide a `simulateMDM` key with a value of either `Jamf Pro` or `Jamf School`.
|
||||
|
||||
You may also need to remember to remove the [flag file](#flag-file) before launching Setup Manager.
|
||||
|
||||
You will also be able launch the app as the user, by double-clicking the app in `/Applications/Utilities`. This is useful to test the look and feel of your custom icons, text and localization. When you use this to create screen shots for documentation, also note the `overrideSerialNumber` and `hideDebugLabel` keys.
|
||||
|
||||
|
||||
For testing, you can also re-launch Setup Manager from the command line as root with `sudo "/Applications/Utilities/Setup Manager.app/Contents/MacOS/Setup Manager"`
|
||||
|
||||
## 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.)
|
||||
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 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 `true` in the defaults/configuration profile, the flag file is ignored at launch, but may still be created when done.
|
||||
|
||||
@@ -62,19 +112,82 @@ computerName: MacBook-M7WGMK
|
||||
submit: 2024-08-14T13:54:37Z
|
||||
duration: 101
|
||||
```
|
||||
Start time (`start`) and finish/submission time (`submit`) are given in ISO8601 format, universal time (UTC). Duration is given in seconds.
|
||||
|
||||
Start time (`start`) and finish/submission time (`submit`) are given in ISO8601 format, universal time (UTC).
|
||||
Fields that were not set in user entry will not be shown at all. You can use this file in scripts or extension attributes. One possible way is to parse it with `awk`, e.g.
|
||||
|
||||
Fields that were not set in user entry will not be shown at all. You can use this file in scripts or extension attributes. The easiest way would be to parse it with `awk`, e.g.
|
||||
|
||||
```
|
||||
```xml
|
||||
duration=$(awk -F ': ' '/duration: / {print $2}' /private/var/db/SetupManagerUserData.txt)
|
||||
```
|
||||
|
||||
## Final action and shutdown
|
||||
Starting with Setup Manager 1.2, the User Data file contains a list of actions with their status:
|
||||
|
||||
When the app is not running as root (for testing or from Xcode) or when the `DEBUG` preference is set, shutdown will merely quit.
|
||||
```
|
||||
enrollmentActions:
|
||||
-action 0: finished - Microsoft 365
|
||||
-action 1: finished - Google Chrome
|
||||
-action 2: finished - Jamf Connect
|
||||
```
|
||||
|
||||
The status can be `finished` or `failed`.
|
||||
|
||||
## "About This Mac…" window
|
||||
|
||||
When you hold the option key when clicking on "About This Mac…" you will see more information.
|
||||
|
||||
## Scannable Serial Number Barcode
|
||||
|
||||
Hitting the space bar while Setup Manager is the Active window will open a window with a scannable barcode of the serial number. Hitting the space bar again will dismiss the window.
|
||||
|
||||
Note that Setup Manager does not automatically get Key Window when it launches, while running over Setup Assistant, so you may have to click in the Setup Manager window, before hitting the space bar.
|
||||
|
||||
## Uninstall Setup Manager
|
||||
|
||||
Setup Manager will unload and remove its LaunchAgent and LauchDaemon files upon successful completion. That together with the [flag file](#flag-file) should prevent Setup Manager from launching on future reboots.
|
||||
|
||||
If you still want to remove Setup Manager after successful enrollment, there is [a sample uninstaller script in the Examples folder](../Examples/uninstall.sh).
|
||||
|
||||
## (Jamf Pro): Useful Smart Groups
|
||||
|
||||
You can create smart groups to coordinate installations of Configuration profiles. Some useful examples are:
|
||||
|
||||
### Setup Manager Installed
|
||||
|
||||
Criteria: 'Application Bundle ID' is `com.jamf.setupmanager`
|
||||
|
||||
You can use this smart group to scope or limit configuration profiles, Mac App Store/VPP apps, and Jamf App Installer apps. This way their installation will not occur immediately after enrollment, potentially slowing down the installation of essential Jamf Pro components and extending the "Getting Ready" phase.
|
||||
|
||||
### Setup Manager Done
|
||||
|
||||
Create an Extension attribute named "Setup Manager Done" with the script code:
|
||||
|
||||
```sh
|
||||
if [ -f "/private/var/db/.JamfSetupEnrollmentDone" ]; then
|
||||
echo "<result>done</result>"
|
||||
else
|
||||
echo "<result>incomplete</result>"
|
||||
fi
|
||||
```
|
||||
|
||||
Then create a Smart Group named "Setup Manager Done" with the criteria `"Setup Manager Done" is "done"`.
|
||||
|
||||
You can use this to scope configuration profiles and policies so that they are installed or run _after_ Setup Manager is complete.
|
||||
|
||||
## Running Scripts and Policies when Setup Manager finishes
|
||||
|
||||
Generally, you want to coordinate tasks, configurations, and installations with Setup Manager actions. However, in some situations the installations might interfere with the Setup Manager workflow itself. This is most relevant with software that needs to reload the login window process, which will also kill Setup Manager. (e.g Jamf Connect Login)
|
||||
|
||||
Setup Manager provides a LaunchDaemon which monitors the `.JamfEnrollmentSetupDone` flag file. It then launches a script or a custom Jamf Pro policy trigger. Since this LaunchDaemon runs independently from Setup Manager, so it can run installers or scripts that might quit login window or Setup Manager.
|
||||
|
||||
However, if you have set Setup Manager to automatically shut down or restart at the end, this will interrupt the finished script or policy, unless the automated delay is long enough. Use the [`finalAction`](../ConfigurationProfile.md#finalAction) value of `none` to remove the button and countdown from the Setup Manager UI. However, now it the responsibility of the finishing process to restart the Mac or quit the Setup Manager process, otherwise Setup Manager will keep blocking the UI.
|
||||
|
||||
The finished script or custom trigger are configured in the Setup Manager configuration profile, with the [`finishedScript`](../ConfigurationProfile.md#finishedScript) and [`finishedTrigger`](../ConfigurationProfile.md#finishedTrigger) keys.
|
||||
|
||||
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 |
|
||||
|
||||
92
Docs/FAQ.md
92
Docs/FAQ.md
@@ -1,6 +1,6 @@
|
||||
# Frequently Asked Questions
|
||||
|
||||
## Is there are custom JSON Schema for Jamf Pro?
|
||||
## Is there a custom JSON Schema for Jamf Pro?
|
||||
|
||||
[Yes.](Extras.md#custom-json-schema-for-jamf-pro)
|
||||
|
||||
@@ -12,24 +12,100 @@ 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:
|
||||
|
||||
- Jamf Pro: check that Setup Manager is added to your prestage and the package does not have the label "Availability pending" in Settings> Packages
|
||||
- Jamf Pro: do not install JamfConnect.pkg in prestage when you want to use Setup Manager. Install JamfConnect with Setup Manager instead
|
||||
- you need at least one of the 'Setup Assistant Options' in the prestage to be set to _not_ skip. Location Services or 'Choose your Look' are common choices, 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, 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
|
||||
|
||||
No.
|
||||
|
||||
Setup Manager will run fine without Jamf Connect. You can even build 'single-touch' style workflows with Setup Manager withough Jamf Connect. Some features, such as pre-assigning a device to a specific user require Jamf Connect, though.
|
||||
Setup Manager will run fine without Jamf Connect. You can even build 'single-touch' style workflows with Setup Manager without Jamf Connect. Some workflows, such as pre-assigning a device to a specific user require Jamf Connect, though.
|
||||
|
||||
## How can I use the icon for an app before the app is installed?
|
||||
|
||||
- preinstall icon files with a custom package installer in prestage. Set the priority of the media/branding package lower than that for Setup Manager, or give the branding/media package a name that is alphabetically earlier than Setup Manager, so it installs before Setup Manager
|
||||
- use http(s) urls to the image files
|
||||
- you can host them on a web server/service that you have control over
|
||||
- you can add the icon as an icon for a self service policy in Jamf and then copy the url to the icon once uploaded
|
||||
- you can add the icon to a Self Service policy in Jamf and then copy the url to the icon once uploaded
|
||||
|
||||
|
||||
## What is happening during the "Getting Ready" steps?
|
||||
## What is happening during "Getting Ready" and "Finishing"?
|
||||
|
||||
During the "Getting Ready" phase, Setup Manager is waiting for the Jamf Pro configuration to be complete, and runs a recon, so that policies during the enrollment phase can already be scoped. You cannot change the steps in this phase. You can see the details and possibly failures in the Setup Manager log.
|
||||
During the "Getting Ready" phase, Setup Manager is waiting for the enrollment configuration to be complete. The steps taken during these phases depend on the version of Setup Manager and the management system.
|
||||
|
||||
When enrolled into Jamf Pro, Setup Manager runs (among other things) a recon/Update Inventory during "Getting Ready" and "Finishing." This will make up most of the time in these phases.
|
||||
|
||||
You can open the log window (command-L) or review the [log file](Extras.md#logging) for detail for each step. Should Setup Manager stall during one of these steps, you can [quit](Extras.md#quit) out of Setup Manager and review the [log file](Extras.md#logging) after completing the setup.
|
||||
|
||||
## (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.
|
||||
|
||||
Note that you can see the individual steps and the timing for each step in the [Setup Manager log file](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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
## Can I set the wallpaper/desktop picture or dock with Setup Manager?
|
||||
|
||||
The settings for the dock and wallpaper/desktop picture are _user_ settings. Since the user account usually does not yet exist when Setup Manager runs, you cannot affect those settings.
|
||||
|
||||
What you can do is run a script at login which sets the desktop (using [desktoppr](https://github.com/scriptingosx/desktoppr) ) or the dock (using [dockutil](https://github.com/kcrawford/dockutil) or a similar tool).
|
||||
|
||||
## If Setup Manager cannot do it, how can I run scripts at first login
|
||||
|
||||
There are several options:
|
||||
|
||||
- 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?
|
||||
|
||||
Technically, yes.
|
||||
|
||||
With Jamf Pro, you can set the Setup Manager pkg to install at the `login` trigger or manually from Self Service. Then it will launch within the user session.
|
||||
|
||||
This is not, however, the primary workflow for Setup Manager and not something that we will test or verify. We believe running right after enrollment over Setup Assistant is the preferable deployment.
|
||||
|
||||
With Jamf Pro, you should consider [macOS Onboarding in Self Service](https://learn.jamf.com/en-US/bundle/jamf-pro-documentation-current/page/macOS_Onboarding.html) or a [login trigger](https://learn.jamf.com/en-US/bundle/jamf-pro-documentation-current/page/Login_Events.html) instead.
|
||||
|
||||
## Installer or Policy Script is failing with access errors
|
||||
|
||||
For some policy scripts or installers it may be necessary to give the Setup Manager app Full Disk Access or some other exemptions with a PPPC Profile.
|
||||
|
||||
## Installomator actions are all failing
|
||||
|
||||
The log shows exit code 4, which means the download was rejected.
|
||||
|
||||
Installomator uses Gatekeeper to verify the downloads. When Gatekeeper is set to allow Mac App Store apps only it will reject all third party apps and installers and the verification will fail.
|
||||
|
||||
## Can I set Installomator variables?
|
||||
|
||||
Yes. The `installomator` action has an `arguments` key, which takes an array strings, one for each argument. With this, you can override variables in Installomator.
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<dict>
|
||||
<key>label</key>
|
||||
<string>Example App</string>
|
||||
<key>installomator</key>
|
||||
<string>example</string>
|
||||
<key>arguments</key>
|
||||
<array>
|
||||
<string>downloadURL=https://example.com/alternativeURL</string>
|
||||
</array>
|
||||
</dict>
|
||||
```
|
||||
|
||||
33
Docs/JamfPro-LoginWindow.md
Normal file
33
Docs/JamfPro-LoginWindow.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Jamf Pro: Run Setup Manager at Login Window
|
||||
|
||||
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.
|
||||
|
||||
However, this requires the enrollment workflow to be configured so that it will eventually end at Login Window, usually by connecting the Mac to a directory service.
|
||||
|
||||
## Prestage configuration
|
||||
|
||||
- Create or clone a new prestage to run Setup Manager at Login Window.
|
||||
|
||||
- Under 'General', under 'Setup Assistant', enable 'Automatically advance through Setup Assistant'. Select the language and region you want to assign to the Macs.
|
||||
|
||||
- Select all options to be skipped.
|
||||
|
||||
- Under 'Account Settings' choose to create a managed local administrator, configure the user name, password and other options.
|
||||
|
||||
- In 'Local User Account Type', select 'Skip Account Creation'
|
||||
|
||||
- Under 'Configuration Profiles', select the Setup Manager configuration profile. In that profile, set the [`runAt` key](../ConfigurationProfile.md#runAt) to `loginwindow`.
|
||||
|
||||
- Upload the Setup Manager installation pkg from the [Releases](https://github.com/jamf-concepts/setup-manager/releases) section to Jamf Pro and add it to the 'Enrollment Packages' section. Ensure you have selected 'Cloud Distribution Point' as the distribution point or setup the manifest for an on-premise deployment.
|
||||
|
||||
## Bind to directory
|
||||
|
||||
You will likely need to bind the Mac to a directory service to allow for user login after successful deployment. This can be triggered by a policy as an Setup Manager action.
|
||||
|
||||
## Auto Advance
|
||||
|
||||
The Apple feature to automatically advance through the Setup Assistant screens has a few requirements. The Mac has to be registered in Apple Business Manager or Apple School Manager and assigned to the MDM servier. It also has to be connected with ethernet to a network that can reach the MDM server, all Apple services and other internal services you might configure during enrollment (e.g. directory or IdP server).
|
||||
|
||||
Auto Advance doesn't 'kick in' until after Voiceover has introduced itself and if you ever touch any of the controls, AutoAdvance will stop and you have to continue manually.
|
||||
@@ -47,12 +47,12 @@ You can add more actions here. There are more types of actions available, you ca
|
||||
|
||||
## Scoping and Prestage
|
||||
|
||||
- Scope the configuration profile to the computers you want to run Setup Manager on
|
||||
- scope the configuration profile to the computers you want to run Setup Manager on
|
||||
- create a new Prestage or duplicate an existing one
|
||||
- Add the Setup Manager pkg and the configuration profile to the Prestage
|
||||
- if you have JamfConnect.pkg in the Prestage, remove it. You can later add an action to install JamfConnect using Setup Manager.
|
||||
- add the Setup Manager pkg and the configuration profile to the Prestage
|
||||
- when installing and using Jamf Connect Login, ensure you have the latest version
|
||||
- ensure that 'Automatically advance through Setup Assitant' is _disabled_
|
||||
- Have at least one option _disabled_ (so that _is_ displayed)
|
||||
- have at least one Setup Assistant option which shows before user creation _disabled_ (so that _is_ displayed), we recommend the Location Services or Terms and Conditions pane
|
||||
- ensure your test Mac(s) is (are) assigned to the Prestage
|
||||
|
||||
## Wipe the Test Mac
|
||||
@@ -64,8 +64,7 @@ You can add more actions here. There are more types of actions available, you ca
|
||||
|
||||
## Next Steps
|
||||
|
||||
- add more actions to Setup Manager, you can use more Jamf Pro policies, Installomator labels, or shell actions
|
||||
- add a computer name template key to the profile to automate computer naming
|
||||
- add a `help` section to let the user know what is going on
|
||||
- ideally automated deployments shouldn't require manual entry, but if necessary, you can configure a user entry section in the profile
|
||||
|
||||
- add more [actions](../ConfigurationProfile.md#actions) to Setup Manager, you can use more Jamf Pro policies, Installomator labels, or shell actions
|
||||
- automate computer naming with a [computer name template key](../ConfigurationProfile.md#computerNameTemplate)
|
||||
- optionally, add [a `help` section](../ConfigurationProfile.md#help) to let the user know what is going on
|
||||
- ideally automated deployments shouldn't require manual data entry, but if necessary, you can configure a [user entry](../ConfigurationProfile.md#user-entry) section in the profile
|
||||
|
||||
@@ -47,7 +47,6 @@ Setup Manager also saves the data from user entry in a plain text file which you
|
||||
<string>symbol:plus.app</string>
|
||||
<key>label</key>
|
||||
<string>Extra Apps for %department%</string>
|
||||
</dict>
|
||||
<key>policy</key>
|
||||
<string>install_extra_apps</string>
|
||||
</dict>
|
||||
|
||||
@@ -16,7 +16,9 @@ You can use a combination of Jamf Pro, Setup Manager and Jamf Connector, to get
|
||||
|
||||
Customized Enrollment with SSO is not _required_ for this workflow. The assignment to the final user is set from the email entered in Setup Manager. Nevertheless, customized enrollment with SSO is useful in this context since restricts Mac enrollment to a group of authorized accounts.
|
||||
|
||||
You should have Jamf Pro and Jamf Connect configured with the required SSO integrations and thoroughly tested before configuring this workflow.
|
||||
You should have Jamf Pro and Jamf Connect configured with the required SSO integrations and thoroughly tested before configuring this workflow.
|
||||
|
||||
Verify that "Collect User and Location information from Directory Service" is **enabled** in Settings > Computer management > Inventory collection.
|
||||
|
||||
## Configure Setup Manager
|
||||
|
||||
@@ -86,6 +88,8 @@ Then create a Smart Group named "Setup Manager Done" with the criteria `"Setup M
|
||||
|
||||
## Pre-set user for Jamf Connect
|
||||
|
||||
Note: this step only works with Entra ID as the Identity Provider.
|
||||
|
||||
Jamf Connect Login allows pre-configuring the user. Create a configuration profile named "Jamf Connect Enrollment User" to the preference domain `com.jamf.connect.login` with the following property list:
|
||||
|
||||
```xml
|
||||
|
||||
@@ -1,166 +1,64 @@
|
||||
# Installation and Configuration: Jamf School
|
||||
# Jamf School: Setup Manager Quick Start
|
||||
|
||||
## Selecting Deployment Method
|
||||
### Upload Setup Manager Package
|
||||
|
||||
Jamf Setup Manager can be deployed to run at two different points during a device deployment. Right after enrollment (the default) and at login window. You must select which method is appropriate for your deployment before configuring the Jamf Setup Manager Workflow in Jamf School
|
||||
Download the latest version of the Setup Manager installation pkg from the [releases page](https://github.com/Jamf-Concepts/Setup-Manager/releases)
|
||||
|
||||
### At Enrollment (Default)
|
||||
Once you have the pkg it needs to be uploaded to Jamf School as an `In House macOS app` and can be done by logging into Jamf School and Navigating to
|
||||
|
||||
Jamf Setup Managers default deployment action is to run at `Setup Assistant`.
|
||||
* **Apps** -> **Inventory** -> **click on + Add App**
|
||||
* Click **Add In-House macOS Package**
|
||||
* Navigate to the downloaded Jamf Setup Manager Package and drag into the window
|
||||
* Once uploaded click **Save** (no need to scope anything at this point)
|
||||
|
||||
Setup Manager will appear and during `Setup Assistant` allowing the user to continue to configure `Setup Assistant` after Setup Manager has completed its tasks.
|
||||
|
||||
_**This method is recomended for 1:1 environments**_
|
||||
### Prepare Jamf School In House macOS Apps, VPP Apps and Configurations
|
||||
|
||||
Example
|
||||
> You deploy 1:1 MacBooks, want to ensure that critical software installed prior to the user working on the device but also require the user to configure TouchID and create a user account during the onboarding.
|
||||
Setup Manager can "watch" for items in a particular file path on the volume. This is a great way to check if an app installed via VPP or In House macOS Apps (custom packages) are installed before moving on to the next action.
|
||||
|
||||
> The user will connect the MacBook to the network and enroll into MDM. After a short delay Setup Manger will run and complete its tasks and install critical software
|
||||
If you intend to "watch" for an item in your Setup Manager workflow ensure to scope the app(s) in the convential way.
|
||||
|
||||
> Once complete the user will be released back to Setup Assistant where they will be able to use the Setup Assistant panes to configure TouchID and create a user
|
||||
Other apps (that are not being monitored through Setup Manager) and profile configurations should be scoped to the target devices in the convential way
|
||||
|
||||
*How you scope these addtional items will depend on your deployment but as an example this could be done through the App Inventory menu or via a smart / static group.*
|
||||
|
||||
### Create the Setup Manager Configuration Profile
|
||||
|
||||
With this default method you will require an Automated Device Enrollment Profile configured with
|
||||
There are many actions and configurable items available for Setup Manager, which are well [documented here](https://github.com/Jamf-Concepts/Setup-Manager/blob/main/ConfigurationProfile.md).
|
||||
|
||||
- At least one setup assistant pane configured
|
||||
- *“Wait for the configuration to be applied before continuing the Setup Assistant”* box checked
|
||||
- An admin account should be configured as required
|
||||
- Other ADE profile setting should be set as required
|
||||
- _**Do Not**_ select `Auto Advance`
|
||||
*Its worth noting that there are a number of actions that can be performed that are only available for Jamf Pro, these are clearly stated in the documentation.*
|
||||
|
||||
> If the user skips through all of the Setup Assistant panes before Setup Manager launches or Auto Advance is selected. and the device lands on the login screen, Setup Manager will not launch
|
||||
To help you get started on creating a Configuration Profile, there is a [sample profile](https://github.com/Jamf-Concepts/Setup-Manager/blob/main/Examples/sample-jamfschool.mobileconfig).
|
||||
|
||||
This sample profile can then be edited using a text editor tool such as [BBEdit](https://www.barebones.com/products/bbedit/) or a tool specifically for editing plists and profiles, such as [PlistEdit Pro](https://www.fatcatsoftware.com/plisteditpro/).
|
||||
|
||||
### At Login Window
|
||||
If you'd prefer to not edit in text format [iMazing Profile Editor](https://imazing.com/profile-editor) now has a community created payload spefically for Setup Manager which enables you to create a profile in a more user friendly GUI
|
||||
|
||||
Jamf Setup Manager can be configured to run at `Login Window`.
|
||||
Once you have a configuration profile with the desired actions it should be uploaded to Jamf School. Navigate to
|
||||
|
||||
Setup Manager will appear once the device has ran through `Setup Assistant` and is waiting at the login screen and run through its tasks. Releasing back to the login window once complete.
|
||||
* **Profiles** -> **Overview** -> click **+Create Profile**
|
||||
* Click **Upload Custom Profile** -> Find the configuration profile on your system and drag to the window
|
||||
* Click **Next**
|
||||
* Give the profile and name and description -> click **Next**
|
||||
* Click **Finish**
|
||||
* Click **Save** (no need to scope anything at this point)
|
||||
|
||||
_**This method is recommended for lab environment**_
|
||||
### Automated Device Enrolment Profile & Scoping
|
||||
|
||||
Example
|
||||
> You are deploying a lab of iMacs ready for the new academic year. You wish to connect iMacs to the network with ethernet, power on and leave the devices to enroll and build while you complete other tasks.
|
||||
Create a new ADE profile by Navigating to
|
||||
|
||||
> After configuring an ADE profile with Auto Advance an iMac will enroll into Jamf School and move through Setup Assistant without any user interaction. Once at the login Window Setup Manager will run and complete its tasks.
|
||||
* **Profiles** -> **Automated Device Enrolment Profiles** -> click **+macOS**
|
||||
* Fill out the profile as required for your deployment but **DO NOT** check the *Enable Zero-Touch Setup* box
|
||||
* Click **Add** under profiles and select your *Jamf Setup Manager Configuration Profile* from the drop down menu
|
||||
* Click **Add** under packages and select the *Jamf Setup Manager package* from the drop down menu
|
||||
* Click **Save**
|
||||
|
||||
> Once Setup Manager is complete the build is complete
|
||||
Finally scope the ADE profile to the required devices
|
||||
|
||||
### Wipe The Test Mac
|
||||
|
||||
To run Setup Manager at `Login Window` you will require
|
||||
* On the test mac, choose `Erase all Contents and Settings` in the Settings app or wipe the Mac using the `Erase Device` remote management command in Jamf Pro
|
||||
* Click through the initial enrollment dialogs. After you approve the enrollment in your MDM, Setup Manger should appear and perform the actions you configured
|
||||
* While the installations are progressing, click on "About this Mac…" for information, click again while holding down the option key for even more information
|
||||
* Hit `command-L` for a log window. You can also find this log info later at `/Library/Logs/Setup Manager.log`
|
||||
|
||||
1. A Setup Manager Profile with the key `runAt` and `String Value` of `loginwindow`
|
||||
2. An Automated Device Enrollment Profile configured with
|
||||
|
||||
- An admin account
|
||||
- `Auto Advance` configured
|
||||
- Other ADE profile setting should be set as required
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Jamf Setup Manager Workflow Requirements
|
||||
|
||||
In order to configure the workflow in Jamf School you will need
|
||||
|
||||
- A Jamf Setup Manager Configuration Profile (customized for your deployment, example profile below) uploaded to Jamf School
|
||||
- Jamf Setup Manager package installer (available from Jamf Concepts) uploaded to Jamf School
|
||||
- An Automated Device Enrollment Profile with the correct settings for your chosen deployment method (`default` or `LoginWindow`)
|
||||
|
||||
|
||||
---
|
||||
|
||||
**Step 1: Configuration Profile**
|
||||
Create a Payload-less Profile for Smart Group Targeting
|
||||
|
||||
- Navigate to profiles and create a new macOS Profile
|
||||
- Name it *“Jamf Setup Manager Installed”*
|
||||
- Do not scope the profile and do not configure any payloads. Simply save the profile
|
||||
|
||||
---
|
||||
|
||||
**Step 2: Smart Group for Setup Manger Config Profile**
|
||||
Create a Smart Group to target your required Macs
|
||||
|
||||
- Navigate to `Devices → Device Groups` and create a new group. Ensure you select `Smart Group`
|
||||
- Name the Group *“Jamf Setup Manager Profile”* skip all other panes until members
|
||||
- In members select `Automated Device Enrollment Profile` `equals` and then select the ADE profile that you created as part of the requirements step. This will target any and all devices that enrol using that ADE profile
|
||||
|
||||
> If you only want to select a subset of macOS devices, for example Lab Mac devices and not 1:1 devices, configure this group to target additional critera the desired devices in your environment will have
|
||||
|
||||
- `Save` Scope
|
||||
- Next in the `Profiles` tab add the Jamf Setup Manager Configuration Profile that you uploaded to Jamf School
|
||||
|
||||
---
|
||||
|
||||
**Step 3: Smart Group to install Setup Manager**
|
||||
Create a Smart Group to target devices with Jamf Setup Manager Profile Installed to deploy the Setup Manager pkg
|
||||
|
||||
- Navigate to `Devices` → `Device Groups` and create a new group. Ensure you select `Smart Group`
|
||||
- Name the Group *“Install Jamf Setup Manager”*, skip all other panes until members
|
||||
- In members select `Managed Profile (Installed)` `equals` and then select the Jamf Setup Manager Configuration Profile that you uploaded to Jamf School
|
||||
- `Save` Scope
|
||||
- Next in the `Apps` tab add the Jamf Setup Manager pkg and in the `Profiles` tab select the *“Jamf Setup Manager Installed”* profile you created in Step 1
|
||||
|
||||
|
||||
> If you named your profile in step 1 something different, be sure to select that profile in this step
|
||||
|
||||
---
|
||||
|
||||
**Step 4: Smart Group for all other apps and configurations**
|
||||
Create a Smart Group to target devices with the “Jamf Setup Manager Installed” profile installed and deploy the rest of the profile and apps
|
||||
|
||||
- Navigate to `Devices` → `Device Groups` and create a new group. Ensure you select `Smart Group`
|
||||
- Name the group *“macOS Management & Apps”*, skip all other panes until members
|
||||
In members select `Managed Profile (Installed)` `equals` and then select *"Jamf Setup Manager Installed"* profile that you created in Step 1
|
||||
|
||||
> If you named your profile in step 1 something different, be sure to select that profile in this step
|
||||
|
||||
- Next in the `Apps` tab add any apps or packages that will not be installed via Installomator as part of the Jamf Setup Workflow and in the `Profiles` tab any any and all config needed to manage your Macs
|
||||
- If you install packages or App Store apps through Jamf School, and you want to report on them as part of the Jamf Setup Manager workflow be sure to add `Watchpaths` for the apps / content into the Jamf `Setup Manager Configuration Profile` before uploading to Jamf School
|
||||
|
||||
---
|
||||
|
||||
### Workflow
|
||||
|
||||
These chained amart group actions then perform the following flow
|
||||
|
||||
- Scope the Jamf Setup Manager Config profiles to all macOS devices enrolled with a given ADE profile
|
||||
- Once the Profile is reported as installed by Jamf School, it will then install the Jamf Setup Manager pkg (since we 100% know the config profile is on the device before the pkg, we know it’ll be configured in the correct manner) and the *“Jamf Setup Manager Installed”* profile
|
||||
- Only when the device reports back that it has *“Jamf Setup Manager Installed”* profile will it move into the next smart group where it will receive the `commands` to install further apps / packages and the rest of the configuration profiles.
|
||||
|
||||
|
||||
With this flow we are controlling, the best we can, that the first thing the device does is install Jamf Setup Manager and the required config. This is rather than having Jamf Setup Manager queued further down a list of apps that are installing.
|
||||
|
||||
> You can view the device activity log in the Jamf School console to ensure that the InstallEnterpriseApp command for Setup Manager is received before other app commands, for testing and troubleshooting.
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Workflow Considerations and Warnings
|
||||
|
||||
The Jamf Setup Manager workflow for Jamf School has been designed to take advantage of profile installation reporting in smart groups and in part to tackle the fact that Jamf School does not have a concept of *“Pre-Stage Packages”*. As such the workflow relies on chaining together smart groups where membership of one group is dependent on an action of the previous step.
|
||||
|
||||
Example
|
||||
> You can view the device activity log in the Jamf School console to ensure that the InstallEnterpriseApp command for Setup Manager is received before other app commands, for testing and troubleshooting.
|
||||
>
|
||||
If an admin to accidentally unscoped the *“Jamf Setup Manager Installed”* profile from a device it would then fall out of scope of the *“macOS Management & Apps”* group, as its membership criteria requires the *“Jamf Setup Manager Installed”* profile to be installed on the device.
|
||||
|
||||
> Since the *“macOS Management & Apps”* group is where all of the management and App Store apps are scoped removal from this group means the device has the profiles and App Store apps removed, resulting in a device in an unexpected state.
|
||||
|
||||
Therefore it is essential that the device maintains this chained smart group flow throughout its deployment.
|
||||
|
||||
Should you need to `update`, `amend` or `edit` the `Jamf Setup Manager Configuration Profile` that controls Setup Manager, you will need to do this locally and then re-upload to Jamf School.
|
||||
|
||||
For best results we recommend the following workflow
|
||||
|
||||
- Navigate to the current profile in Jamf School in the `Profiles` -> `Configuration Profiles` menu
|
||||
- Click the `pencil icon` to edit
|
||||
- Click `replace profile`
|
||||
- Drag local updated profile to the revealed box or click on the box to navigate to the profile
|
||||
- Click `save`
|
||||
|
||||
Following this workflow keeps the name of the profile in Jamf School the same as the previous version and there is no need to edit / add a different or new profile the the scope in `Step 2` or change the criteria for the name of the installed profile in `Step 3`
|
||||
|
||||
Should you want to keep different versions of the Jamf Setup Manager Configuration Profile in Jamf School in order to switch between different Setup Manager actions please ensure that you update the profile in `Step 2` and `Step 3` to match the desired Jamf Setup Manager Configuration Profile prior to deploying devices. Failure to do this could result in the breaking of the smart group chain required for Jamf School resulting in devices in an unexpected state (ie not with the desired configurations and/or apps)
|
||||
|
||||
27
Docs/LaunchTracking.md
Normal file
27
Docs/LaunchTracking.md
Normal 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.
|
||||
87
Docs/Network.md
Normal file
87
Docs/Network.md
Normal file
@@ -0,0 +1,87 @@
|
||||
# Network Connectivity
|
||||
|
||||
Setup Manager can display the current network status in the top right corner of the main window.
|
||||
|
||||
By default, the icon will only appear when
|
||||
- there is no network connection or the connection is lost
|
||||
- Network Relay is configured
|
||||
- the `networkCheck` array is present in the profile, even when it is empty
|
||||
|
||||
You can always manually toggle the visibility of the network status icon with command-N.
|
||||
|
||||
The icon will show the network "globe" icon when the network is connected, the icon with a slash when it is disconnected, and the icon with a small shield when it is connected and Network Relay is configured.
|
||||
|
||||
You can click on the icon for more detailed information:
|
||||
- network connection name
|
||||
- IP addresses (IPv4 and IPv6, when present)
|
||||
- Network Bandwidth information (these take a while to appear, be patient)
|
||||
- When Network Relay is configured, it will show the connectivity to the HTTP3/QUIC and HTTP2 hosts
|
||||
- Connectivity to certain hosts
|
||||
- by default, the Jamf Server will be shown
|
||||
- You can add a list of custom hosts in the configuration profile
|
||||
|
||||
### `networkCheck`
|
||||
(array of dict, optional)
|
||||
|
||||
Provides a list of hosts to check connectivity to. These will be shown in the 'Connectivity' section in the network info pane.
|
||||
|
||||
Each dict in this array represents a check for a connection to a host. The dict can contain the following keys:
|
||||
|
||||
#### `host`
|
||||
|
||||
(string)
|
||||
|
||||
The host name, e.g. `host.example.com` (no url scheme) to test a connection to.
|
||||
|
||||
#### `port`
|
||||
|
||||
(integer, optional, default: `443`)
|
||||
|
||||
The port to test a connection to.
|
||||
|
||||
#### `protocol`
|
||||
|
||||
(string, optional, default: `tcp`)
|
||||
|
||||
The connection protocol to test: `tcp` or `udp`.
|
||||
|
||||
#### `label`
|
||||
|
||||
(string, localizable, optional)
|
||||
|
||||
A display label for the connection test.
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<key>networkCheck</key>
|
||||
<array>
|
||||
<dict>
|
||||
<key>host</key>
|
||||
<string>map.wandera.com</string>
|
||||
<key>label</key>
|
||||
<string>Intranet Maps</string>
|
||||
<key>port</key>
|
||||
<integer>443</integer>
|
||||
<key>protocol</key>
|
||||
<string>tcp</string>
|
||||
</dict>
|
||||
</array>
|
||||
```
|
||||
|
||||
Example: empty `networkCheck` array to force Network icon to always show
|
||||
|
||||
```xml
|
||||
<key>networkCheck</key>
|
||||
<array/>
|
||||
```
|
||||
|
||||
## 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. Changes to network or Wi-Fi configurations and other network or security tools might disrupt the network connectivity during enrollment. This might interrupt or cancel downloads.
|
||||
|
||||
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.
|
||||
164
Docs/Webhooks.md
Normal file
164
Docs/Webhooks.md
Normal file
@@ -0,0 +1,164 @@
|
||||
# Webhooks
|
||||
|
||||
#### `webhooks`
|
||||
|
||||
(Dict, optional)
|
||||
|
||||
Setup Manager can send webhooks to inform other services of its status. The configuration for the webhooks in all stored under the top-level `webhooks` key.
|
||||
|
||||
The webhooks dict can contain two keys, both of which are again dicts. `started` defines the webhook or webhooks that are called when Setup Manager starts its workflow, and the other `finished` defines the webhook or webhooks when it finishes the workflow.
|
||||
|
||||
When the either the `started` or `finished` key is missing, no webhook will be sent for that event.
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<key>webhooks</key>
|
||||
<dict>
|
||||
<key>finished</key>
|
||||
<string>https://example.com/webhook-finish</string>
|
||||
<key>started</key>
|
||||
<string>https://example.com/webhook-start</string>
|
||||
</dict>
|
||||
```
|
||||
|
||||
### Multiple webhooks
|
||||
|
||||
You can send multiple services per event:
|
||||
|
||||
```xml
|
||||
<key>webhooks</key>
|
||||
<dict>
|
||||
<key>finished</key>
|
||||
<array>
|
||||
<string>https://example.com/webhook-finish</string>
|
||||
<string>https://otherservice.com/abc123456</string>
|
||||
</array>
|
||||
<key>started</key>
|
||||
<array>
|
||||
<string>https://example.com/webhook-start</string>
|
||||
<string>https://otherservice.com/abc123456</string>
|
||||
</array>
|
||||
</dict>
|
||||
```
|
||||
|
||||
### WebHook Data
|
||||
|
||||
For the `started` webhook, Setup Manager attaches this data:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Started", // string
|
||||
"event": "com.jamf.setupmanager.started" // string
|
||||
"timestamp": "2025-01-14T15:11:28Z", // time setup manager started, date as string, iso8601
|
||||
"started": "2025-01-14T15:11:27Z", // time webhook was sent, date as string, iso8601
|
||||
"modelName": "MacBook Air", // string
|
||||
"modelIdentifier": "Mac14,2", // string
|
||||
"macOSBuild": "24C101", // string
|
||||
"macOSVersion": "15.2.0", // string
|
||||
"serialNumber": "ABCD1234DE", // string
|
||||
"setupManagerVersion": "1.2" // string
|
||||
"jamfProVersion": "11.13.0" // optional, only for Jamf Pro, string
|
||||
"jssID": 1234 // optional, only when `jssID` is set in profile, string
|
||||
}
|
||||
```
|
||||
|
||||
The data for the `finished` webhook includes the same as above, with some additional fields:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Finished", // string
|
||||
"event": "com.jamf.setupmanager.finished" // string
|
||||
"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
|
||||
"userEntry": { // data entered by the user
|
||||
"department": "IT",
|
||||
"computerName": "IT-ABC123",
|
||||
"userID": "a.b@example.,com",
|
||||
"assetTag": "abc54321"
|
||||
},
|
||||
"enrollmentActions": [ // array of enrollmentActions with status
|
||||
{
|
||||
"label": "Microsoft 365",
|
||||
"status": "finished" // status: "finished" or "failed"
|
||||
},
|
||||
{
|
||||
"label": "Google Chrome",
|
||||
"status": "finished"
|
||||
},
|
||||
{
|
||||
"label": "Jamf Connect",
|
||||
"status": "finished"
|
||||
},
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
### Microsoft Teams
|
||||
|
||||
When you set up [an incoming webhook workflow with Microsoft Teams](https://support.microsoft.com/en-us/office/create-incoming-webhooks-with-workflows-for-microsoft-teams-8ae491c7-0394-4861-ba59-055e33f75498) the json payload is expected in a certain format.
|
||||
|
||||
**Important Note:** _The Teams Workflow Webhook URL will contain ampersands `&`. Since configuration profiles are XML files, you need to escape/replace all ampersands in the URL with the XML escape sequence `&`._
|
||||
|
||||
Use this webhook format in the Setup Manager profile:
|
||||
|
||||
```xml
|
||||
<dict>
|
||||
<key>kind</key>
|
||||
<string>teams</string>
|
||||
<key>url</key>
|
||||
<string>--insert url from Teams Workflows here--</string>
|
||||
</dict>
|
||||
```
|
||||
|
||||
This `dict` replaces the simple `string` syntax.
|
||||
|
||||
### Slack
|
||||
|
||||
You can also [configure Slack to receive messages on webhook url](https://api.slack.com/messaging/webhooks).
|
||||
|
||||
Use this webhook format in the Setup Manager profile:
|
||||
|
||||
```xml
|
||||
<dict>
|
||||
<key>kind</key>
|
||||
<string>slack</string>
|
||||
<key>url</key>
|
||||
<string>--insert url from Slack here--</string>
|
||||
</dict>
|
||||
```
|
||||
|
||||
### Multiple webhooks
|
||||
|
||||
You can send multiple services per event:
|
||||
|
||||
```xml
|
||||
<key>webhooks</key>
|
||||
<dict>
|
||||
<key>finished</key>
|
||||
<array>
|
||||
<string>https://example.com/webhook-finish</string>
|
||||
<dict>
|
||||
<key>kind</key>
|
||||
<string>teams</string>
|
||||
<key>url</key>
|
||||
<string>--insert url from Teams Workflows here--</string>
|
||||
</dict>
|
||||
</array>
|
||||
<key>started</key>
|
||||
<array>
|
||||
<string>https://example.com/webhook-start</string>
|
||||
<dict>
|
||||
<key>kind</key>
|
||||
<string>teams</string>
|
||||
<key>url</key>
|
||||
<string>--insert url from Teams Workflows here--</string>
|
||||
</dict>
|
||||
</array>
|
||||
</dict>
|
||||
```
|
||||
|
||||
### 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.
|
||||
@@ -15,17 +15,25 @@
|
||||
<key>label</key>
|
||||
<dict>
|
||||
<key>de</key>
|
||||
<string>Zeitzone setzen</string>
|
||||
<string>Zeitzone einstellen</string>
|
||||
<key>en</key>
|
||||
<string>Set Time Zone</string>
|
||||
<key>es</key>
|
||||
<string>Establecer zona horaria</string>
|
||||
<key>fr</key>
|
||||
<string>Définir le fuseau horaire</string>
|
||||
<key>he</key>
|
||||
<string>הגדרות אזור זמן</string>
|
||||
<key>it</key>
|
||||
<string>Imposta il fuso orario</string>
|
||||
<key>nl</key>
|
||||
<string>Tijdzone instellen</string>
|
||||
<key>sv</key>
|
||||
<string>Ställ in tidszon</string>
|
||||
<key>nb</key>
|
||||
<string>Angi tidssone</string>
|
||||
<key>pl</key>
|
||||
<string>Ustal strefę czasową</string>
|
||||
</dict>
|
||||
<key>requiresRoot</key>
|
||||
<true/>
|
||||
@@ -83,10 +91,18 @@
|
||||
<string>Por favor espere mientras Setup Manager configura tu nuevo Mac.</string>
|
||||
<key>fr</key>
|
||||
<string>Veuillez être patient pendant que Setup Manager configure votre nouveau Mac.</string>
|
||||
<key>he</key>
|
||||
<string>אנא התאזר בסבלנות בזמן ש-Setup Manager מגדיר את ה-Mac החדש שלך</string>
|
||||
<key>it</key>
|
||||
<string>Sii paziente mentre Setup Manager configura il tuo nuovo Mac.</string>
|
||||
<key>nl</key>
|
||||
<string>Even geduld terwijl Setup Manager je nieuwe Mac configureert.</string>
|
||||
<key>pl</key>
|
||||
<string>Prosimy o cierpliwość, podczas gdy Setup Manager konfiguruje Twojego nowego Maca.</string>
|
||||
<key>sv</key>
|
||||
<string>Ha tålamod medan Setup Manager konfigurerar din nya Mac.</string>
|
||||
<key>nb</key>
|
||||
<string>Vær tålmodig mens Setup Manager konfigurerer den nye Mac-en din.</string>
|
||||
</dict>
|
||||
<key>title</key>
|
||||
<dict>
|
||||
@@ -95,13 +111,21 @@
|
||||
<key>en</key>
|
||||
<string>Welcome!</string>
|
||||
<key>es</key>
|
||||
<string>¡Bienvenido!</string>
|
||||
<string>¡^[^[Bienvenido](inflect: true)](inflectionAlternative: 'Te damos la bienvenida')!</string>
|
||||
<key>fr</key>
|
||||
<string>Bienvenu!</string>
|
||||
<key>he</key>
|
||||
<string>ברוכים הבאים!</string>
|
||||
<key>it</key>
|
||||
<string>Benvenuto!</string>
|
||||
<string>^[Benvenuto](inflect: true, inflectionAlternative: "Ciao")!</string>
|
||||
<key>nl</key>
|
||||
<string>Welcom!</string>
|
||||
<key>pl</key>
|
||||
<string>Witamy!</string>
|
||||
<key>sv</key>
|
||||
<string>Välkommen</string>
|
||||
<key>nb</key>
|
||||
<string>Velkommen</string>
|
||||
</dict>
|
||||
<key>userEntry</key>
|
||||
<dict>
|
||||
|
||||
156
Examples/sample-waitForUserEntry.plist
Normal file
156
Examples/sample-waitForUserEntry.plist
Normal file
@@ -0,0 +1,156 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>enrollmentActions</key>
|
||||
<array>
|
||||
<dict>
|
||||
<key>arguments</key>
|
||||
<array>
|
||||
<string>-setTimeZone</string>
|
||||
<string>Europe/Amsterdam</string>
|
||||
</array>
|
||||
<key>icon</key>
|
||||
<string>symbol:clock</string>
|
||||
<key>label</key>
|
||||
<dict>
|
||||
<key>de</key>
|
||||
<string>Zeitzone setzen</string>
|
||||
<key>en</key>
|
||||
<string>Set Time Zone</string>
|
||||
<key>es</key>
|
||||
<string>Establecer zona horaria</string>
|
||||
<key>fr</key>
|
||||
<string>Définir le fuseau horaire</string>
|
||||
<key>it</key>
|
||||
<string>Imposta il fuso orario</string>
|
||||
<key>nl</key>
|
||||
<string>Tijdzone instellen</string>
|
||||
</dict>
|
||||
<key>requiresRoot</key>
|
||||
<true/>
|
||||
<key>shell</key>
|
||||
<string>/usr/sbin/systemsetup</string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>icon</key>
|
||||
<string>https://ics.services.jamfcloud.com/icon/hash_bb4e9c7d19adf8360ff28d666b01e66c35ae3e8d190660ac496d5a8abf4276a8</string>
|
||||
<key>label</key>
|
||||
<string>Microsoft 365</string>
|
||||
<key>policy</key>
|
||||
<string>install_microsoft365</string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>icon</key>
|
||||
<string>https://ics.services.jamfcloud.com/icon/hash_87d2224fa990a47de96f63fb2f84aa3b7304c20a3ff29412f5a7a484745fd2c9</string>
|
||||
<key>label</key>
|
||||
<string>Google Chrome</string>
|
||||
<key>policy</key>
|
||||
<string>install_chrome</string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>icon</key>
|
||||
<string>https://ics.services.jamfcloud.com/icon/hash_d72c39716b456bb647a1cfe01942656bd25dfcdd0faaa147dcce337589b75a8a</string>
|
||||
<key>label</key>
|
||||
<string>BBEdit</string>
|
||||
<key>policy</key>
|
||||
<string>install_bbedit</string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>icon</key>
|
||||
<string>symbol:app.badge</string>
|
||||
<key>label</key>
|
||||
<string>Jamf Protect</string>
|
||||
<key>timeout</key>
|
||||
<integer>600</integer>
|
||||
<key>watchPath</key>
|
||||
<string>/Applications/JamfProtect.app</string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>label</key>
|
||||
<dict>
|
||||
<key>de</key>
|
||||
<string>Eingaben übermitteln</string>
|
||||
<key>en</key>
|
||||
<string>Submit User Entry</string>
|
||||
<key>fr</key>
|
||||
<string>Soumettre les entrées</string>
|
||||
<key>nl</key>
|
||||
<string>Voer invoer in</string>
|
||||
</dict>
|
||||
<key>waitForUserEntry</key>
|
||||
<string></string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>icon</key>
|
||||
<string>symbol:plus.app</string>
|
||||
<key>label</key>
|
||||
<dict>
|
||||
<key>de</key>
|
||||
<string>Extra Apps für %department%</string>
|
||||
<key>en</key>
|
||||
<string>Extra Apps for %department%</string>
|
||||
<key>fr</key>
|
||||
<string>Extra Apps pour %department%</string>
|
||||
<key>nl</key>
|
||||
<string>Extra Apps voor %department%</string>
|
||||
</dict>
|
||||
<key>policy</key>
|
||||
<string>install_extra_apps</string>
|
||||
</dict>
|
||||
</array>
|
||||
<key>finalCountdown</key>
|
||||
<integer>30</integer>
|
||||
<key>icon</key>
|
||||
<string>name:AppIcon</string>
|
||||
<key>jssID</key>
|
||||
<string>$JSSID</string>
|
||||
<key>message</key>
|
||||
<dict>
|
||||
<key>de</key>
|
||||
<string>Bitte etwas Geduld während Setup Manager deinen neuen Mac konfiguriert.</string>
|
||||
<key>en</key>
|
||||
<string>Please be patient while Setup Manager configures your new Mac.</string>
|
||||
<key>es</key>
|
||||
<string>Por favor espere mientras Setup Manager configura tu nuevo Mac.</string>
|
||||
<key>fr</key>
|
||||
<string>Veuillez être patient pendant que Setup Manager configure votre nouveau Mac.</string>
|
||||
<key>he</key>
|
||||
<string>אנא התאזר בסבלנות בזמן ש-Setup Manager מגדיר את ה-Mac החדש שלך</string>
|
||||
<key>it</key>
|
||||
<string>Sii paziente mentre Setup Manager configura il tuo nuovo Mac.</string>
|
||||
<key>nl</key>
|
||||
<string>Even geduld terwijl Setup Manager je nieuwe Mac configureert.</string>
|
||||
</dict>
|
||||
<key>title</key>
|
||||
<dict>
|
||||
<key>de</key>
|
||||
<string>Willkommen!</string>
|
||||
<key>en</key>
|
||||
<string>Welcome!</string>
|
||||
<key>es</key>
|
||||
<string>¡Bienvenido!</string>
|
||||
<key>fr</key>
|
||||
<string>Bienvenu!</string>
|
||||
<key>he</key>
|
||||
<string>ברוכים הבאים!</string>
|
||||
<key>it</key>
|
||||
<string>Benvenuto!</string>
|
||||
<key>nl</key>
|
||||
<string>Welcom!</string>
|
||||
</dict>
|
||||
<key>userEntry</key>
|
||||
<dict>
|
||||
<key>department</key>
|
||||
<dict>
|
||||
<key>options</key>
|
||||
<array>
|
||||
<string>Sales</string>
|
||||
<string>Development</string>
|
||||
<string>IT</string>
|
||||
<string>Marketing</string>
|
||||
</array>
|
||||
</dict>
|
||||
</dict>
|
||||
</dict>
|
||||
</plist>
|
||||
@@ -7,17 +7,21 @@
|
||||
export PATH=/usr/bin:/bin:/usr/sbin:/sbin
|
||||
|
||||
# Note:
|
||||
# Setup Manager creates a flag file at
|
||||
# Setup Manager creates flag and data files at
|
||||
#
|
||||
# /private/var/db/.JamfSetupStarted
|
||||
# /private/var/db/.JamfSetupEnrollmentDone
|
||||
# /private/var/db/SetupManagerUserData.txt
|
||||
#
|
||||
# when it completes successfully. This uninstall script
|
||||
# does NOT remove this file. When you re-install Setup
|
||||
# Manager after running this script, the flag file's
|
||||
# existence will suppress the launch of Setup Manager.
|
||||
# This uninstall script does NOT (yet) remove these files.
|
||||
#
|
||||
# Depending on your workflow needs, you may want to
|
||||
# uncomment the last line which removes the flag file.
|
||||
# When you re-install Setup Manager after running this script,
|
||||
# the `.JamfSetupEnrollmentDone` flag file's existence will
|
||||
# suppress the launch of Setup Manager.
|
||||
#
|
||||
# Depending on your workflow needs, you may want to preserve
|
||||
# or remove these files during un-installation. Uncomment the
|
||||
# respective `rm` lines at the end of this script.
|
||||
|
||||
appName="Setup Manager"
|
||||
bundleID="com.jamf.setupmanager"
|
||||
@@ -29,6 +33,11 @@ if [ "$(whoami)" != "root" ]; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if launchctl list | grep -q "$bundleID.finished" ; then
|
||||
echo "unloading launch daemon"
|
||||
launchctl unload /Library/LaunchDaemons/"$bundleID".finished.plist
|
||||
fi
|
||||
|
||||
if launchctl list | grep -q "$bundleID" ; then
|
||||
echo "unloading launch daemon"
|
||||
launchctl unload /Library/LaunchDaemons/"$bundleID".plist
|
||||
@@ -37,7 +46,17 @@ fi
|
||||
echo "removing files"
|
||||
rm -rfv "$appPath"
|
||||
rm -v /Library/LaunchDaemons/"$bundleID".plist
|
||||
rm -v /Library/LaunchAgents/"$bundleID".loginwindow.plist
|
||||
rm -v /Library/LaunchAgents/"$bundleID".finished.plist
|
||||
|
||||
echo "forgetting $bundleID pkg receipt"
|
||||
pkgutil --forget "$bundleID"
|
||||
|
||||
# uncomment depending on which files you need to remove or preserve
|
||||
|
||||
# rm -v /private/var/db/.JamfSetupStarted
|
||||
# rm -v /private/var/db/.JamfSetupEnrollmentDone
|
||||
# rm -v /private/var/db/SetupManagerUserData.txt
|
||||
|
||||
# always exit success regardless of exit code of above commands
|
||||
exit 0
|
||||
|
||||
@@ -1,2 +1 @@
|
||||
Offered under the terms of the [Jamf Concepts Use Agreement](https://resources.jamf.com/documents/jamf-concept-projects-use-agreement.pdf).
|
||||
|
||||
Offered under the terms of the [Jamf Software License and Service Agreement](https://resources.jamf.com/documents/jamf-SLASA.pdf).
|
||||
|
||||
33
README.md
33
README.md
@@ -4,14 +4,14 @@
|
||||
|
||||
_"Every Assistant has a Manager"_
|
||||
|
||||
|
||||
|
||||
|
||||
Updates are published in the '[Releases](https://github.com/jamf-concepts/setup-manager/releases)' section of the repo. There you can also [download the latest pkg installer](https://github.com/jamf-concepts/setup-manager/releases/latest). You can subscribe to notifications for the repo using the 'Watch' button above.
|
||||
|
||||
Please report issues, feature requests [as an issue.](https://github.com/jamf-concepts/setup-manager/issues)
|
||||
|
||||
We have opened the [discussions](https://github.com/jamf-concepts/setup-manager/discussions) area for questions and more generic feedback.
|
||||
|
||||
Updates will be published in the '[Releases](https://github.com/jamf-concepts/setup-manager/releases)' section of the repo. There you can also [download the latest pkg installer](https://github.com/jamf-concepts/setup-manager/releases/latest). You can subscribe to notifications for the repo using the 'Watch' button above.
|
||||
|
||||
There is also a [`#jamf-setup-manager`](https://macadmins.slack.com/archives/C078DDLKRDW) channel on the [MacAdmins Slack](https://macadmins.org).
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ There is also a [`#jamf-setup-manager`](https://macadmins.slack.com/archives/C07
|
||||
|
||||
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 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:
|
||||
|
||||
@@ -30,10 +30,10 @@ Setup Manager provides:
|
||||
- zero-touch (user-driven)
|
||||
- single-touch (tech-driven)
|
||||
- user initiated enrollment
|
||||
- handsfree deployment with auto advance
|
||||
- handsfree deployment with Auto Advance
|
||||
- customized branding
|
||||
- localized interface and custom text
|
||||
- support for Jamf Pro and Jamf School
|
||||
- localized interface and localizable custom text
|
||||
- works with Jamf Pro and Jamf School
|
||||
|
||||
## Installation and Configuration
|
||||
|
||||
@@ -42,27 +42,28 @@ Setup Manager provides:
|
||||
- zero-touch and user-initiated deployments (forthcoming)
|
||||
- [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 auto advance and Setup Manager at login window (forthcoming)
|
||||
- [handsfree deployment with AutoAdvance and Setup Manager at login window (beta)](Docs/JamfPro-LoginWindow.md)
|
||||
- [Jamf School](Docs/JamfSchool-Setup.md)
|
||||
- [Extras and Notes](Extras.md)
|
||||
- [Frequently Asked Questions](FAQ.md)
|
||||
- [Extras and Notes](Docs/Extras.md)
|
||||
- [Frequently Asked Questions](Docs/FAQ.md)
|
||||
- [Webhooks](Docs/Webhooks.md)
|
||||
- [Network Connectivity Checks](Docs/Network.md)
|
||||
|
||||
## Configuration Profile
|
||||
|
||||
The structure of the configuration profile [is documented here](ConfigurationProfile.md).
|
||||
|
||||
There is also a [custom schema for Jamf Pro](Docs/Extras.md#custom-json-schema-for-jamf-pro).
|
||||
|
||||
## Requirements
|
||||
|
||||
Setup Manager requires macOS 12.0.0 or higher. It will work only with Jamf Pro or Jamf School.
|
||||
Setup Manager requires macOS 13.5 or higher. It will work only with Jamf Pro or Jamf School.
|
||||
|
||||
## Known Issues
|
||||
|
||||
- Setup Manager will **_not_** launch at enrollment with Auto-Advance enabled, use the option to run at login window
|
||||
- Setup Manager may **_not_** launch or launch and quit quickly when you disable _all_ Setup Assistant screens, leave at least one Setup Assistant option enabled
|
||||
- When you install **_Jamf Connect_** during the Prestage together with Setup Manager, you may see Setup Assistant for some time before Setup Manager launches or Setup Manager may not launch at all. Remove Jamf Connect from the Prestage and install it with Setup Manager policy or installomator action.
|
||||
- Policies that are triggered by `enrollmentComplete` may disrupt Setup Manager running from Prestage/Automated Device Enrollment. Disable or unscope policies triggered by `enrollmentComplete` on devices using Setup Manager.
|
||||
- In some deployments, Setup Manager attempts to start while Jamf Pro is still installing. Try adding a 30-60 second `wait` action as the first action. We are working on a solution.
|
||||
- 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.
|
||||
- Setup Manager may **_not_** launch or launch and quit quickly when you disable _all_ Setup Assistant screens and skip user creation, leave at least one Setup Assistant option that shows _before_ the user creation enabled, or use the option to run at login window
|
||||
- Policies that are triggered by `enrollmentComplete` may delay or even disrupt Setup Manager running from Prestage/Automated Device Enrollment. Disable or un-scope policies triggered by `enrollmentComplete` on devices using Setup Manager.
|
||||
|
||||
---
|
||||
|
||||
|
||||
9
catalog-info.yaml
Normal file
9
catalog-info.yaml
Normal file
@@ -0,0 +1,9 @@
|
||||
apiVersion: backstage.io/v1alpha1
|
||||
kind: Component
|
||||
metadata:
|
||||
name: setup-manager
|
||||
spec:
|
||||
type: application
|
||||
lifecycle: production
|
||||
owner: concepts
|
||||
system: jamf-concept-projects
|
||||
Reference in New Issue
Block a user