From 675469b197d2d32ffc7001b8b5783a474cb91f6d Mon Sep 17 00:00:00 2001 From: Armin Briegel <1933192+scriptingosx@users.noreply.github.com> Date: Tue, 28 Jan 2025 14:05:26 +0100 Subject: [PATCH] updated for v1.1.1 --- ChangeLog.md | 5 ++++ ConfigurationProfile.md | 52 +++++++++++++++++++---------------------- Docs/Extras.md | 5 ++-- README.md | 4 ++-- 4 files changed, 34 insertions(+), 32 deletions(-) diff --git a/ChangeLog.md b/ChangeLog.md index 5a0cb32..76f7c89 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,5 +1,10 @@ # Setup Manager - Change Log +## 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 diff --git a/ConfigurationProfile.md b/ConfigurationProfile.md index d1aa6f0..cfb092b 100644 --- a/ConfigurationProfile.md +++ b/ConfigurationProfile.md @@ -2,8 +2,8 @@ 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 +- [sample plist](Examples/sample-waitForUserEntry) for Jamf Pro with [two phase workflow](Docs/JamfPro-TwoPhase.md) +- [configuration profile](Example/sample-jamfschool.mobileconfig) for Jamf School ## Top-level keys @@ -12,11 +12,11 @@ The project some sample files to get you started: (Boolean, default: `false`) -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. +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 screen shots 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 +- 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 @@ -54,7 +54,7 @@ Example: Please wait a few moments while we install essential software… ``` -The message can use [substitutions](#substitution). +The message can use [substitutions](#substitution): Example: @@ -73,11 +73,11 @@ When this key is set, Setup Manager treats it as an image/[icon source](#icon-so (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. +**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. -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. +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 AutoAdvance) 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. +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 AutoAdvance. 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). @@ -125,14 +125,14 @@ Example: 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. -Example: +Examples: ```xml finalCountdown 30 ``` -Disable the countdown: +Disable the ```xml finalCountdown @@ -143,7 +143,7 @@ Disable the countdown: (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 shut down the computer, otherwise 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. When this key is set to `shutdown` (no space!) it will shut down 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. When the `DEBUG` preference is set, shutdown will merely quit/continue. @@ -186,7 +186,7 @@ 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 displayed in the 'About this Mac…' popup, when clicked with the option key. +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. Example: @@ -229,7 +229,7 @@ This will set the computer name to `Mac-DEF456` where `DEF456` are the center si (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 screenshots 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 screen shots 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. @@ -286,7 +286,7 @@ The label is used as the name of the action in display. (String, optional, localized) -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 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. 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. @@ -308,7 +308,7 @@ 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: @@ -336,11 +336,7 @@ Example: (String, Jamf Pro only) -This will run the Jamf Pro policy or polices with the given trigger name. This is the equivalent of running - -``` -jamf policy -event -verbose -forceNoRecon -doNotRestart -noInteraction -``` +This will run the jamf policy or polices with the given trigger name. This is the equivalent of running `jamf policy -event ` Example: @@ -390,7 +386,7 @@ Example: ``` -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, 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. +Note: This is intended to check if app are installed from the Mac App Store or Jamf App Installers. In my experience, these installation methods are quite 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 set a large timeout. ### Wait @@ -419,7 +415,7 @@ Example: 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). +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. @@ -442,7 +438,7 @@ Regardless of whether there is a `waitForUserEntry` action or not, Setup Manager This will run a Jamf Inventory update. -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. +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. Example: @@ -531,7 +527,7 @@ When the icon source starts with `name:`, Setup Manager will get the icon with t ### 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. +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](https://developer.apple.com/sf-symbols/) app. Note that the availability and appearance of SF Symbols may vary with the OS version and language/region. @@ -561,7 +557,7 @@ Data from user entry is written, together with some other data to a file when Se (String, localized) -Provide a default value in one of two ways: +Provide a default value in two ways: Example: @@ -681,9 +677,9 @@ The default validation message will show the regular expression the value is not ### Conditionally show the user entry for certain users -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. +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. -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. +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. #### `showForUserIDs` @@ -746,7 +742,7 @@ Example: ## Localization -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. +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 custom texts given in the configuration profile. diff --git a/Docs/Extras.md b/Docs/Extras.md index 69938f2..ead0d87 100644 --- a/Docs/Extras.md +++ b/Docs/Extras.md @@ -19,7 +19,7 @@ Note that the custom schema can become confused when you switch between enrollme ## 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. +The command-Q keyboard short cut to quit the app is disabled. Use `shift-control-command-E` instead. This should only be used when debugging and trouble-shooting, as it will leave the client in an undetermined state when installations are aborted. ## Logging @@ -33,7 +33,8 @@ You may also need to remember to remove the [flag file](#flag-file) before launc 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/Contents/MacOS/Setup Manager"` + +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 diff --git a/README.md b/README.md index c3e1647..5ce6257 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Setup Manager provides: - zero-touch (user-driven) - single-touch (tech-driven) - user initiated enrollment - - handsfree deployment with AutoAdvance (beta) + - handsfree deployment with auto advance (beta) - customized branding - localized interface and custom text - support for Jamf Pro and Jamf School @@ -42,7 +42,7 @@ Setup Manager provides: - zero-touch and user-initiated deployments (forthcoming) - [extra installations based on user data entry](Docs/JamfPro-TwoPhase.md) - [Single-touch workflow with user re-assignment using Jamf Connect](Docs/JamfProConnect-SingleTouch.md) - - [handsfree deployment with AutoAdvance and Setup Manager at login window (beta)](Docs/JamfPro-LoginWindow.md) + - [handsfree deployment with auto advance 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)