Configure and Deploy

Once you have figured out which super options you prefer, you can deploy the configuration via command line, your own custom script, or a MDM configuration profile.

Install via Command Line or Script

The super script automatically installs itself (and various other accoutrements) anytime it's run from outside its working folder /Library/Management/super/. This installation location is acceptable for most administrators so there is not a super option to modify this default path. However, because super is a bash script, you can easily modify the SUPER_FOLDER="/Library/Management/super" parameter via any text editor prior to running or deploying super.

During initial super installation you can also specify any optional configuration settings in the same command line. Further if you have deployed a super MDM configuration profile, then super will always defer to those settings even during initial installation.

Reinstall or Update `super` Itself

New versions of super can always be installed on top of older versions. The super script automatically installs itself (and various other accoutrements) anytime it's run from outside its working folder /Library/Management/super/. To reinstall or update super itself, simply run the script again from outside its working folder. While updating super to a new version is always recommended, reinstalling the same version of super almost never solves workflow issues. Other troubleshooting methods are often more successful than simply reinstalling super.

In the same vein, while updating super is quite simple, there are often significant changes between super versions that require you to reconsider your specific super configurations. A major version upgrade (like 4.x to 5.x) of super indicates significant configuration changes such that settings for an older version of super are not compatible. If you have a working configuration for super version 3.0 you can upgrade your settings to support super version 5.x. There is no upgrade path for versions of super prior to version 3.0.

Many super 4.x command line options and managed preferences are NOT compatible with super 5.1.x
Most super 3.0 command line options and managed preferences are NOT compatible with super 5.1.x
Previously saved super 3.0 and 4.x Apple silicon authentication credentials are automatically migrated the first time super 5.1.x runs.
Refer to this spreadsheet (tab separated values) for migrating super command line options.
Refer to this spreadsheet (tab separated values) for migrating super managed preferences.
Updated example MDM configuration profiles.
Updated Jamf Pro External Application Custom Schema.
Updated Jamf Pro Extension Attribute scripts.

Configure via Command Line or Script

After installation, super maintains settings files similar to a regular application. This means that most super options passed in via command line or script are automatically saved the first time you use them. For example, you only need to use the --test-mode option once. After that, every time you run super, it remains in test mode until you disable it. To disable test mode, you use the --test-mode-off option. You can find out more about super test mode here.

The main super settings file default location is /Library/Management/super/com.macjutsu.super.plist. While you can technically edit this settings file directly, you should avoid this and simply use the built-in super options. Further, there are a variety of advanced alternate configuration options for those requiring more sophisticated deployments.

Reset Local Settings

Delete locally saved configuration in the main super settings file and delete workflow caches.

Command option examples:
--reset-super or -x or -X

Sometimes the main super settings file may contain previously configured options and workflow caches that are causing unexpected results, so resetting this can help resolve issues. This option cannot be set via a MDM configuration profile. However, any other options that are specified via a super MDM configuration profile remain in effect as long as the super workflow remains active.

This option does not delete any local credential options, Jamf Pro API credential options, or advanced alternate configurations. However, you can also use this option along with the --auth-delete-all option to also delete any saved local credential options or Jamf Pro API credential options. Additionally, you can use the --config-delete-all option to disable and delete any advanced alternate configurations.

MDM Configuration Profile

If there are specific super options you plan to set "permanently," then you should consider deploying these via a MDM configuration profile. In addition to over-the-air deployment, using a MDM configuration profile also allows you to enforce your options. In other words, if a specific super option is deployed via a MDM configuration profile, then it cannot be ignored or changed via local command options.

The MDM configuration profile specification allows for custom settings deployed via application-specific preference domains. In the case of super, the preference domain is com.macjutsu.super. Throughout this Wiki, you'll find configuration profile example text detailing the option-specific XML-formatted keys to be used in the super MDM configuration profile.

The super repository contains a variety of MDM configuration profile example files:

DO NOT DEPLOY the "all options" examples as is. They are for example only and contain conflicting example options that cause errors if deployed as is. You should evaluate all example options for your specific environment by removing any options that are not required and auditing any remaining options for appropriateness.

The ".plist" examples need to be inserted into a new MDM configuration profile payload, whereas the ".mobileconfig" examples are already complete. Consult your vendor-specific MDM documentation for importing custom configuration profiles.

Display Configuration Status

Show the current status of a wide variety of system and super related items.

Command option examples:
sudo super --config-status

While this option does require root permissions, it does not start or interrupt any super workflow. The output from this option is ideal for troubleshooting configuration issues without having to interrogate any super log files. Further, the output from this option does not contain any saved credential details, so it's ideal for sharing with others to assist in your troubleshooting efforts.

Configuration status shown by this option includes: