Customizing Veeam Agent Control Panel

You can customize the appearance and behavior of the Veeam Agent control panel that runs on protected computers. For example, you can match the Veeam Agent branding to your company brand, or hide specific interface elements from end users.

You can apply customization settings in one of the following ways:

• From Veeam Backup & Replication — you configure customization settings for a protection group in the Veeam Backup & Replication web UI, and Veeam Backup & Replication applies these settings to all Veeam Agents in the protection group.
• Locally on the protected computer — you place branding files and a configuration file in a dedicated folder on the protected computer and restart the Veeam Agent tray application to apply the settings.

Customizing from Veeam Backup & Replication

You can configure customization settings for all computers in a protection group at once. Veeam Backup & Replication applies the settings to the protected computers during the next protection group rescan.

To customize the Veeam Agent control panel for a protection group:

1. In the management pane, click Protection Groups.
2. Right-click the necessary protection group, or select the protection group and select Customize from the Other Actions drop-down list.
3. In the Customize window, on the User Interface tab, specify the appearance settings for the Veeam Agent control panel:

• In the Logo text field, enter the text that will appear in the header of the Veeam Agent control panel. The text can contain up to 16 characters.
• In the Logo icon field, click Browse and select a 20×20 PNG file to use as the logo icon.
• In the Tray icon field, click Browse and select a 16×16 ICO file to use as the tray icon. The tray icon is static — the backup activity animation is not applied to custom icons.
• In the Accent color field, specify the HEX color code to use as the accent color in the Veeam Agent control panel.

4. Click the Settings tab to specify behavior settings for the Veeam Agent control panel:

• Select the Hide manual backup run buttons check box to hide the buttons that allow end users to start a backup manually.
• Select the Hide About tab check box to hide the About tab in the Veeam Agent control panel.
• Select the Hide Support tab check box to hide the Support tab in the Veeam Agent control panel. The Submit Feedback and Technical Support options in this tab are also hidden.
• Select the Hide tray icon check box to hide the Veeam Agent tray icon on protected computers.
• To use a custom help center link instead of the default one, turn on the Change link to online help option and specify the URL in the Custom link for help center field.

5. Click Apply.
6. Rescan the protection group to distribute the new settings to Veeam Agents. After the rescan finishes, restart the Veeam Agent tray application on each affected computer to make the new settings take effect.

To revert all customization settings back to their defaults, in the Customize window, click Reset to Default, click Yes in the confirmation window and rescan the protection group.

Customizing Locally on Protected Computers

You can apply customization settings directly on a protected computer by placing branding files and a configuration file in a dedicated folder. This method does not require Veeam Backup & Replication and is applied only to the local computer.

To apply customization settings locally:

1. On the protected computer, navigate to the C:\ProgramData\Veeam\EndpointBranding\ folder.
2. To replace the tray icon, place a 16×16 ICO file named TrayLogo.ico in the folder.
3. To replace the control panel logo icon, place a 20×20 PNG file named MainWindowLogo.png in the folder.
4. To customize the accent color and control panel settings, copy the Config.template.xml file to Config.xml in the same folder and set the following attributes on the BrandingConfiguration element:

• [Optional] Specify the accent color for the Veeam Agent control panel. To do this, set the AccentColorCode value to the color code in hexadecimal format, for example "#1F6AFF". If you leave the value empty, Veeam Backup & Replication uses the default product color.
• [Optional] Specify custom text to display in the header of the Veeam Agent control panel. To do this, set the MainWindowHeaderText value to the necessary text. The text can contain up to 16 characters. If you leave the value empty, Veeam Backup & Replication uses the default text.
• [Optional] Specify a custom URL for the Online Help link on the Support tab of the Veeam Agent control panel. To do this, set the CustomHelpCenterLink value to the necessary URL. If you leave the value empty, Veeam Backup & Replication uses the default URL.
• Set the HideManualBackupRuns value to "True" if you want to hide the Backup Now button and other manual backup controls in the Veeam Agent control panel. The default value is "False".
• Set the HideAboutTab value to "True" if you want to hide the About tab in the Veeam Agent control panel. The default value is "False".
• Set the HideSupportTab value to "True" if you want to hide the Support tab in the Veeam Agent control panel. The default value is "False".
• Set the HideTrayApp value to "True" if you want to hide the Veeam Agent tray icon in the notification area. The default value is "False".

Do not modify the Version attribute.

5. Restart the Veeam Agent tray application. To do this, exit the tray application, and then run Veeam Agent for Microsoft Windows from the Windows Start menu.

To reset local customization settings:

1. On the protected computer, navigate to the C:\ProgramData\Veeam\EndpointBranding\ folder.
2. Rename or remove the Config.xml file and remove all custom ICO and PNG files.
3. Restart the Veeam Agent tray application.