Repository navigation
Using the app
Written from the point of view of the person in front of the Mac.
A menu bar icon appears when the app starts. Clicking it opens a popover with compact cards, your actions and a button to open the main window.
The Dock icon appears only while the main window is open. That keeps the app out of the way, and lets an administrator start it from a script or a terminal without anything appearing on screen — starting it that way is also what sends the user notifications about, for example, waiting software updates.
TrayMenuShowIcon set to false removes the menu bar item altogether.
The sidebar carries Home, Apps, Identity, and whichever of Self Service, Compliance, Company Portal, Knowledge Base, your Markdown page and your custom cards page you have configured. Items with something waiting — pending updates, failing checks — carry a badge.
The toolbar has a support button, which shows your support email and phone, and a light/dark toggle. The toggle is the user's own choice and is remembered; it does not follow the system unless they set it back to system.
If you have enabled it, an Elevate button appears on the home page and in the menu bar popover. The user may have to type a reason. While the window is open the menu bar shows the time remaining, and a notification's Demote button hands the rights back early. See Admin elevation.
Where a self-service catalog exists, it is on the Apps page. Where User installs is enabled,
right-clicking a .pkg or .dmg in Finder offers Install with Support Companion.
The app registers supportcompanion://. Useful from scripts, from your own notifications, or from a
Self Service policy.
| URL | Opens |
|---|---|
supportcompanion://home |
Home |
supportcompanion://apps |
Apps |
supportcompanion://identity |
Identity |
supportcompanion://selfservice |
Self Service |
supportcompanion://compliance |
Compliance |
supportcompanion://companyportal |
Company Portal |
supportcompanion://knowledgebase |
Knowledge Base |
supportcompanion://markdown |
Your Markdown page |
Anything unrecognised opens Home.
Actions have their own form, which is what the CLI uses:
open "supportcompanion://run?action=Run%20Munki%20Check"The action must exist in Actions. A privileged one still authenticates first if
RequirePrivilegedActionAuthentication is set.
If you need logs from someone, "Gather Logs" collects the folders for the current mode into a zip. Troubleshooting covers what to look at.