mirror of
https://github.com/jamf/Setup-Manager.git
synced 2026-02-03 14:13:24 +00:00
Compare commits
23 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
d9ec69df04 | ||
|
|
0eb0916a2f | ||
|
|
c5d5798f4e | ||
|
|
97f11bab6b | ||
|
|
675469b197 | ||
|
|
d3cec3276e | ||
|
|
6645a7a926 | ||
|
|
d1d7b1f569 | ||
|
|
960c06c5a5 | ||
|
|
c2fcc38faf | ||
|
|
d71f2ca6f1 | ||
|
|
8623f85487 | ||
|
|
e3d908747a | ||
|
|
52ee0e0e2a | ||
|
|
0e4961a42a | ||
|
|
4aabab6033 | ||
|
|
475f8e013a | ||
|
|
08b36bf6ed | ||
|
|
246372c4a4 | ||
|
|
dc233bb393 | ||
|
|
f68ce643da | ||
|
|
44742d97c9 | ||
|
|
7c509ccc60 |
125
ChangeLog.md
125
ChangeLog.md
@@ -1,5 +1,124 @@
|
||||
# Setup Manager - Change Log
|
||||
|
||||
v1.2beta2
|
||||
(2025-02-26)
|
||||
|
||||
### 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
|
||||
- (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)
|
||||
|
||||
### New Features
|
||||
|
||||
- new action [`waitForUserEntry`](ConfigurationProfile.md#waitforuserentry) 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. (#11)
|
||||
- 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 in the profile to determine when Setup Manager runs (#18)
|
||||
- data from user entry, is now written to a file when Setup Manager submits data. See details in [User Entry](Extras.md#user-data-file) (#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 in the configuration profile has been simplified. The previous method still works, but is considered deprecated. [Details](ConfigurationProfile.md#localization)
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- 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 (#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
|
||||
|
||||
## v1.0
|
||||
(2024-07-01)
|
||||
|
||||
@@ -69,8 +188,8 @@
|
||||
- main `icon` now properly displays wide aspect images
|
||||
- watchPath actions time faster in DEBUG mode
|
||||
- unloads Jamf Pro background check-in during workflow
|
||||
- About this Mac…
|
||||
- downloand speed (measured with `networkQuality`) and esitmated download time
|
||||
- About this Mac…
|
||||
- Download speed (measured with `networkQuality`) and estimated download time
|
||||
- Jamf Pro version
|
||||
- new preference keys (see [config profile documentation for details](ConfigurationProfile.md))
|
||||
- `accentColor`
|
||||
@@ -92,7 +211,7 @@
|
||||
- added macOS Sonoma to list of known macOS releases
|
||||
- added documentation for Jamf School
|
||||
- added changelog and some more updates to documentation
|
||||
- computer name can now be generated wihtout UI from a template
|
||||
- computer name can now be generated without UI from a template
|
||||
- added slight scale animation and edge fade to action list
|
||||
- user entry fields can now be validated with a regular expression and localized message
|
||||
- battery widget now display correctly on Macs without a battery
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
# Configuration Profile format
|
||||
|
||||
The project includes a [custom profile plist](sample-com.jamf.setupmanager.plist) for Jamf Pro and [an example configuration profile](sample-jamfschool.mobileconfig) for Jamf School.
|
||||
The project some sample files to get you started:
|
||||
- [sample plist](Examples/sample-com.jamf.setupmanager.plist) for Jamf Pro
|
||||
- [sample plist](Examples/sample-waitForUserEntry.plist) for Jamf Pro with [two phase workflow](Docs/JamfPro-TwoPhase.md)
|
||||
- [configuration profile](Examples/sample-jamfschool.mobileconfig) for Jamf School
|
||||
|
||||
|
||||
## Top-level keys
|
||||
|
||||
@@ -8,53 +12,92 @@ The project includes a [custom profile plist](sample-com.jamf.setupmanager.plist
|
||||
|
||||
(Boolean, default: `false`)
|
||||
|
||||
When this is set to `true` any steps that actually change software on the disk will not be performed.
|
||||
When this is set to `true` any steps that actually change software on the disk will not be performed. This will also allow you to launch Setup Manager by double-clicking as the user. This can be useful to test a profile, or to take screenshots for documentation.
|
||||
|
||||
These behaviors change in debug mode:
|
||||
- checks for the existence of the Jamf binary and keychain are skipped
|
||||
- Jamf Setup manager will accept enrollmentActions from a non-managed preference file
|
||||
- `policy`, `recon`, and `shell` actions that require root are replaced with a 10 second delay (and will always complete successfully)
|
||||
- watchPath and wait actions timeout and fail after 10 seconds
|
||||
- Jamf Setup Manager will accept enrollmentActions from a non-managed preference file
|
||||
- `policy`, `recon`, and `shell` actions that require root are replaced with a delay (and will always complete successfully)
|
||||
- `watchPath` and `wait` actions timeout and fail after 10 seconds
|
||||
|
||||
When in debug mode, you have to set the `simulateMDM` preference key to `Jamf Pro` or `Jamf School`. This allows you to do test runs on un-enrolled Macs.
|
||||
When in debug mode, you can also set the `simulateMDM` preference key to `Jamf Pro` or `Jamf School`. This allows you to do test runs on un-enrolled Macs.
|
||||
|
||||
#### `title`
|
||||
|
||||
(String, default: `Welcome to Setup Manager`, localized)
|
||||
(String, default: `Welcome to Setup Manager`, localized, substitutions)
|
||||
|
||||
The main title over the window.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>title</key>
|
||||
<string>Welcome to your new Mac!</string>
|
||||
```
|
||||
|
||||
#### `icon`
|
||||
|
||||
(String, default: `name:AppIcon`, localized)
|
||||
(String, default: `name:AppIcon`, localized, dark mode)
|
||||
|
||||
The icon shown at the top center of the window. There are many options to define icons, described in the [Icon Sources](#icon-sources) section later.
|
||||
The icon shown at the top center of the window. There are many options to define icons, described in the [Icon Sources](#icon-sources) section later. Images will be scaled to fit a size of 700x128 pixels (or 1400x256 @2x).
|
||||
|
||||
#### `message`
|
||||
|
||||
(String, default: `Setup Manager is configuring your Mac…`, localized)
|
||||
(String, default: `Setup Manager is configuring your Mac…`, localized, substitutions, markdown)
|
||||
|
||||
The message shown below the title.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>message</key>
|
||||
<string>Please wait a few moments while we install essential software…</string>
|
||||
```
|
||||
|
||||
The message can use [substitutions](#substitution).
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<key>message</key>
|
||||
<string>Preparing your new %model%. Please be patient.</string>
|
||||
```
|
||||
|
||||
Markdown formatting options in the message field will be translated into rich text:
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<key>message</key>
|
||||
<string>Preparing your new %model%. **Please be patient.**</string>
|
||||
```
|
||||
|
||||
`Please be patient.` will be bold. More detail on [Markdown here](#markdown).
|
||||
|
||||
#### `background`
|
||||
|
||||
(String, optional, localized)
|
||||
(String, optional, localized, dark mode)
|
||||
|
||||
When this key is set, Setup Manager treats it as an image/[icon source](#icon-source) and displays the image in a screen covering background.
|
||||
When this key is set, Setup Manager treats it as an image/[icon source](#icon-sources) and displays the image in a screen covering background.
|
||||
|
||||
#### `runAt`
|
||||
|
||||
(String, optional, default: `enrollment`)
|
||||
|
||||
**Beta:** We believe the run at login window feature may require more testing, especially in some edge cases. When, after thorough testing, you believe this works in your workflow, feel free to deploy it, and please let us know about your success or any issues you might encounter.
|
||||
|
||||
This value determines when Setup Manager should launch. There are two values: `enrollment` (default) and `loginwindow`. When set to `enrollment` Setup Manager will launch immediately when the pkg is installed. This is the setting to use for automated device enrollment (without Auto Advance) and user-initiated enrollment.
|
||||
|
||||
When the `runAt` value is set to `loginwindow` Setup Manager will launch only when the login window is shown. This is useful for fully automated enrollments using Auto Advance.
|
||||
|
||||
A setting of `loginwindow` will only work with enrollment setups that eventually end on the login window (i.e. a user has to be created automatically, the device is bound to a directory, etc).
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<key>runAt</key>
|
||||
<string>loginwindow</string>
|
||||
```
|
||||
|
||||
#### `enrollmentActions`
|
||||
|
||||
@@ -72,28 +115,51 @@ When this key exists, Setup Manager will prompt for user data while the enrollme
|
||||
|
||||
(Dict of Strings, optional)
|
||||
|
||||
When this key exists, Setup Manager will show a "Help" button (a circled question mark) in the lower right corner while it is running. You can add subkeys with content for the help, which are described in [Help](#help). When Setup Manager has completed, the "Help" button will be replaced with the "Continue" and/or "Shutdown" button.
|
||||
When this key exists, Setup Manager will show a "Help" button (a circled question mark) in the lower right corner while it is running. You can add sub-keys with content for the help, which are described in [Help](#help). When Setup Manager has completed, the "Help" button will be replaced with the "Continue" and/or "Shutdown" button.
|
||||
|
||||
#### `accentColor`
|
||||
|
||||
(String, optional, default: system blue)
|
||||
(String or Dict, optional, default: system blue, dark mode)
|
||||
|
||||
When present sets the accent color for buttons, progress bar and other UI elements. You can use this to match branding. Color is encoded as a six digit hex code, i.e. `#FF0088`.
|
||||
Sets the accent color for buttons, progress bar, SF Symbol icons, and other UI elements. You can use this to match branding. Color is encoded as a six digit hex code, e.g. `#FF0088`.
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<key>accentColor</key>
|
||||
<string>#FF00AA</string>
|
||||
```
|
||||
|
||||
If you want different accent colors depending on whether the system is in light or dark mode, provide a `dict` with two keys, for `light` and `dark` mode:
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<key>accentColor</key>
|
||||
<dict>
|
||||
<key>dark</key>
|
||||
<string>#FF00AA</string>
|
||||
<key>light</key>
|
||||
<string>#AA0055</string>
|
||||
</dict>
|
||||
```
|
||||
|
||||
#### `finalCountdown`
|
||||
|
||||
(Number/integer, optional, default: `60`)
|
||||
|
||||
This key changes the duration (in seconds) of the "final countdown" before the app automatically quits. Set to `-1` (or any negative number) to disable automated continue.
|
||||
This key changes the duration (in seconds) of the "final countdown" before the app automatically performs the `finalAction` (continue or shut down). Set to `-1` (or any negative number) to disable automated execution.
|
||||
|
||||
Examples:
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>finalCountdown</key>
|
||||
<integer>30</integer>
|
||||
```
|
||||
|
||||
```
|
||||
Disable the countdown:
|
||||
|
||||
```xml
|
||||
<key>finalCountdown</key>
|
||||
<integer>-1</integer>
|
||||
```
|
||||
@@ -102,35 +168,35 @@ Examples:
|
||||
|
||||
(String, optional, default: `continue`)
|
||||
|
||||
This key sets the action and label for the button shown when Setup Manger has completed. When this key is set to `shutdown` (no space!) it will shutdown the computer, other wise it will just quit Setup Manager ("continue"). This is also the action that is performed when the `finalCountdown` timer runs out.
|
||||
This key sets the action and label for the button shown when Setup Manger has completed.
|
||||
|
||||
There are three options:
|
||||
- `continue`: (default) merely quits Setup Manager and allows the user to continue (probably Setup Assistant or login window)
|
||||
- `restart`: restarts the Mac
|
||||
- `shut down`: (no space!) shuts down the Mac
|
||||
|
||||
**Warning:** `restart` and `shutdown` options will force their action immediately. If a user is logged in (after user-initiated enrollment), they may lose data from open, unsaved documents.
|
||||
|
||||
This is also the action that is performed when the `finalCountdown` timer runs out.
|
||||
|
||||
When the `DEBUG` preference is set, `shutdown` or `restart` will merely quit/continue.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>finalAction</key>
|
||||
<string>shutdown</string>
|
||||
```
|
||||
|
||||
#### `showBothButtons`
|
||||
#### `totalDownloadBytes`
|
||||
|
||||
(Bool, optional default: `false`)
|
||||
|
||||
This key determines whether both the 'Shutdown' and 'Continue' are shown or just the button set in the `finalAction` key.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
<key>showBothButtons</key>
|
||||
<true/>
|
||||
```
|
||||
|
||||
#### `totalDownloadBytes` : (Integer, opitonal, default: 1000000000 or 1GB, v0.8)
|
||||
(Integer, opitonal, default: 1000000000 or 1GB, v0.8)
|
||||
|
||||
Use this value to provide an estimate for the total size of all items that will be downloaded. Setup Manager will display and estimated download time for this sum in the "About this Mac..." popup window.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>totalDownloadBytes</key>
|
||||
<integer>4500000000</integer>
|
||||
```
|
||||
@@ -139,11 +205,11 @@ Example:
|
||||
|
||||
(String, Jamf Pro only)
|
||||
|
||||
Set this to `$JSSID` in the configuration profile and Setup Manager will be aware of its computer's id in Jamf Pro. It will be display in the 'About this Mac…' popup.
|
||||
Set this to `$JSSID` in the configuration profile and Setup Manager will be aware of its computer's id in Jamf Pro. It will be displayed in the 'About this Mac…' popup, when clicked with the option key.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>jssID</key>
|
||||
<string>$JSSID</string>
|
||||
```
|
||||
@@ -156,72 +222,74 @@ Set this to `$EMAIL` in the configuration profile. This communicates the user wh
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>userID</key>
|
||||
<string>$EMAIL</string>
|
||||
```
|
||||
|
||||
#### `computerNameTemplate`
|
||||
|
||||
(String, Jamf Pro only)
|
||||
(String, Jamf Pro only, substitutions)
|
||||
|
||||
When this key is set, Setup Manager will generate the computer name from this template and set it. When this key is present, a `computerName` dict or string in `userEntry` will be ignored.
|
||||
When this key is set, Setup Manager will generate the computer name from this template and set it automatically. When this key is present, a `computerName` dict or string in `userEntry` will be ignored.
|
||||
|
||||
The template uses tokens, which begin and end with `%` character. The tokens will be replaced with data from the device or from user entry. For example, in the template `Mac-%serial%` the `%serial%` token will be replaced with the computer's serial number. (A double `%%` will be substituted with a single `%`, in case you need to represent this symbol in the computer name.)
|
||||
|
||||
The following tokens are available:
|
||||
|
||||
- `serial`: the computer's serial number
|
||||
- `udid`: the computer's provisioning udid
|
||||
- `model`: the computer's model name, e.g. `MacBook Air` or `Mac mini`
|
||||
- `model-short`: the first word of `model` (no spaces), i.e. `MacBook`, `Mac` or `iMac`
|
||||
- these values from user entry: `email`, `assetTag`, `building`, `department`, `room`
|
||||
|
||||
If the value for a token cannot be retrieved or is empty, it will be substituted with `%%%` (three percentage signs).
|
||||
|
||||
You can add a `:n` (where `n` is an integer number) to a token. This will substitute only the first `n` characters of the string. For example `%serial:5%` will be substituted with the first 5 characters of the serial number. When `n` is negative, it will substitute the _last_ `n` characters. For example, `%udid:-8%` will substitute the last eight characters of the udid.
|
||||
The template uses substitution tokens, which begin and end with `%` character which will be substituted with data at run time. See [Substitutions](#substitution) for details.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>computerNameTemplate</key>
|
||||
<string>Mac-%serial:-6%</string>
|
||||
<string>Mac-%serial:=6%</string>
|
||||
```
|
||||
|
||||
This will set the computer name to `Mac-ABC123` where `ABC123` is the last six characters of the serial number
|
||||
This will set the computer name to `Mac-DEF456` where `DEF456` are the center six characters of the serial number
|
||||
|
||||
#### `overrideSerialNumber`
|
||||
|
||||
(String, optional)
|
||||
|
||||
When set, the "About this Mac" info window will show this value instead of the real serial number. This is useful when making screen shots or recordings for documentation or presentations where you do not want to expose real serial numbers.
|
||||
When set, the "About this Mac" info window will show this value instead of the real serial number. This is useful when making screenshots or recordings for documentation or presentations where you do not want to expose real serial numbers.
|
||||
|
||||
Note: This is for display only. [Substitutions](#substitution) will still use the real serial number.
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<key>overrideSerialNumber</key>
|
||||
<string>ABC1DEFABC</string>
|
||||
```
|
||||
|
||||
#### `hideActionLabels`
|
||||
|
||||
(Bool, default: `false`)
|
||||
(Bool, optional, default: `false`)
|
||||
|
||||
Hides the individual labels under each action's icon.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>hideActionLabels</key>
|
||||
<true/>
|
||||
```
|
||||
|
||||
#### `hideDebugLabel`
|
||||
|
||||
(Bool, default: `false`)
|
||||
(Bool, optional, default: `false`)
|
||||
|
||||
When set, suppresses display of the red 'DEBUG' label in debug mode. Useful for screenshots and recordings.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
<key>hideDebugLabel</key>
|
||||
<true/>
|
||||
<key>hideDebugLabel</key>
|
||||
<true/>
|
||||
```
|
||||
|
||||
#### `simulateMDM`
|
||||
|
||||
(String, optional)
|
||||
|
||||
When debug mode is enabled, you can set the `simulateMDM` preference key to `Jamf Pro` or `Jamf School`. This allows you to do test runs on un-enrolled Macs.
|
||||
|
||||
## Actions
|
||||
|
||||
@@ -229,15 +297,15 @@ All actions should have these keys:
|
||||
|
||||
#### `label`
|
||||
|
||||
(String, required, localized)
|
||||
(String, required, localized, substitutions)
|
||||
|
||||
The label is used as the name of the action in display.
|
||||
|
||||
#### `icon`
|
||||
|
||||
(String, optional, localized)
|
||||
(String, optional, localized, dark mode)
|
||||
|
||||
The icon source string used for the display of the label. Different types of actions will have different default icons, which is used when no `icon` key is present.
|
||||
The [icon source](#icon-sources) used for the display of the label. Different types of actions will have different default icons, which are used when no `icon` key is present. The icons will be scaled to fit 64x64 pixels (or 128x128 @2x).
|
||||
|
||||
There are several different types of actions, and these are defined by additional keys. These keys will be on the same level as the keys above.
|
||||
|
||||
@@ -259,11 +327,11 @@ When the command given in `shell` requires arguments they are listed here, one i
|
||||
|
||||
(Bool, default: `false`, optional)
|
||||
|
||||
When this key is set to `true` Setup Manager will only run this when itself is running as root. Otherwise it will fail the action. When `DEBUG` is enabled, it will replace the action with a delay instead.
|
||||
When this key is set to `true`, Setup Manager will only run this when itself is running as root. Otherwise, it will fail the action. When `DEBUG` is enabled, it will replace the action with a delay instead.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<dict>
|
||||
<key>label</key>
|
||||
<string>Set Time Zone</string>
|
||||
@@ -285,15 +353,19 @@ Example:
|
||||
|
||||
#### `policy`
|
||||
|
||||
(String)
|
||||
(String, Jamf Pro only)
|
||||
|
||||
(Jamf Pro only)
|
||||
This will run the Jamf Pro policy or polices with the given trigger name. This is the equivalent of running
|
||||
|
||||
This will run the jamf policy or polices with the given trigger name. This is the equivalent of running `jamf policy -event <triggername>`
|
||||
```
|
||||
jamf policy -event <triggername> -verbose -forceNoRecon -doNotRestart -noInteraction
|
||||
```
|
||||
|
||||
Note: Jamf Pro policies can do a lot of different things and fail in many different ways. Setup Manager does _not_ check for all possible failure modes. It only checks for failed installer pkgs and policy scripts that return non-zero exit codes, which should cover most uses of policies for initial deployment.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<dict>
|
||||
<key>label</key>
|
||||
<string>BBEdit</string>
|
||||
@@ -326,7 +398,7 @@ The action will fail after this timeout.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<dict>
|
||||
<key>label</key>
|
||||
<string>Jamf Protect</string>
|
||||
@@ -334,12 +406,12 @@ Example:
|
||||
<string>symbol:app.badge</string>
|
||||
<key>watchPath</key>
|
||||
<string>/Applications/JamfProtect.app</string>
|
||||
<key>wait</key>
|
||||
<key>timeout</key>
|
||||
<integer>300</integer>
|
||||
</dict>
|
||||
```
|
||||
|
||||
Note: This is intended to check if app are installed from the Mac App Store or Jamf App Installers. In my experience, these methods are very unreliable, hence the timeout. Since you cannot anticipate the order in which these apps may be installed, it is best to put the `watchPath` actions at the end. For large installations (Xcode) you want to have a large timeout.
|
||||
Note: This is intended to check if an app is installed from the Mac App Store or by Jamf App Installers. In my experience, these installation methods are quite unreliable during enrollment, hence the timeout. Since you cannot anticipate the order in which these apps may be installed, it is best to put the `watchPath` actions at the end. For large installations, such as Xcode, or Adobe apps, you want to set a large timeout.
|
||||
|
||||
### Wait
|
||||
|
||||
@@ -351,7 +423,7 @@ Wait for a given time. Use this to let the system catch up with previous install
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<dict>
|
||||
<key>label</key>
|
||||
<string>Waiting…</string>
|
||||
@@ -360,6 +432,28 @@ Example:
|
||||
</dict>
|
||||
```
|
||||
|
||||
### Wait for User Entry
|
||||
|
||||
#### `waitForUserEntry`
|
||||
|
||||
(String, value is ignored, Jamf Pro only)
|
||||
|
||||
If Setup Manager reaches this action before the user entry has been completed, it will wait until the user entry is completed and the user has clicked 'Save.'
|
||||
|
||||
When the user entry is saved and this action is reached, it will set the computer name, according to the `computerNameTemplate` or what was entered by the user and run a recon/Update Inventory which submits the user data. It will also save the data from the user entry to the [user data file](Docs/Extras.md#user-data-file).
|
||||
|
||||
This action allows for "two phase" installation workflows where the policies in the second phase are scoped to data from the user entry. After this action, smart groups in Jamf Pro should reflect the data entered and you can use scoping in subsequent policies to choose which policies should or should not run on this device.
|
||||
|
||||
Regardless of whether there is a `waitForUserEntry` action or not, Setup Manager will submit the user data and run a recon/Update Inventory after all actions are finished.
|
||||
|
||||
```xml
|
||||
<dict>
|
||||
<key>label</key>
|
||||
<string>Submit User Entry</string>
|
||||
<key>waitForUserEntry</key>
|
||||
<string/>
|
||||
</dict>
|
||||
```
|
||||
|
||||
### Jamf Inventory Update (recon)
|
||||
|
||||
@@ -369,11 +463,11 @@ Example:
|
||||
|
||||
This will run a Jamf Inventory update.
|
||||
|
||||
You should usually not need to add a recon step. By default Setup Manager will automatically run an inventory update before and after running the enrollment actions.
|
||||
This action exists mainly for troubleshooting. You should generally not need to add a recon step. By default, Setup Manager will automatically run an inventory update before and after running the enrollment actions. If you have a `waitForUserEntry` action configured, this will also run a recon/inventory update.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<dict>
|
||||
<key>recon</key>
|
||||
<string/>
|
||||
@@ -382,7 +476,7 @@ Example:
|
||||
|
||||
### Installomator
|
||||
|
||||
This will run Installomator to install a given label.
|
||||
This will run [Installomator](https://github.com/Installomator/Installomator) to install a given label.
|
||||
|
||||
Note: by default, Setup manager will add `NOTIFY=silent` to the arguments to suppress notfications. You can override this in the `arguments`.
|
||||
|
||||
@@ -400,7 +494,7 @@ List of additional arguments passed into Installomator.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<dict>
|
||||
<key>label</key>
|
||||
<string>Google Chrome</string>
|
||||
@@ -414,13 +508,13 @@ Example:
|
||||
|
||||
## Icon Sources
|
||||
|
||||
Icons can be defined in several ways in Setup Manager. These different approaches for the top-level `icon` and `background` key, as well as the `icon` key in an action.
|
||||
Icons (which include the top-level `icon`, the `background` and the `icon`s in individual actions) can be defined in several ways in Setup Manager.
|
||||
|
||||
### From the web
|
||||
|
||||
When the icon source string starts with `http` or `https`, Setup Manager will attempt to download a file from that URL and interpret it as an image file. It will show a spinning progress view while downloading.
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>icon</key>
|
||||
<string>https://example.com/path/to/icon.png</string>
|
||||
```
|
||||
@@ -429,16 +523,20 @@ When the icon source string starts with `http` or `https`, Setup Manager will at
|
||||
|
||||
When the icon source is an absolute file path, Setup Manager will attempt to read that file as an image file and display it.
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>icon</key>
|
||||
<string>/Library/Organization/image.png</string>
|
||||
```
|
||||
|
||||
You will need to install custom local image files _before_ Setup Manager runs.
|
||||
|
||||
With Jamf Pro, you can achieve that by adding another pkg to the Prestage. Since the Prestage installs pkgs in alphabetical order, this branding pkg should be named to be alphabetically _before_ "Setup Manager."
|
||||
|
||||
### Application:
|
||||
|
||||
When the icon source is an absolute file path that ends in `.app`, Setup Manager will get the icon from that app.
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>icon</key>
|
||||
<string>/System/Applications/App Store.app</string>
|
||||
```
|
||||
@@ -447,27 +545,53 @@ When the icon source is an absolute file path that ends in `.app`, Setup Manager
|
||||
|
||||
When the icon source starts with `name:`, Setup Manager will get the icon with that name. Two names are useful: `AppIcon` gets Setup Manager's app icon and `NSComputer` will get an icon representing the current hardware.
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>icon</key>
|
||||
<string>name:AppIcon</string>
|
||||
```
|
||||
|
||||
### SF Symbols:
|
||||
|
||||
When the icon source starts with `symbol:`, Setup Manager will create the icon using that symbols name. You can look up symbol names using the [SF Symbols app](https://developer.apple.com/sf-symbols/).
|
||||
When the icon source starts with `symbol:`, Setup Manager will create the icon using that symbol's name. You can look up symbol names using the [SF Symbols](https://developer.apple.com/sf-symbols/) app.
|
||||
|
||||
Note that the availability of SF Symbols will vary with the OS version and that some SF Symbols may look different in different localizations.
|
||||
Note that the availability and appearance of SF Symbols may vary with the OS version and language/region.
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>icon</key>
|
||||
<string>symbol:clock</string>
|
||||
```
|
||||
|
||||
### Dark Mode
|
||||
|
||||
Note: after enrollment, over Setup Assistant, the system is always in light mode. This is only relevant when you use Setup Manager after user-initiated enrollment
|
||||
|
||||
To provide alternative images for dark or light mode, change the `string` defining the image to a dictionary with a `dark` and a `light` key. This works with the `background`, `icon`, and each action's `icon`. This also works with the `accentColor` key.
|
||||
|
||||
Note that Setup Manager does _not_ monitor the appearance mode, so if it changes _while_ Setup Manager is running, things will not update consistently.
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<key>icon</key>
|
||||
<dict>
|
||||
<key>dark</key>
|
||||
<string>name:Jamf_white</string>
|
||||
<key>light</key>
|
||||
<string>name:Jamf_blue</string>
|
||||
</dict>
|
||||
```
|
||||
|
||||
|
||||
## User Entry
|
||||
|
||||
You can enable user entry for the following keys:
|
||||
|
||||
- `userID`
|
||||
- `email`
|
||||
- `endUsername` (shown as 'Account Name')
|
||||
- `realname` (shown as 'Full Name')
|
||||
- `position`
|
||||
- `phone`
|
||||
- `department`
|
||||
- `building`
|
||||
- `room`
|
||||
@@ -476,15 +600,22 @@ You can enable user entry for the following keys:
|
||||
|
||||
Any of the fields will only be shown when its key exists. If you were to create an empty `userEntry` dict, you get an empty user input screen with a 'Save' button - not a good user experience.
|
||||
|
||||
`userID` and `email` can be somewhat confusing and depending on which Cloud directory you have configured in Jamf Pro, you may need one or the other or both. Because of this Setup Manager 1.1 and older would only prompt for 'User email' and set both `userID` and `email` from that value. To maintain compatibility with this behavior, Setup Manager will continue to set _both_ `userID` and `email` when only one of the two values is requested and entered. If you request both fields, both will be set individually in the recon.
|
||||
|
||||
|
||||
### User Data file
|
||||
|
||||
Data from user entry is written, together with some other data to a file when Setup Manager reaches a `waitForUserEntry` action and again when it finishes. The file is stored at `/private/var/db/SetupManagerUserData.txt`. [More details.](Docs/Extras.md#user-data-file)
|
||||
|
||||
#### `default`
|
||||
|
||||
(String, localized)
|
||||
|
||||
You provide a default value in two ways:
|
||||
Provide a default value in one of two ways:
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>computerName</key>
|
||||
<string>Mac-12345</string>
|
||||
```
|
||||
@@ -495,23 +626,13 @@ When you want to configure other options of the field, you need to use the `dict
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>computerName</key>
|
||||
<dict>
|
||||
<key>default</key>
|
||||
<string>ABC12345</string>
|
||||
</dict>
|
||||
```
|
||||
|
||||
With the second, longer form you can have different default values per [localization](#localization).
|
||||
|
||||
```
|
||||
<key>computerName</key>
|
||||
<dict>
|
||||
<key>default</key>
|
||||
<string>Device-12345</string>
|
||||
<key>default.de</key>
|
||||
<string>Gerät-12345</string>
|
||||
<key>validation</key>
|
||||
<string>[A-Z]{3}\d{5}</string>
|
||||
</dict>
|
||||
```
|
||||
|
||||
@@ -522,7 +643,7 @@ With the second, longer form you can have different default values per [localiza
|
||||
|
||||
This will show the string value given as a greyed out placeholder in the empty text field.
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>assetTag</key>
|
||||
<dict>
|
||||
<key>placeholder</key>
|
||||
@@ -538,7 +659,7 @@ Note: a `default` value will prevent the placeholder from appearing, unless the
|
||||
|
||||
This will show a popup list of preset options:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>department</key>
|
||||
<dict>
|
||||
<key>options</key>
|
||||
@@ -571,7 +692,7 @@ Detailed description of the regular expression syntax: [NSRegularExpression](htt
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>userID</key>
|
||||
<dict>
|
||||
<key>placeholder</key>
|
||||
@@ -585,9 +706,9 @@ Example:
|
||||
|
||||
(String, optional, localized)
|
||||
|
||||
The default validation message will show the regular expression the value is not matching. This is suitable for debugging but not at all user friendly. You really should provide a localized message explaining how the value can conform.
|
||||
The default validation message will show the regular expression the value is not matching. This is suitable for debugging but not at all user friendly. You really should provide a localized message explaining how the entry should conform.
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>assetTag</key>
|
||||
<dict>
|
||||
<key>placeholder</key>
|
||||
@@ -595,21 +716,50 @@ The default validation message will show the regular expression the value is not
|
||||
<key>validation</key>
|
||||
<string>[A-Z]{3}\d{5}</string>
|
||||
<key>validationMessage</key>
|
||||
<string>Asset Tag needs to be of format 'ABC12345'</string>
|
||||
<key>validationMessage.de</key>
|
||||
<string>Etikett Nummer muss im Format 'ABC12345' sein</string>
|
||||
<key>validationMessage.fr</key>
|
||||
<string>L'étiquette d'actif doit être au format 'ABC12345'</string>
|
||||
<key>validationMessage.nl</key>
|
||||
<string>Asset Tag moet het formaat 'ABC12345' hebben</string>
|
||||
<dict>
|
||||
<key>en</key>
|
||||
<string>Asset Tag needs to be of format 'ABC12345'</string>
|
||||
<key>de</key>
|
||||
<string>Etikett Nummer muss im Format 'ABC12345' sein</string>
|
||||
<key>fr</key>
|
||||
<string>L'étiquette d'actif doit être au format 'ABC12345'</string>
|
||||
<key>nl</key>
|
||||
<string>Asset Tag moet het formaat 'ABC12345' hebben</string>
|
||||
</dict>
|
||||
</dict>
|
||||
```
|
||||
|
||||
#### `label`
|
||||
|
||||
(String, localized, optional)
|
||||
|
||||
Many Jamf Pro admins use the standard fields in ways that don't match their built-in label. For this purpose you can override the default label shown for a field in the user entry.
|
||||
|
||||
Note that the text label in the [User Data file](Docs/Extras.md#user-data-file) will _not_ be changed.
|
||||
|
||||
Example:
|
||||
|
||||
```xml
|
||||
<key>room</key>
|
||||
<dict>
|
||||
<key>label</key>
|
||||
<string>Site</string>
|
||||
<key>options</key>
|
||||
<array>
|
||||
<string>London</string>
|
||||
<string>Paris</string>
|
||||
<string>Amsterdam</string>
|
||||
</array>
|
||||
</dict>
|
||||
```
|
||||
|
||||
In this example, the 'Room' field will be shown in Setup Manager with the label 'Site.' The choice will be submitted to the 'room' field in Jamf Pro inventory and written with the 'room' label to the [User data file](Docs/Extras.md#user-data-file). You can then pick up the data in policy scripts after Setup Manager is finished or the `waitForUserEntry` action and process it accordingly.
|
||||
|
||||
### Conditionally show the user entry for certain users
|
||||
|
||||
You can configure Setup Manager to only show the user entry section when specified users have authentication in enrollment customization. This enables workflows, where certain users (techs and admins) gets the option to re-assign the device to another user, but other users don't see the option.
|
||||
You can configure Setup Manager to only show the user entry section when specified users have authenticated in enrollment customization. This enables workflows, where certain users (techs and admins) get the option to re-assign the device to another user, but other users don't see the option.
|
||||
|
||||
For this, you need to setup the top-level `userID` to receive the `$EMAIL` variable. This will communicate the user who logged in with customized enrollment back into Setup Manager. Then you add key `showForUserIDs` with an array of user emails to the `userEntry` dict. When both `userID` and `userEntry.showForUserIDs` are set, the user entry UI will only show for the listed users.
|
||||
For this, you need to setup the top-level `userID` to receive the `$EMAIL` variable. This will communicate to SetupManager the user who logged in with customized enrollment. Then you add key `showForUserIDs` with an array of user emails to the `userEntry` dict. When both `userID` and `userEntry.showForUserIDs` are set, the user entry UI will only show for the listed users.
|
||||
|
||||
#### `showForUserIDs`
|
||||
|
||||
@@ -617,7 +767,7 @@ For this, you need to setup the top-level `userID` to receive the `$EMAIL` varia
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>userEntry</key>
|
||||
<dict>
|
||||
<key>showForUserIDs</key>
|
||||
@@ -640,7 +790,7 @@ Example:
|
||||
|
||||
## Help
|
||||
|
||||
When you provide a top-level `help` key with a dictionary a help button (with a circled question mark) will be shown in the lower right corner. When you click on the help button a window with information will be shown. You can set the information with the following keys in the `help` dictionary.
|
||||
When you provide a top-level `help` key with a dictionary a help button (with a circled question mark) will be shown in the lower right corner (for left-to-right localizations). When you click on the help button a window with information will be shown. You can set the information with the following keys in the `help` dictionary.
|
||||
|
||||
#### `title`
|
||||
|
||||
@@ -648,17 +798,17 @@ When you provide a top-level `help` key with a dictionary a help button (with a
|
||||
|
||||
#### `message`
|
||||
|
||||
(String, optional, localized)
|
||||
(String, optional, localized, markdown)
|
||||
|
||||
#### `url`:
|
||||
|
||||
(String, optional, localized)
|
||||
|
||||
The contents of the `url` key will be translated into a QR code and displayed next to the help message. This allows for end users to follow a link to more information on their devices while the Mac is performing installations.
|
||||
The contents of the `url` key will be translated into a QR code and displayed next to the help message. This allows for end users to follow a link to more information on another device while the Mac is performing installations.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>help</key>
|
||||
<dict>
|
||||
<key>message</key>
|
||||
@@ -670,26 +820,44 @@ Example:
|
||||
</dict>
|
||||
```
|
||||
|
||||
## Webhooks
|
||||
|
||||
Setup Manager can send web hooks to servers and services to trigger workflows there. You can read [details on how to configure and use WebHooks here](Docs/Webhooks.md).
|
||||
|
||||
## Localization
|
||||
|
||||
The app will pick up the user choice of the UI language for the interface elements. Right now it supports English, French, German, Italian, Spanish, and Dutch. The app will fall back to English for other language choices.
|
||||
The app will pick up the user choice of the UI language for the interface elements. (Table of currently available languages below.) The app will fall back to English for other language choices.
|
||||
|
||||
You can provide localizations for the texts given in the configuration profile. You can do so by adding the two-letter language abbreviation (e.g. `de`, `fr`, or `nl`) to the key, separated with a `.` (dot or period character). The value of the key without a "language extension" is used for English and as a fallback value for other languages.
|
||||
You can provide localizations for the custom texts given in the configuration profile.
|
||||
|
||||
Example:
|
||||
**Deprecation notice:** 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.
|
||||
|
||||
```
|
||||
To provide a set of localizations for a value in the profile, change its type from `string` to `dict`. Inside the `dict`, provide a value for each localization for each localization with the language code as key.
|
||||
|
||||
For example, this unlocalized key-value pair
|
||||
|
||||
```xml
|
||||
<key>title</key>
|
||||
<string>Welcome!</string>
|
||||
<key>title.de</key>
|
||||
<string>Willkommen!</string>
|
||||
<key>title.fr</key>
|
||||
<string>Bienvenu!</string>
|
||||
<key>title.nl</key>
|
||||
<string>Welkom!</string>
|
||||
```
|
||||
|
||||
can be localized like this:
|
||||
|
||||
```xml
|
||||
<key>title</key>
|
||||
<dict>
|
||||
<key>en</key>
|
||||
<string>Welcome!</string>
|
||||
<key>de</key>
|
||||
<string>Willkommen!</string>
|
||||
<key>fr</key>
|
||||
<string>Bienvenu!</string>
|
||||
<key>nl</key>
|
||||
<string>Welkom!</string>
|
||||
</dict>
|
||||
```
|
||||
|
||||
If you do not provide or have deleted a `title.de` key and value, the app will choose the value of the `title` key even when in the German setting.
|
||||
When there is no value for the localization, the app will fall back to the value of the `en` key.
|
||||
|
||||
The following keys can be localized:
|
||||
|
||||
@@ -700,26 +868,86 @@ The following keys can be localized:
|
||||
- `icon`
|
||||
- `background`
|
||||
|
||||
### Action keys
|
||||
### Actions
|
||||
|
||||
- `label`
|
||||
- `icon`
|
||||
|
||||
### User Entry keys
|
||||
### User Entry
|
||||
|
||||
- `default`
|
||||
- `placeholder`
|
||||
- `validationMessage`
|
||||
- `label`
|
||||
|
||||
### Help
|
||||
|
||||
- `title`
|
||||
- `message`
|
||||
- `url`
|
||||
|
||||
Use these two-letter codes for these languages:
|
||||
|
||||
| Language | two-letter code |
|
||||
|--------------------|-----------------|
|
||||
| Dutch (Nederlands) | nl |
|
||||
| English | en (default) |
|
||||
| Dutch (Nederlands) | nl |
|
||||
| French | fr |
|
||||
| German | de |
|
||||
| Italian | it |
|
||||
| Hebrew | he |
|
||||
| Norwegian | nb |
|
||||
| Spanish | es |
|
||||
| Swedish | sv |
|
||||
|
||||
The [plist and profile example files](Examples) contain localizations for many of the custom text elements.
|
||||
|
||||
## Substitution
|
||||
|
||||
Certain keys, such as `computerNameTemplate` can use tokens, which begin and end with `%` character. The tokens will be substituted with data from the device or user entry.
|
||||
|
||||
For example, in the template `Mac-%serial%` the `%serial%` token will be replaced with the computer's serial number.
|
||||
|
||||
A double `%%` will be substituted with a single `%`, in case you need to represent this symbol.
|
||||
|
||||
The following tokens are available:
|
||||
|
||||
- `serial`: the computer's serial number
|
||||
- `udid`: the computer's provisioning universal device identifier
|
||||
- `model`: the computer's model name, e.g. `MacBook Air` or `Mac mini`
|
||||
- `model-short`: the first word of `model` (no spaces), i.e. `MacBook`, `Mac` or `iMac`
|
||||
- these values from user entry, _after_ user entry has completed (see [`waitForUserEntry`](#waitForUserEntry))
|
||||
- `email`
|
||||
- `assetTag`
|
||||
- `building`
|
||||
- `department`
|
||||
- `room`
|
||||
|
||||
If the value for a token cannot be retrieved or is empty, it will be substituted with `%%%` (three percentage signs).
|
||||
|
||||
You can add a `:n` (where `n` is an integer number) to a token. This will substitute only the first `n` characters of the string. For example `%serial:5%` will be substituted with the first 5 characters of the serial number. When `n` is negative, it will substitute the _last_ `n` characters. For example, `%udid:-8%` will substitute the last eight characters of the udid. When you use `:=n` the _center_ `n` characters will be picked.
|
||||
|
||||
These keys can use substitutions:
|
||||
|
||||
- `title`
|
||||
- `message`
|
||||
- `computerNameTemplate`
|
||||
- actions: `label`
|
||||
|
||||
## Markdown
|
||||
|
||||
In some fields, markdown formatting can be used to generate rich, formatted text. For example:
|
||||
|
||||
```xml
|
||||
<key>message</key>
|
||||
<string>Preparing your new Mac. **Please be patient.**</string>
|
||||
```
|
||||
|
||||
The `Please be patient.` text will be shown bolded. You can find details on markdown formatting in the [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/).
|
||||
|
||||
Note that while you _can_ embed links to websites in the markdown using the `[…](…)` syntax they will not work while running over Setup Assistant or Login Window.
|
||||
|
||||
These keys can use markdown:
|
||||
|
||||
- `message`
|
||||
- Help: `message`
|
||||
|
||||
110
Docs/Extras.md
Normal file
110
Docs/Extras.md
Normal file
@@ -0,0 +1,110 @@
|
||||
# Extras and Notes
|
||||
|
||||
## Custom JSON Schema for Jamf Pro
|
||||
|
||||
- create a new profile
|
||||
- go to ‘Application & Custom Settings’
|
||||
- select ‘Jamf Applications’
|
||||
- click the ‘+ Add’ button
|
||||
- in the ‘Jamf Application Domain’ popup select ‘com.jamf.setupmanager’
|
||||
- for the version select the version of Setup Manager you are using
|
||||
- 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 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.
|
||||
|
||||
## 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 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 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.
|
||||
|
||||
In Jamf Pro, you can 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
|
||||
```
|
||||
|
||||
And then create a Smart Group named "Setup Manager Done" with the criteria `"Setup Manager Done" is "done"`. This can be very useful for scoping and limitations.
|
||||
|
||||
## User Data file
|
||||
|
||||
The data from user entry is written to a file when Setup Manager reaches a `waitForUserEntry` step and again when it finishes. The file is stored at `/private/var/db/SetupManagerUserData.txt`. When `DEBUG` is enabled, the file will be written to `/Users/Shared/`.
|
||||
|
||||
The file is plain text with the following format:
|
||||
|
||||
```
|
||||
start: 2024-08-14T13:52:56Z
|
||||
userID: a.b@example.com
|
||||
department: Sales
|
||||
building: Example
|
||||
room: ABC123
|
||||
assetTag: XYZ888
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
```xml
|
||||
duration=$(awk -F ': ' '/duration: / {print $2}' /private/var/db/SetupManagerUserData.txt)
|
||||
```
|
||||
|
||||
Starting with Setup Manager 1.2, the User Data file contains a list of actions with their status:
|
||||
|
||||
```
|
||||
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).
|
||||
|
||||
54
Docs/FAQ.md
Normal file
54
Docs/FAQ.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# Frequently Asked Questions
|
||||
|
||||
## Is there a custom JSON Schema for Jamf Pro?
|
||||
|
||||
[Yes.](Extras.md#custom-json-schema-for-jamf-pro)
|
||||
|
||||
## Can you block the user desktop with user initiated enrollment?
|
||||
|
||||
Yes, use the top-level `background` key and point it to a local image file or a http URL to an image file. If you don't want custom branding, you can set `background` to `/System/Library/CoreServices/DefaultDesktop.heic` for the default image.
|
||||
|
||||
## Setup Manager is not launching after enrollment
|
||||
|
||||
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.
|
||||
|
||||
## 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 without Jamf Connect. Some features, 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
|
||||
|
||||
|
||||
## What is happening during "Getting Ready" and "Finishing"?
|
||||
|
||||
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.
|
||||
|
||||
## 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). You can use the Jamf Pro login trigger for this, or create a custom LaunchAgent or use [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.
|
||||
|
||||
35
Docs/JamfPro-LoginWindow.md
Normal file
35
Docs/JamfPro-LoginWindow.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Jamf Pro: Run Setup Manager at Login Window
|
||||
|
||||
**Beta** _We believe the run at login window feature may require more testing, especially in some edge cases. When, after thorough testing, you believe this works in your workflow, feel free to deploy it, and please let us know about success or any issues you might encounter._
|
||||
|
||||
By default, Setup Manager launches as soon as the installation completes. You can defer launching Setup Manager to launch when the macOS Login Window appears, instead.
|
||||
|
||||
When the `runAt` key in the profile is set to `loginwindow`, Setup Manager will not launch immediately after installation but when Login Window appears. In combination with the 'AutoAdvance' feature for automated device enrollment, this allows for completely 'hands-off' enrollment and configuration workflows.
|
||||
|
||||
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.
|
||||
70
Docs/JamfPro-QuickStart.md
Normal file
70
Docs/JamfPro-QuickStart.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# Jamf Pro: Setup Manager Quick Start
|
||||
|
||||
## Upload Setup Manager package
|
||||
|
||||
Download the latest version of the Setup Manager installation pkg from the [releases page](https://github.com/Jamf-Concepts/Setup-Manager/releases/latest).
|
||||
|
||||
In the Jamf Pro web interface, go to Settings > Packages. Create a new package and upload the Setup Manager installer pkg file to Jamf Pro. Save the package.
|
||||
|
||||
_Note:_ when the package is marked as 'pending' it will not work in prestage deployment. Wait with testing deployments until the 'pending' flag has disappeared.
|
||||
|
||||
## Prepare a Jamf Pro policy for use with Setup Manager
|
||||
|
||||
Setup Manager can trigger policies in Jamf Pro. By triggering a sequence of Jamf Pro policies all the required software and configurations will be installed on the device.
|
||||
|
||||
## Create the Setup Manager configuration profile
|
||||
|
||||
- Go to Computers > create a new profile
|
||||
- Name the profile 'Setup Manager'
|
||||
- assign a category, ensure the Level is set to 'Computer Level'
|
||||
- in payload sidebar select 'Application & Custom Settings', then select 'Jamf Applications'
|
||||
- click the '+ Add' button
|
||||
- for the 'Jamf Application Domain' choose `com.jamf.setupmanager`
|
||||
- for the version select the version of Setup Manager you are using
|
||||
- for the 'Variant', select `Setup Manager.json`
|
||||
|
||||
### Profile values
|
||||
- for the Icon Source, enter `name:NSComputer`. This is a special value that tells Setup Manager to use an image of the computer it is running on. There are many other options you can use as an icon source [documented here](../ConfigurationProfile.md#icon-source).
|
||||
- for the Title, enter `Welcome to Setup Manager!`
|
||||
- for the Message, enter `Please be patient while we set up your new Mac…`
|
||||
|
||||
### Enrollment
|
||||
- under Enrollment Actions, click on 'Add Item'
|
||||
- for item 1, from the 'Select Action Type' popup, choose "Installomator"
|
||||
- for 'Action Label,' enter `Google Chrome`
|
||||
- for 'Action Icon Source,' enter `symbol:network`
|
||||
- for 'Installomator Label' enter `googlechromepkg`
|
||||
- click 'Add Item'
|
||||
- for item 2, from the 'Select Action Type' popup, choose "Shell Command"
|
||||
- under 'Command Arguments', click 'Add argument', enter `-setTimeZone`
|
||||
- click 'Add argument' again and enter your time zone in the format `Europe/Amsterdam` (the 'TZ identifier' [from this list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones))
|
||||
- for 'Action Label,' enter `Set Time Zone`
|
||||
- for 'Action Icon Source,' enter `symbol:clock`
|
||||
- for 'Requires Root' select `true`
|
||||
- for 'Shell Command Path' enter `/usr/sbin/systemsetup`
|
||||
|
||||
You can add more actions here. There are more types of actions available, you can use a 'Jamf Policy Trigger' action to run a policy with a custom trigger. You can also use a 'Watch Path' action to wait for an app to be installed from the Mac App Store or Jamf App Installers.
|
||||
|
||||
## Scoping and Prestage
|
||||
|
||||
- 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.
|
||||
- ensure that 'Automatically advance through Setup Assitant' is _disabled_
|
||||
- Have at least one Setup Assistant option _disabled_ (so that _is_ displayed)
|
||||
- ensure your test Mac(s) is (are) assigned to the Prestage
|
||||
|
||||
## Wipe the Test Mac
|
||||
|
||||
- on the test mac, choose 'Erase all Contents and Settings' in the Settings app or wipe the Mac using the 'Wipe Computer' 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`
|
||||
|
||||
## Next Steps
|
||||
|
||||
- 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)
|
||||
- add [a `help` section](../ConfigurationProfile.md#help) 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](../ConfigurationProfile.md#user-entry) section in the profile
|
||||
59
Docs/JamfPro-TwoPhase.md
Normal file
59
Docs/JamfPro-TwoPhase.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# Jamf Pro: extra installations based on user data entry
|
||||
|
||||
In this simple example workflow, we run certain Jamf Pro policies depending on the department. This example can be expanded to other user entry data fields.
|
||||
|
||||
- create Setup Manager configuration profile
|
||||
- create a `userEntry` key with a list of options for the department:
|
||||
|
||||
```xml
|
||||
<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>
|
||||
```
|
||||
|
||||
Note that you need to have the matching departments in Jamf Pro.
|
||||
|
||||
- add the `enrollmentActions` that should run on all computers first
|
||||
- then add a `waitForUserEntry` action:
|
||||
|
||||
```xml
|
||||
<dict>
|
||||
<key>label</key>
|
||||
<string>Submit entries</string>
|
||||
<key>waitForUserEntry</key>
|
||||
<string/>
|
||||
</dict>
|
||||
```
|
||||
|
||||
When Setup Manager reaches this action it will wait for the user data entry to be complete if it isn't already. Then Setup Manager will submit the data from the user entry to Jamf Pro and run a recon, so you can use the data for scoping subsequent policies.
|
||||
|
||||
Setup Manager also saves the data from user entry in a plain text file which you can use in policy scripts after the `waitForUserEntry` action. [See details here.](Extras.md#user-data-file)
|
||||
|
||||
- Insert this action
|
||||
|
||||
``` xml
|
||||
<dict>
|
||||
<key>icon</key>
|
||||
<string>symbol:plus.app</string>
|
||||
<key>label</key>
|
||||
<string>Extra Apps for %department%</string>
|
||||
<key>policy</key>
|
||||
<string>install_extra_apps</string>
|
||||
</dict>
|
||||
```
|
||||
|
||||
- for the policies you want run/install depending on the user entry:
|
||||
- give the policy a custom trigger matching the trigger in 'Extra Apps' action: `install_extra_apps`
|
||||
- scope the policy to the department(s) that should receive the installations
|
||||
- repeat for every extra installation that depends on the user entry
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Single Touch workflow with Jamf Pro and Jamf Connect
|
||||
# Single Touch workflow with Jamf Pro and Jamf Connect
|
||||
|
||||
## What is Single Touch?
|
||||
|
||||
@@ -8,7 +8,7 @@ A single touch workflow can be as easy the tech unpacking the Mac (erasing it wi
|
||||
|
||||
You can use a combination of Jamf Pro, Setup Manager and Jamf Connector, to get a tighter deployment, user assignment and account creation process. This requires a bit more setup and configuration. This workflow allows the tech to monitor the Setup Manager workflow, enter device specific data such as an asset tag and assign _and lock_ the device to a different user, without requiring the end user's login credentials.
|
||||
|
||||
## What you need:
|
||||
## What you need
|
||||
|
||||
- Jamf Pro
|
||||
- Setup Manager
|
||||
@@ -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
|
||||
|
||||
@@ -28,8 +30,7 @@ Setup Manager profile will require a `userEntry` field for `userID` to know whic
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
```
|
||||
```xml
|
||||
<key>userID</key>
|
||||
<dict>
|
||||
<key>placeholder</key>
|
||||
@@ -56,7 +57,7 @@ When you upload the Jamf Connect pkg to Jamf Pro and add it to either the Presta
|
||||
|
||||
When you use Jamf App Installers you have no direct control over when the installation actually occurs. You should add a `watchPath` action at the end of your `enrollmentActions` array in the Setup Manager profile to ensure that Jamf Connect is installed before proceeding:
|
||||
|
||||
```
|
||||
```xml
|
||||
<dict>
|
||||
<key>label</key>
|
||||
<string>Jamf Connect</string>
|
||||
@@ -75,7 +76,7 @@ The email entered for userID will be submitted to Jamf Pro at the end of the Set
|
||||
|
||||
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
|
||||
@@ -87,17 +88,19 @@ 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
|
||||
<?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>EnrollmentRealName</key>
|
||||
<string>$REALNAME</string>
|
||||
<key>EnrollmentUserName</key>
|
||||
<string>$EMAIL</string>
|
||||
<key>EnrollmentRealName</key>
|
||||
<string>$REALNAME</string>
|
||||
<key>EnrollmentUserName</key>
|
||||
<string>$EMAIL</string>
|
||||
</dict>
|
||||
</plist>
|
||||
```
|
||||
@@ -105,4 +108,3 @@ Jamf Connect Login allows pre-configuring the user. Create a configuration profi
|
||||
Scope this configuration profile the "Setup Manager Done" smart group you created earlier.
|
||||
|
||||
With this setup, the configuration profile that presets the user in Jamf Connect Login will be pushed out after Setup Manager finishes its final recon, which sets the user information to the Mac in Jamf Pro.
|
||||
|
||||
64
Docs/JamfSchool-Setup.md
Normal file
64
Docs/JamfSchool-Setup.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Jamf School: Setup Manager Quick Start
|
||||
|
||||
### Upload Setup Manager Package
|
||||
|
||||
Download the latest version of the Setup Manager installation pkg from the [releases page](https://github.com/Jamf-Concepts/Setup-Manager/releases)
|
||||
|
||||
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
|
||||
|
||||
* **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)
|
||||
|
||||
|
||||
### Prepare Jamf School In House macOS Apps, VPP Apps and Configurations
|
||||
|
||||
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.
|
||||
|
||||
If you intend to "watch" for an item in your Setup Manager workflow ensure to scope the app(s) in the convential way.
|
||||
|
||||
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
|
||||
|
||||
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).
|
||||
|
||||
*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.*
|
||||
|
||||
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/).
|
||||
|
||||
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
|
||||
|
||||
Once you have a configuration profile with the desired actions it should be uploaded to Jamf School. Navigate to
|
||||
|
||||
* **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)
|
||||
|
||||
### Automated Device Enrolment Profile & Scoping
|
||||
|
||||
Create a new ADE profile by Navigating to
|
||||
|
||||
* **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**
|
||||
|
||||
Finally scope the ADE profile to the required devices
|
||||
|
||||
### Wipe The Test Mac
|
||||
|
||||
* 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`
|
||||
|
||||
109
Docs/Webhooks.md
Normal file
109
Docs/Webhooks.md
Normal file
@@ -0,0 +1,109 @@
|
||||
# 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
|
||||
"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
|
||||
"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. 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.
|
||||
@@ -2,34 +2,6 @@
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>userEntry</key>
|
||||
<dict>
|
||||
<key>department</key>
|
||||
<dict>
|
||||
<key>options</key>
|
||||
<array>
|
||||
<string>Sales</string>
|
||||
<string>R&D</string>
|
||||
<string>IT</string>
|
||||
</array>
|
||||
</dict>
|
||||
<key>computerName</key>
|
||||
<string>Mac-12345</string>
|
||||
<key>userID</key>
|
||||
<dict>
|
||||
<key>placeholder</key>
|
||||
<string>first.last@example.com</string>
|
||||
<key>placeholder.de</key>
|
||||
<string>vorname.nachname@example.com</string>
|
||||
<key>placeholder.nl</key>
|
||||
<string>voornaam.achternaam@example.com</string>
|
||||
</dict>
|
||||
<key>assetTag</key>
|
||||
<dict>
|
||||
<key>placeholder</key>
|
||||
<string>ABC12345</string>
|
||||
</dict>
|
||||
</dict>
|
||||
<key>enrollmentActions</key>
|
||||
<array>
|
||||
<dict>
|
||||
@@ -41,17 +13,22 @@
|
||||
<key>icon</key>
|
||||
<string>symbol:clock</string>
|
||||
<key>label</key>
|
||||
<string>Set Time Zone</string>
|
||||
<key>label.es</key>
|
||||
<string>Establecer zona horaria</string>
|
||||
<key>label.fr</key>
|
||||
<string>Définir le fuseau horaire</string>
|
||||
<key>label.it</key>
|
||||
<string>Imposta il fuso orario</string>
|
||||
<key>label.de</key>
|
||||
<string>Zeitzone setzen</string>
|
||||
<key>label.nl</key>
|
||||
<string>Tijdzone instellen</string>
|
||||
<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>he</key>
|
||||
<string>הגדרות אזור זמן</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>
|
||||
@@ -92,35 +69,76 @@
|
||||
<string>/Applications/JamfProtect.app</string>
|
||||
</dict>
|
||||
</array>
|
||||
<key>icon</key>
|
||||
<string>name:AppIcon</string>
|
||||
<key>finalCountdown</key>
|
||||
<integer>30</integer>
|
||||
<key>message</key>
|
||||
<string>Please be patient while Setup Manager configures your new Mac.</string>
|
||||
<key>message.es</key>
|
||||
<string>Por favor espere mientras Setup Manager configura tu nuevo Mac.</string>
|
||||
<key>message.it</key>
|
||||
<string>Sii paziente mentre Setup Manager configura il tuo nuovo Mac.</string>
|
||||
<key>message.fr</key>
|
||||
<string>Veuillez être patient pendant que Setup Manager configure votre nouveau Mac.</string>
|
||||
<key>message.de</key>
|
||||
<string>Bitte etwas Geduld während Setup Manager deinen neuen Mac konfiguriert.</string>
|
||||
<key>message.nl</key>
|
||||
<string>Even geduld terwijl Setup Manager je nieuwe Mac configureert.</string>
|
||||
<key>title</key>
|
||||
<string>Welcome!</string>
|
||||
<key>title.es</key>
|
||||
<string>¡Bienvenido!</string>
|
||||
<key>title.it</key>
|
||||
<string>Benvenuto!</string>
|
||||
<key>title.fr</key>
|
||||
<string>Bienvenu!</string>
|
||||
<key>title.de</key>
|
||||
<string>Willkommen!</string>
|
||||
<key>title.nl</key>
|
||||
<string>Welcom!</string>
|
||||
<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>assetTag</key>
|
||||
<dict>
|
||||
<key>placeholder</key>
|
||||
<string>ABC12345</string>
|
||||
</dict>
|
||||
<key>computerName</key>
|
||||
<string>Mac-12345</string>
|
||||
<key>department</key>
|
||||
<dict>
|
||||
<key>options</key>
|
||||
<array>
|
||||
<string>Sales</string>
|
||||
<string>R&D</string>
|
||||
<string>IT</string>
|
||||
</array>
|
||||
</dict>
|
||||
<key>userID</key>
|
||||
<dict>
|
||||
<key>placeholder</key>
|
||||
<dict>
|
||||
<key>de</key>
|
||||
<string>vorname.nachname@example.com</string>
|
||||
<key>en</key>
|
||||
<string>first.last@example.com</string>
|
||||
<key>nl</key>
|
||||
<string>voornaam.achternaam@example.com</string>
|
||||
</dict>
|
||||
</dict>
|
||||
</dict>
|
||||
</dict>
|
||||
</plist>
|
||||
@@ -25,13 +25,16 @@
|
||||
<key>icon</key>
|
||||
<string>symbol:clock</string>
|
||||
<key>label</key>
|
||||
<string>Set Time Zone</string>
|
||||
<key>label.de</key>
|
||||
<string>Zeitzone setzen</string>
|
||||
<key>label.fr</key>
|
||||
<string>Définir le fuseau horaire</string>
|
||||
<key>label.nl</key>
|
||||
<string>Tijdzone instellen</string>
|
||||
<dict>
|
||||
<key>de</key>
|
||||
<string>Zeitzone setzen</string>
|
||||
<key>en</key>
|
||||
<string>Set Time Zone</string>
|
||||
<key>fr</key>
|
||||
<string>Définir le fuseau horaire</string>
|
||||
<key>nl</key>
|
||||
<string>Tijdzone instellen</string>
|
||||
</dict>
|
||||
<key>requiresRoot</key>
|
||||
<true/>
|
||||
<key>shell</key>
|
||||
@@ -46,13 +49,16 @@
|
||||
<key>icon</key>
|
||||
<string>symbol:cpu</string>
|
||||
<key>label</key>
|
||||
<string>Install Rosetta</string>
|
||||
<key>label.de</key>
|
||||
<string>Rosetta installieren</string>
|
||||
<key>label.fr</key>
|
||||
<string>Installer Rosetta</string>
|
||||
<key>label.nl</key>
|
||||
<string>Rosetta installeren</string>
|
||||
<dict>
|
||||
<key>de</key>
|
||||
<string>Rosetta installieren</string>
|
||||
<key>en</key>
|
||||
<string>Install Rosetta</string>
|
||||
<key>fr</key>
|
||||
<string>Installer Rosetta</string>
|
||||
<key>nl</key>
|
||||
<string>Rosetta installeren</string>
|
||||
</dict>
|
||||
<key>requiresRoot</key>
|
||||
<true/>
|
||||
<key>shell</key>
|
||||
@@ -78,21 +84,27 @@
|
||||
<key>icon</key>
|
||||
<string>name:AppIcon</string>
|
||||
<key>message</key>
|
||||
<string>Setup Manager is configuring your Mac…</string>
|
||||
<key>message.de</key>
|
||||
<string>Setup Manager konfiguriert deinen Mac…</string>
|
||||
<key>message.fr</key>
|
||||
<string>Setup Manager configure votre Mac…</string>
|
||||
<key>message.nl</key>
|
||||
<string>Setup Manager configureert je Mac…</string>
|
||||
<dict>
|
||||
<key>de</key>
|
||||
<string>Setup Manager konfiguriert deinen Mac…</string>
|
||||
<key>en</key>
|
||||
<string>Setup Manager is configuring your Mac…</string>
|
||||
<key>fr</key>
|
||||
<string>Setup Manager configure votre Mac…</string>
|
||||
<key>nl</key>
|
||||
<string>Setup Manager configureert je Mac…</string>
|
||||
</dict>
|
||||
<key>title</key>
|
||||
<string>Welcome!</string>
|
||||
<key>title.de</key>
|
||||
<string>Willkommen!</string>
|
||||
<key>title.fr</key>
|
||||
<string>Bienvenu!</string>
|
||||
<key>title.nl</key>
|
||||
<string>Welkom!</string>
|
||||
<dict>
|
||||
<key>de</key>
|
||||
<string>Willkommen!</string>
|
||||
<key>en</key>
|
||||
<string>Welcome!</string>
|
||||
<key>fr</key>
|
||||
<string>Bienvenu!</string>
|
||||
<key>nl</key>
|
||||
<string>Welkom!</string>
|
||||
</dict>
|
||||
</dict>
|
||||
</dict>
|
||||
</array>
|
||||
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>
|
||||
@@ -24,7 +24,7 @@ bundleID="com.jamf.setupmanager"
|
||||
|
||||
appPath="/Applications/Utilities/${appName}.app"
|
||||
|
||||
if [ $(whoami) != "root" ]; then
|
||||
if [ "$(whoami)" != "root" ]; then
|
||||
echo "needs to run as root!"
|
||||
exit 1
|
||||
fi
|
||||
@@ -35,9 +35,11 @@ if launchctl list | grep -q "$bundleID" ; then
|
||||
fi
|
||||
|
||||
echo "removing files"
|
||||
rm -rfv /Applications/Utilities/"$appName".app
|
||||
rm -rfv "$appPath"
|
||||
rm -v /Library/LaunchDaemons/"$bundleID".plist
|
||||
rm -v /Library/LaunchAgents/"$bundleID".loginwindow.plist
|
||||
|
||||
echo "forgetting $bundleID pkg receipt"
|
||||
pkgutil --forget "$bundleID"
|
||||
|
||||
# rm -v /private/var/db/.JamfSetupEnrollmentDone
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 536 KiB After Width: | Height: | Size: 617 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 94 KiB |
80
README.md
80
README.md
@@ -1,94 +1,70 @@
|
||||
|
||||
|
||||
# Setup Manager
|
||||
# Setup Manager
|
||||
|
||||
_"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).
|
||||
|
||||
|
||||
|
||||
## What it does
|
||||
|
||||
There are many enrollment progress tools available for Mac admins, each with their own strengths. Jamf Setup Manager approaches the problem from the perspective of an IT service provider.
|
||||
|
||||
Setup Manager offers many of the same features of these utilities but is especially useful for the case where an IT department or provisioning depot wants to ensure that a new Mac is properly configured and assigned before sending the device to its new user. It runs over Setup Assistant before a user is created so it won't interfere with MDM-capable user or the secure token flow for FileVault. You can control which policies and installations Setup Manager runs with a configuration profile.
|
||||
Setup Manager offers many of the same features of these utilities but is especially useful for the case where an IT department or provisioning depot wants to ensure that a new Mac is properly configured and assigned before sending the device to its new user. It runs over Setup Assistant before a user is created, so it won't interfere with MDM-capable user or the secure token flow for FileVault. You can control which policies and installations Setup Manager runs with a configuration profile.
|
||||
|
||||
Setup Manager provides:
|
||||
|
||||
- a nice modern UI
|
||||
- configuration with a configuration profile, no need to modify shell scripts or json
|
||||
- works with different deployment workflows
|
||||
- zero-touch (user-driven)
|
||||
- single-touch (tech-driven)
|
||||
- user initiated enrollment
|
||||
- handsfree deployment with AutoAdvance (beta)
|
||||
- customized branding
|
||||
- localized interface and custom text
|
||||
- support for Jamf Pro and Jamf School
|
||||
|
||||
|
||||
|
||||
## Installation and Configuration
|
||||
|
||||
### Jamf Pro
|
||||
|
||||
1. Upload the Setup Manager installer pkg file to Jamf Pro
|
||||
2. Create a custom configuration profile with the preference domain `com.jamf.setupmanager`. See documentation for the profile contents [here](ConfigurationProfile.md).
|
||||
3. Scope the configuration profile to the computers
|
||||
4. Add the pkg and the configuration profile to the Prestage
|
||||
|
||||
Setup Manager can be used for various zero-touch and tech-driven single-touch deployments with Jamf Pro and (optionally) Jamf Connect. One single-touch workflow with Jamf Connect where the tech can re-assign the Mac to a different end user [is described here](JamfProConnect-SingleTouch.md).
|
||||
|
||||
### Jamf School
|
||||
|
||||
[Setup with Jamf School](Setup-JamfSchool.md)
|
||||
- Jamf Pro
|
||||
- [JamfPro-Quick Start](Docs/JamfPro-QuickStart.md)
|
||||
- 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 AutoAdvance and Setup Manager at login window (beta)](Docs/JamfPro-LoginWindow.md)
|
||||
- [Jamf School](Docs/JamfSchool-Setup.md)
|
||||
- [Extras and Notes](Docs/Extras.md)
|
||||
- [Frequently Asked Questions](Docs/FAQ.md)
|
||||
- [Webhooks](Docs/Webhooks.md)
|
||||
|
||||
## Configuration Profile
|
||||
|
||||
The structure of the configuration profile [is documented here](ConfigurationProfile.md).
|
||||
|
||||
## Notes
|
||||
There is also a [custom schema for Jamf Pro](Docs/Extras.md#custom-json-schema-for-jamf-pro).
|
||||
|
||||
### Requirements
|
||||
## Requirements
|
||||
|
||||
Setup Manager requires macOS 12.0.0 or higher. It will work only with Jamf Pro or Jamf School.
|
||||
|
||||
### Known Issues
|
||||
## Known Issues
|
||||
|
||||
- Setup Manager will **_not_** launch with Auto-Advance enabled
|
||||
- Setup Manager may **_not_** launch or launch and quit quickly when you disable _all_ Setup Assistant screens
|
||||
- Policies that are triggered by `enrollmentComplete` may disrupt Setup Manager running from Prestage/Automated Device Enrollment. To avoid this, disable or unscope policies triggered by `enrollmentComplete` on devices using Setup Manager.
|
||||
- In some deployments, Setup Manager attempts to start while Jamf is still installing. Try adding a 30-60 second `wait` action as the first action. We are working on a solution.
|
||||
- SVG and PDF files don't work with download URLs. workaround: convert files to PNG or use local SVG or PDf files instead.
|
||||
- With Jamf School, there will a few seconds after the remote management dialog where Setup Assistant shows before Setup Manager launches. With the Jamf School enrollment architecture, this is unavoidable.
|
||||
- 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, 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 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.
|
||||
|
||||
### Quit
|
||||
---
|
||||
|
||||
The command-Q keyboard short cut to quit the app is disabled. You can use shift-control-command-E instead. This should only be used when debugging as it may leave the client in an undetermined state when installations are aborted.
|
||||
|
||||
### Logging
|
||||
|
||||
Setup Manager logs to `/Library/Logs/Setup Manager.log`.
|
||||
|
||||
While it is running you can open a log window with command-L.
|
||||
|
||||
### Flag file
|
||||
|
||||
Setup Manager creates a flag file at `/private/var/db/.JamfSetupEnrollmentDone` when it finishes. If this file exists when Setup Manager launches, the app will terminate immediately and withour taking any action. You can use this flag file in an extension attribute in Jamf to determine whether the enrollment steps were performed. (Setup Manager does not care if the actions were performed successfully.)
|
||||
|
||||
When DEBUG is set to YES in the defaults/configuration profile, the flag file is ignored at launch, but still created when done.
|
||||
|
||||
### Final action and shutdown
|
||||
|
||||
When the app is not running as root (for testing or from Xcode) or when the `DEBUG` preference is set, shutdown will merely quit.
|
||||
|
||||
### "About This Mac…" window
|
||||
|
||||
When you hold the option key when clicking on "About This Mac…" you will see more information.
|
||||
|
||||
|
||||
|
||||
Please report issues, feature requests, and feedback (positive and negative) [as an issue.](https://github.com/setup-manager/setup-manager/issues)
|
||||
Please report issues, feature requests, and feedback (positive and negative) [as an issue.](https://github.com/Jamf-Concepts/Setup-Manager/issues)
|
||||
|
||||
@@ -1,71 +0,0 @@
|
||||
# Setup with Jamf School
|
||||
|
||||
## Setting Jamf Setup Manager Workflow in Jamf School
|
||||
|
||||
In order to configure the workflow in Jamf School you will need
|
||||
|
||||
- A Jamf Setup Manager Configuration Profile (configured for your deployment, example profile below) uploaded to Jamf School
|
||||
- Jamf Setup Manager PKG (available from GitHub) uploaded to Jamf School
|
||||
- An Automated Device Enrolment Profile with at least one setup assistant pane configured, “Wait for the configuration to be applied before continuing the Setup Assistant” box checked and an admin account configured as required and “skipped user creation” pane
|
||||
- Other ADE profile setting should be set as required but Do Not select Auto Advance (see below)
|
||||
|
||||
|
||||
### Step 1
|
||||
|
||||
- Create a Payloadless 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
|
||||
|
||||
- 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 “Operating System” “equals” “Any” and then leave the min and max OS blank. This will target any and all macOS devices in my environment
|
||||
- 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 the desired devices in your environment
|
||||
- Save Scope
|
||||
|
||||
### Step 3
|
||||
|
||||
- Create a Smart Group to target devices with Jamf Setup Manager Profile Installed to deploy JSM 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
|
||||
|
||||
- Create a Smart Group to target devices with the “JSM 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, if 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
|
||||
|
||||
|
||||
These chained Smart group actions then perform the following flow
|
||||
- Scope the Jamf Setup Manager Config profiles to all macOS devices
|
||||
- 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, when 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 it install Jamf Setup Manager and the required config rather than having Jamf Setup Manager queued rather down a list of apps that are installing.
|
||||
This activity log shows the order in which Jamf School issues and the device receives the commands. We can see that theres not a huge amount of time between all the actions but long enough that we can be sure that the device gets the Enterprise Install command to install Jamf Setup Manager before anything other apps
|
||||
|
||||
## Workflow Warnings
|
||||
|
||||
Since the Jamf Setup Manager workflow is very “specific” for Jamf School it shouldn’t be a surprise that there are some warnings, or gotcha’s. All mainly around the way that we’ve chained together the smart groups based on installed profiles, although it gives us the flow that we need it's also a little fragile.
|
||||
For example if you were to accidentally unscope the “Jamf Setup Manager Installed” profile from a device it would then fall out of scope of the “macOS Management & Apps” group, which is where all of the management and App Store apps are scoped.
|
||||
…and of course that means the device has the profiles removed and App Store apps removed AKA disaster 💥💥💥
|
||||
The second smart group we create also is looking for a profile that is installed. You’re likely not going to unscope by accident this profile (although if you did is would mean the device has profiles removed and App Store app removed AKA disaster 💥💥💥) what is more likely to happen is that you UPDATE or REPLACE the “Jamf Setup Manager Configuration Profile”
|
||||
Let's say you upload your JSM configure Profile and call its “JSM Setup V1” and this is the profile that you select in the smart group in Step 1 above. You then edit the config profile and call it JSM Setup V1.1, maybe even delete the JSM Setup V1 from Jamf School.
|
||||
The smart group is still looking for a profile called “JSM Setup V1”.
|
||||
Depending on your setup and how you’ve managed your profiles in Jamf School your deployed devices might not longer have JSM Setup V1 installed, which means it falls out of the “Install Jamf Setup Manager” group which in turn will fall out of the “macOS Management & Apps” group….which is where all of the management and App Store apps are scoped.
|
||||
Again, of course that means the device has the profiles removed and App Store apps removed AKA disaster 💥💥💥
|
||||
Also newly deployed devices might not run through the workflow correctly as they are now have JSM Setup V1.1 installed and the smart group is looking for JSM Setup V1.
|
||||
Bottom line here is be mindful about the name of your Jamf Setup Manager Profile and if you amend the config and upload a new version, scope that FIRST, then EDIT the smart group, wait for it to deploy and then remove the old profile.
|
||||
Although targeting the profile is what makes this workflow successful in Jamf School, its also a house of cards
|
||||
Reference in New Issue
Block a user