The branding_theme utility is used for working with custom themes that enable you to change appearance and branding settings for Plesk installations. For detailed information about working with custom themes, refer to the Administrator’s Guide > Using Custom Skins.

Usage 

branding_theme <command> <option 1> <param>

Example

The following command retrieves the default Plesk theme package and saves it in a ZIP archive:

plesk bin branding_theme -p -name default -destination /usr/local/psa/theme.zip

Commands

Command Parameter Description Example

--pack

or

-p

   Retrieves the specified Plesk theme package and saves it in a ZIP archive.

To retrieve the default Plesk theme package and save it to the file theme.zip:

plesk bin branding_theme --pack -name default -destination /usr/local/psa/theme.zip

--install

or

-i

  

Installs a custom Plesk theme from the specified location.

If you do not specify the -vendor, than the theme will be applied only for the Plesk administrator.

When you install the theme, it is automatically applied to UI. To apply another theme that was installed previously, use the --set command.

To install the theme that should be available for the server administrator:

plesk bin branding_theme --install -vendor admin -source /usr/local/psa/theme.zip

To install the theme that should be available for the reseller with username JDoe:

plesk bin branding_theme --install -vendor "JDoe" -source /usr/local/psa/theme.zip

--uninstall

or

-u

  

Removes a specified custom Plesk theme.

The name <theme name> is the name specified in meta.xml file of the theme archive.

To remove a theme named green:

plesk bin branding_theme -u -name green

--set

or

-s

  

Activates one of the installed Plesk themes: The specified theme will be applied to Plesk UI.

This theme should have been installed and has the name <theme name> specified in its meta.xml file.

If you do not specify the -vendor, than the theme will be applied only for the Plesk administrator.

To apply the theme green to the Plesk UI for the reseller with username JDoe:

plesk bin branding_theme --set -name green -vendor "JDoe"

--list

or

-l

   Displays the list of all installed Plesk themes.

To view the list of all installed themes:

plesk bin branding_theme --list

--help or -h   Displays a help reference for the utility.

To see the help info on the use of this utility:

plesk bin branding_theme --help

or

plesk bin branding_theme -h

Options

Option Parameter Description Example
-name <theme name>

Specifies the name of a custom theme. This is the name specified in meta.xml file of the theme archive.

Required with the -pack and -uninstall commands.

To install the theme with the name mytheme that should be available for the server administrator form the file theme.zip:

plesk bin branding_theme --install -name mytheme -vendor admin -source /usr/local/psa/theme.zip

-source

 <path/filename.zip>

Specifies the path to a ZIP file with a custom theme.

Required with the -install command.

  
-vendor <username>

Specifies whether the theme is related to the server administrator or a reseller.

Used optionally with the --install and --set commands. If you do not use this option, the theme will be related to the Plesk administrator.

  
-destination <path/filename.zip>

Specifies the path and file name for saving the theme.

Required with the -pack command.

To retrieve the Plesk theme package named green and save it to the file greentheme.zip:

plesk bin branding_theme --pack -name green -destination /usr/local/psa/greentheme.zip