-
Notifications
You must be signed in to change notification settings - Fork 72
Features
- Menu Bar Icon
- Title and logo
- Color
- Diagnostic information
- App, URL, command and privileged script
- Footer Text
- Notification Icon
- Welcome Screen
- Software Update integration
- App Catalog integration
- Last Reboot
The Menu Bar Icon can be customized to your own image such as a PNG with Alpha Channel, an image from URL or an SF Symbol. Any image will be shown as template to match the rest of the Menu Bar Extras. Icons larger than 22 points will automatically be resized to the recommended 16 points and the aspect ratio will be preserved. Optionally a notification badge can overlay the icon to attract the user's attention when an Apple Software Update is available or any other warning was triggered. Please check the preference key StatusBarIconNotifierEnabled.
Note When using a local file, make sure to put the image in a folder accessible from the App Sandbox. We recommend a subfolder in
/Library/Application Support/such as/Library/Application Support/MyOrganization
Note When using an file from URL, the image will be downloaded once when the Support App opens and will be used for subsequent launches of the app, to avoid unnecessary downloads and use cases where the Mac has no internet connection at startup. To use a new icon, the URL must be changed for the Support App to trigger a new download.
The row above the buttons allow a custom title and company logo. The title supports both text and Emoji. On macOS Monterey and higher, it supports Markdown as well. The logo supports a remote URL, an SF Symbol and several local images types like PNG, JPEG and ICNS and will be resized to a maximum height of 48 points. The original aspect ratio will be retained. A PNG with alpha channel is advised to get variable transparency around your logo.
Here are the available for the Logo:
-
Remote URL:
https://URL_TO_IMAGE -
SF Symbol:
SF=SF_SYMBOL_NAME_HEREorSF=SF_SYMBOL_NAME_HERE,color=COLOR_OPTION_HERE. Available color options:auto,multicolor,hierarchicalor a custom HEX color code such as#9ACEA4 -
Local file:
/PATH_TO_LOCAL_FILE
Note When using a local file, make sure to put the image in a folder accessible from the App Sandbox. We recommend a subfolder in
/Library/Application Support/such as/Library/Application Support/MyOrganization
All the circles around the symbols have the macOS accent color and will dynamically change with the user's setting in System Preferences --> General. If desired, this color can be customised matching your corporate colors. We recommend keeping the macOS accent color when the color of your choice is too light, as text will be difficult to read.
There are a couple of info items with diagnostics available to choose from. A total of four items will be displayed in the top four buttons. Available items:
-
Computer Name (default): The current computer name will be displayed here. Especially helpful when your organisation has a difficult naming convention and users want to do things like AirDrop.
-
macOS version (default): The current version of macOS including major, minor and patch version as well as the marketing name. The marketing name will be easier to understand for your end users. A notification badge will be shown when an Apple Software Update is available. Clicking on this item shows more details and allows the user to initiate the update in System Settings. Additionally there is support for updates enforced by Declarative Device Management and the enforcement date/time is shown if a valid update declaration is detected.
-
Last Reboot (default): The current uptime. When troubleshooting some issue, the first thing you would like to do is a reboot when the uptime is high. The optional preference key
UptimeDaysLimitcan be used to configure the maximum amount of uptime days recommended by the organization. Exceeding this limit results in a badge counter with exclamation mark in the info item. Users can also restart the Mac gracefully from this info item. -
Storage Used (default): The storage percentage used on the boot drive. When hovering with the mouse, the available storage is shown. Clicking on this item opens the macOS built-in Storage Management app. The optional preference key
StorageLimitcan be used to configure the maximum percentage of used storage recommended by the organization. Exceeding this limit results in a badge counter with exclamation mark in the info item. -
Network: The active network interface type (Wi-Fi or Ethernet) along with the local IPv4 address. The icon indicates the connection type, Wi-Fi or Ethernet. Clicking on this item opens the Network preference pane in System Preferences. On macOS 13 or earlier, the current SSID name is shown. Due to privacy restrictions, macOS 14 and later show "Wi-Fi" instead of the SSID name.
-
Mac Password: Shows when the user's password expires and supports both local and Active Directory accounts by default. Alternative supported user sources are Jamf Connect, Kerberos SSO Extension and NoMAD. Shows a warning when the expiry reaches the value set in the optional key
PasswordExpiryLimit. The text label in the item can be modified using the preference keyPasswordLabel. -
Extension A and B: Support App Extensions to show any information. The title, icon must be configured and optionally a link to open an App, URL, User Command or Privileged Command/Script. The value below the title of the Extension must be populated by setting a preference key using a script or command. Extensions can also trigger an orange notification badge alert in both the Extension and menu bar icon. See Extensions for more information.
-
App Catalog: Show available app updates driven by Root3's App Catalog. It allow users to quickly update applications and show when the automatic update schedule will run next. This integration requires a valid App Catalog subscription and a free trial is available.
Items can behave as shortcuts to organization resources.
-
Title: Primary label
-
Subtitle (now shown if not configured): An extra string to display when the user hovers over the button
-
Action Type: The link type the button should open. The following action types are available:
- App
- URL
- Command
- Privileged Script
-
Action: Application, URL or command/script to execute:
- App: Bundle Identifier of the app
- URL: Link to a webpage or other links that would normaly work like PROTOCOL://URL
- Command: Zsh command or path to a script. Be aware that this will be executed as the user and therefore has its limitations
- PrivilegedScript: Path to script to be executed with elevated privileges
-
Symbol: The SF Symbol shown in the button
A footer text can optionally be used to put some additional text at the bottom of the Support App. This supports both text and Emoji. On macOS Monterey and higher, it supports Markdown. Also a great way to put additional information using Built-in local variables Use the preference key FooterText to configure the footer.
The icon shown the about window can be modified by using the preference key NotificationIcon.
See an example below:
Note When using a local file, make sure to put the image in a folder accessible from the App Sandbox. We recommend a subfolder in
/Library/Application Support/such as/Library/Application Support/MyOrganization
Note When using an file from URL, the image will be downloaded once when the Support App opens and will be used for subsequent launches of the app, to avoid unnecessary downloads and use cases where the Mac has no internet connection at startup. To use a new icon, the URL must be changed for the Support App to trigger a new download.
Note Modifying the app icon when it is not running would compromise the App Sandbox and we decided not to implement this. We suggest hiding the app by running the following command:
sudo chflags hidden "/Applications/Support.app"
An informational window can optionally be shown when the Support App is opened for the first time. It explains the key features to the user before all data is shown. This can be set using the preference key ShowWelcomeScreen.
The Support App shows the current version of macOS and a notification badge if there is an update or upgrade available. Clicking the info item shows more details like the name of the update(s) available and also allows organizations to add a custom text. This can be used to provide more context and explain the user about the organization's update policy or anything else. The text string supports Markdown to style it further and include links. Please check Built-in local variables for an example using Markdown and variables.
It allows the user to open System Settings and install the update or upgrade. If there is no update or upgrade available, the popover simply shows "Your Mac is up to date".
If an update declaration is sent using Declarative Device Management (macOS 14 and higher), the available update will show the enforcement date and time for the update. If present in the declaration, the DetailsURL will also show a button "Details" and opens the DetailsURL link.
Note When a deferral is set using the preference key
forceDelayedMajorSoftwareUpdatesin the domaincom.apple.applicationaccess, major macOS updates will automatically be hidden indefinitely until the key is removed or set tofalse. The amount of days configured for the deferral are ignored. Due to limitations and complexity, it is not supported to automatically show the macOS major update once the deferral days are passed. This behaviour replaces theHideMajorUpdateskey, previously available in version 2.5 and earlier. More info here: https://developer.apple.com/documentation/devicemanagement/restrictions
The Support App integrates with Root3's App Catalog. The App Catalog is an automated patch management solution for third party macOS applications. It provides unique features such as a daily update schedule, updating both managed and unmanaged apps and a user facing app to quickly install new applications. As some app updates require user interaction, users may defer an update and want to update at a more convenient time. The Support App periodically checks for available app updates and allows the user to update apps whenever they prefer in an accessible way. The menu bar icon also shows a red notification badge when an update is available to inform the user, similar to macOS updates when StatusBarIconNotifierEnabled is set to true.
If UptimeDaysLimit is set and the user click on the Last Reboot Info Item, a view is shown where the administrators reboot recommendation is shown. It also provides a button to quickly perform a graceful restart without leaving the Support App.