This Library Item is available for Mac computers
What is Liftoff?
Liftoff is a feature designed to streamline and enhance the initial setup experience for Mac computers. It automates the configuration process, ensuring that freshly enrolled Mac computers are transformed into enterprise-ready devices with all necessary apps, settings, and security controls in place before the user starts using them.How Liftoff Works
Liftoff does not change how a Mac computer’s initial agent check-in works after enrollment. It displays information about the check-in that would typically be visible only via the Iru Endpoint web app or the Command Line Utility, giving users visibility into what is being set up on their Mac. Liftoff shows the following Library Item types:- Custom Scripts
- Custom Printers
- Custom Apps
- Auto Apps
Create a Liftoff Library Item
Custom Apps or Custom Scripts that wait on user input can potentially be blocked from view and cause Liftoff to hang until the agent check-in times out.
1
Configure Liftoff Name
Give your Liftoff configuration a Name.
2
Assign to Blueprint
Assign the Liftoff configuration to your desired Blueprint.
3
4
Select Enrollment Trigger
Select your Enrollment trigger. The available options include:
- All enrollments: Liftoff will be presented regardless of enrollment type
- Automated Device Enrollment only: Liftoff will only be presented to devices enrolled via Automated Device Enrollment
- Manual enrollment only: Liftoff will only be presented to devices enrolled via Manual device enrollment
5
Upload Logo
Upload a Logo—a graphic that will appear in the upper-left corner of Liftoff. This is optional. The default image is for light mode.
- If you also wish to include an icon for dark mode, select Add Dark mode logo after uploading your light mode logo. This icon will be used instead of the main logo when the user enables Dark Mode.
6
Select Display Mode
Select a Display mode. We recommend using Window mode for initial testing for easy troubleshooting. Your display mode options are:
- Full screen: Liftoff will be presented in Full screen mode and will prevent the use of the Mac until the initial agent check-in is completed. You can use the exit password to exit Liftoff early
- Window: Liftoff will be presented in windowed mode. This will not prevent the use of the Mac, but Liftoff will be locked to the forefront. You can use the exit password to exit Liftoff early
7
Configure Exit Password
An Exit password is automatically generated. Learn how to use the exit password above.Clicking Generate new password and clicking Save will replace the existing exit password. A replaced exit password is not logged.
8
9
Customize Install Screen
Customize the Install screen header and subheader; see the Customize the Install Screen section below.Switch between Light Mode and Dark Mode previews.
10
11
Customize Help Screen
Customize the Help screen header and body; see the Customize the Help Screen section below.Switch between Light Mode and Dark Mode previews.
12
13
Configure Complete Screen
You can optionally turn off the Complete screen. If the Complete screen is not enabled, Liftoff will exit after completion.Customize the Complete screen header, subheader, and cards. See the Customize the Complete Screen section below.Switch between Light Mode and Dark Mode previews.
14
15
Save Configuration
Click Save when you are satisfied with your Liftoff configuration.
Customizing Liftoff
Customize the Install Screen
The Install screen’s header and subheader can be customized. As you update the text on the right side of the window, the preview on the left is automatically updated to provide a preview of how it will be displayed for your users.1
Specify Install screen header
Specify a Header for the Install screen.
2
Specify Install screen subheader
Specify a Subheader for the Install screen.
3
Restore defaults (optional)
You can restore the default text provided by clicking Restore defaults.
4
Save customizations
Click Done when you are finished with your customizations. The preview in the web app will update, reflecting your changes.
Customize the Help Screen
The Help screen’s header and subheader can be customized. Note that as you update the text on the right side of the window, the preview on the left is automatically updated to provide a preview of how it will be displayed for your users.1
Specify Help screen header
Specify a Header for the Help screen.
2
Specify Help screen body
Specify a Body for the Help screen.
3
Restore defaults (optional)
You can restore the default text provided by clicking Restore defaults.
4
Save customizations
Click Done when you are finished with your customizations. The preview in the web app will update, reflecting your changes.
Customize the Complete Screen
The Complete screen’s header and subheader can be customized. Note that as you update the text on the right side of the window, the preview on the left is automatically updated to provide a preview of how it will be displayed for your users.1
Specify Complete screen header
Specify a Header for the Complete screen.
2
Specify Complete screen subheader
Specify a Subheader for the Complete screen.
3
Reorganize or delete links
Click and drag the drag-and-drop icon to reorganize the links. Click the trash icon to delete a link.
4
Add additional links
Click Add link to add an additional link; you can have a maximum of four.
5
Upload custom icon
Upload a custom icon for your link.
6
Specify link title
Specify a Title for the link (required).
7
8
Specify link subtitle
Specify a Subtitle for the link (required).
9
Specify button text
Specify the Button text for the link (required).
10
Specify button URL
Specify a Button URLfor the link, which will be launched when the user clicks the button (required). Button URLs support the following URL schemes:
-
http:// or https://
- Opens in the default browser, which is Safari unless the user has selected a different one.
-
mailto://
- Opens in the default mail app, which is Mail unless the user has selected a different one.
- On iOS and iPadOS, if the user hasn’t yet configured a mail account, tapping a mailto:// bookmark results in an error.
-
file:// (only supported on macOS) For more information about file paths in macOS, please refer to Apple’s documentation.
- Opens a file from a specified path.
- Using three consecutive slashes, such as file:///path/to/file when defining file paths is recommended.
11
Restore defaults (optional)
If you need to restore the provided defaults, click Restore defaults.
12
Save customizations
Click Done when you are done with your customizations.
Exit Password
Liftoff has an exit password that can be used when Liftoff is in Full Screen or Window mode. In either case, the exit password can be used in the following scenarios:- The exit password can be used to unlock Full-screen mode, which allows for troubleshooting if Library Items are not installed as intended. This is only applicable when using full-screen mode.
-
The exit password can be used to quit the app through the menu bar before the agent run completes; this additionally unloads the launch agent.
- This can be done after using the exit password to release Liftoff from Full Screen or Window mode. Window mode initially does not allow an early exit or show the Quit option in the menu bar.
-
To open the Exit Password prompt, press these keys simultaneously: Command-Shift-K-J-D.
Liftoff Logic Flow
Evaluation of Liftoff Library Item
- If there’s no Liftoff configuration in the Blueprint, the Kandji agent will note that Liftoff is not eligible and won’t try to retrieve the configuration again.
- If a Liftoff configuration is present in the Blueprint, the details will be fetched.
Enrollment Triggers
- Automated Device Enrollment Only or Manual Device Enrollment Only: The agent will check the Mac’s enrollment type. If it doesn’t match the criteria, the agent will record that Liftoff is not eligible and won’t try to retrieve the configuration again.
- All Enrollments: The agent will skip evaluating the enrollment type.
Eligibility Check
- If the enrollment criteria are met, the agent will evaluate the duration of the Mac’s enrollment.
- If the Mac has been enrolled for more than 1 hour, the agent will record that Liftoff is not eligible and won’t try to retrieve the configuration again.
- If all criteria are satisfied, the macOS agent will load the LaunchAgent to start Liftoff and initiate an initial check-in.
Running Parameters with Liftoff
- If there’s no Liftoff configuration in the Blueprint, the Kandji agent will run all Parameters and then all Library Items in the Blueprint.
- If a Liftoff configuration is present in the Blueprint, the Kandji agent will run all Library Items first, followed by all Parameters in the Blueprint.
Other Considerations
When using Liftoff with macOS Tahoe, ensure the OS Showcase screen is skipped in both your Automated Device Enrollment (ADE) configuration and Setup Assistant Library Item to prevent configuration interruptions.
Device Localization
When a user configures their macOS device to use one of the supported languages as its primary language, Liftoff displays localized text for non-customizable strings. No admin configuration is required to enable this capability. The following languages are supported:- Chinese (Simplified)
- French / French (Canada)
- German
- Italian
- Japanese
- Portuguese
- Portuguese (Brazil)
- Spanish