Liftoff

Learn how to configure and leverage Kandji Liftoff.

Liftoff Workflows 

We encourage customers to duplicate their existing Blueprints and to create a testing Blueprint to fully validate Liftoff against their current workflows. Custom scripts, apps, etc., that may wait on user input will be potentially blocked from view and would cause Liftoff to hang until the agent check-in times out. 

When Does Liftoff Launch on a Mac?

Liftoff has logic to determine when it should launch on a Mac. The current logic flow is described below. For a new Mac enrolling via Automated Device Enrollment, Liftoff should launch immediately after the macOS Setup Assistant ends and the user is logged in. Liftoff supports Automated Device Enrollment workflows in which a user is automatically provisioned as the Auto Admin account. 

  • If the Mac is running macOS 10.13, Liftoff will not launch. 
  • Once a Mac is running Kandji Agent version 2.9.1 (1546) or later, on the next check-in the agent will call a dedicated Liftoff endpoint.
    • If no Liftoff configuration exists in the Blueprint, the macOS agent will record that Liftoff was not eligible and will not attempt to retrieve the configuration again.
  • If there is a Liftoff configuration within the Blueprint, the details will be retrieved.
    • If the enrollment trigger is set to Automated Device Enrollment only or to Manual Device Enrollment only, the agent will evaluate the Mac computer's enrollment type. If the device's enrollment type does not meet the criteria, the macOS agent will record that Liftoff was not eligible and will not attempt to retrieve the configuration again.
    • If All Enrollments is specified, the agent will not evaluate the enrollment type. 
  • If the enrollment criteria make the computer eligible to run Liftoff, the time period in which the computer has been enrolled will be evaluated.
    • If the length of time of the Mac computer's enrollment is more than 1 hour, the macOS agent will record that Liftoff was not eligible and will not attempt to retrieve the configuration again.
  • If all criteria to run Liftoff is met, the macOS agent will then load the LaunchAgent that will launch Liftoff and begin an initial check-in.

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, allowing for troubleshooting if library items are not installing as intended. This is only applicable when using Full Screen mode.
  • The exit password can be used to quit the app prior to the agent run completing, through the Menu bar; 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.

    exit password

Required Restarts

If a single or multiple library items require a restart—such as a custom app or script with the "Require restart" option enabled—all restart requests will be collated and held until the end of the Liftoff run. When a library item that is installed through Liftoff requires a restart, the restart timer will always be 5 minutes instead of the typical 30-minute countdown. 

What Liftoff Shows

Liftoff does not change the way a Mac computer's initial agent check-in works after enrollment. It simply displays information about the check-in that would typically be visible only via the Kandji web app or the Command Line Utility; it gives users visibility into what is being set up on their Mac. Liftoff shows the following library item types:

  • Custom Apps;
  • Custom Scripts;
  • Custom Printers;
  • Auto Apps;
  • Managed OS.

Configure Liftoff

To add Liftoff to a Blueprint in your instance, you create a new Liftoff library item by selecting it from the Add Library Item page (Library > Add New). Similar to Automated Device Enrollment, you can only have a single Liftoff library item per Blueprint. 

  1. Give your Liftoff configuration a Name.
  2. Assign the Liftoff configuration to a Blueprint; we recommend using a test Blueprint at first.
  3. Select your Enrollment trigger, your available options are:
    1. All enrollments: Liftoff will be presented regardless of enrollment type.
    2. Automated Device Enrollment only: Liftoff will only be presented to devices enrolled via Automated Device Enrollment.
    3. Manual enrollment only: Liftoff will only be presented to devices enrolled via Manual device enrollment.
  4. Upload a Logo—a graphic that will appear in the upper lefthand corner of Liftoff. This is optional. 
  5. Upload a Dark mode logo, which will be used instead of the main logo when Dark Mode is enabled by the user. 
  6. Select a Display mode. We recommend using Window for initial testing for easy troubleshooting. Your display mode options are:
    1. 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. 
    2. 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. An Exit password is automatically generated. Learn how to use the exit password above. 
  8. Clicking Generate new password and clicking Save will replace the existing exit password. A replaced exit password is not logged. 
  9. Customize the Install screen header and subheader; see the Customize the Install Screen section below.
  10. Switch between Light Mode and Dark Mode previews. 
  11. Customize the Help screen header and body; see the Customize the Help Screen section below.
  12. Switch between Light Mode and Dark Mode previews. 
  13. Optionally enable the Complete screen. If the Complete screen is not enabled, Liftoff will exit after completion. 
  14. Customize the Complete screen header, subheader, and cards. See the Customize the Complete Screen section below.
  15. Switch between Light Mode and Dark Mode previews. 
  16. Click Save when you are satisfied with your Liftoff configuration. 

    CleanShot 2021-06-16 at 14.09.43@2x


Customize the Install Screen

The Install screen's header and subheader can be customized.

  1. Specify a Header for the Install screen. 
  2. Specify a Subheader for the Install screen. 
  3. You can restore the default text provided by clicking Restore defaults.
  4. Click Done when you are finished with your customizations. The preview in the web app will update reflecting your changes. 

    installscreensmall

Customize the Help Screen

The Help screen's header and subheader can be customized.

  1. Specify a Header for the Help screen. 
  2. Specify a Body for the Help screen. 
  3. You can restore the default text provided by clicking Restore defaults.
  4. Click Done when you are finished with your customizations. The preview in the web app will update reflecting your changes.

helpscreensmall

Customize the Complete Screen

The Complete screen's header and subheader can be customized.

  1. Specify a Header for the Complete screen. 
  2. Specify a Subheader for the Complete screen. 
  3. Click and drag the drag-and-drop icon to reorganize the links. 
  4. Click the trash icon to delete a link. 
  5. Click Add link to add an additional link; you can have a maximum of four. 
  6. Upload a custom icon for your link. 
  7. Specify a Title for the link (required).
  8. Specify a Subtitle for the link (required).
  9. Specify Button text for the link (required).
  10. Specify a Button URL for the link, which will be launched when the user clicks the button (required).
  11. If you need to restore the provided defaults, click Restore defaults
  12. Click Done when you are done with your customizations.
     CleanShot 2021-06-16 at 14.52.46@2x