Support Companion v1

Configures the name shown in the navigation menu.

Configures the brand color shown in the app, available colors are: Blue, Green, Red, Orange. Defaults to Blue if not configured.

Range: Blue, Green, Red, Orange

Configures the brand logo shown in the apps side menu. Specify a local path or Base64 string.

Configures the URL to open when the user clicks on the Get Support button.

Configures the URL to open when the user clicks on the Change Password button.

Configures the mode for the Change Password button, available modes are: local, SSOExtension, url. Defaults to local if not configured.

Range: Local (local), SSO Extension (SSOExtension), URL (url)

Configures the email address shown when the user clicks on the Support Info button.

Configures the phone number shown when the user clicks on the Support Info button.

Configures whether to show the menu toggle button in the apps side menu.

Default: false

Configures which widgets to hide, available widgets are: DeviceInfo, MunkiPendingApps, MunkiUpdates, IntunePendingApps, IntuneUpdates, Storage, MdmStatus, Actions, Battery, EvergreenInfo.

Configures which actions to hide, available actions are: Support, ManagedSoftwareCenter, ChangePassword, Reboot, KillAgent, SoftwareUpdates, GatherLogs.

Configures the interval for notifications in hours for Application Updates and Software Updates notifications.

Range: 1 – 24

Configures the title for notifications for notifications. Defaults to Support Companion if not configured.

Configures an image to add to notifications. Local path should be specified.

Configures the message for notifications for Software Updates notifications. Defaults to "You have software updates available. Take action now! \ud83c\udf89" if not configured.

Configures the button text for notifications for Software Updates notifications. Defaults to "Details \ud83d\udc40" if not configured.

Configures the message for notifications for App Updates notifications. Defaults to "You have app updates available. Take action now! \ud83c\udf89" if not configured.

Configures the button text for notifications for App Updates notifications. Defaults to "Details \ud83d\udc40" if not configured.

Configures custom colors for the app, should be specified in hex format, see example below. Do not use BrandColor in conjunction with this key.

Configures the app to use Intune for application information. Only supports PKG and DMG type apps, not LOB.

Default: false

Configures the app to list all applications installed under /Applications and their versions. Useful if Munki or Intune is not used.

Default: false

Configures the log folders to gather logs from. Only used when gathering logs. Defaults to "/Library/Logs/Microsoft" if not configured.

Configures custom actions to add to the tray menu. See example below.

Configures the desktop info widget.

Default: false

Configures the position of the desktop info. Defaults to TopRight.

Default: "TopRight"

Range: Top Left (TopLeft), Top Right (TopRight), Bottom Left (BottomLeft), Bottom Right (BottomRight)

Configures the level of information to show on the desktop. Defaults to Full.

Range: Full, Minimal, Hardware, Custom

If DesktopInfoLevel is set to Custom, use this array to determine which information to show. Available info are: HostName, Model, SerialNumber, Processor, IpAddress, MemSize, OsBuild, OsVersion, LastBootTime, StorageInfo, SupportPhone, SupportEmail, Separator.

Configures the background color for the desktop info. Configure using Hex format. Defaults to Transparent

Configures the position of the desktop info. Defaults to 100%.

Default: 1

Range: 10% (0.1), 20% (0.2), 30% (0.3), 40% (0.4), 50% (0.5), 60% (0.6), 70% (0.7), 80% (0.8), 90% (0.9), 100% (1)

Configures whether to highlight the text in the desktop info. Defaults to true.

Default: true

Configures the font size for the desktop info. Defaults to 17.

Default: 17

Range: 8 – 24

Configures a path to a JSON file containing custom widgets to show on the Home view.

Configures the Primary Color for the app.

Configures the Accent Color for the app.

Name of the action to show in the menu.

Command to run when to item is clicked.

Icon to show in the Self Service page in the UI.