The branding utility is used for setting up your own branding for Plesk by modifying the page title and logo. See more information about the Plesk page title and logo. This utility can also be used to change the Plesk login page’s background color, and also to add an image to it.

Usage 

branding <command> <option 1> <param>

Example

The following command replaces the default Plesk logo with image.png stored in the /tmp directory.

plesk bin branding --custom-logo -file /tmp/image.png

Commands

Command Description Example
--custom-title Sets the custom page title.

To set the page title to “My Hosting”:

plesk bin branding --custom-title 'My Hosting'

--custom-logo

Changes the default Plesk logo to one stored in a directory or accessible by a URL.

Used with the -file and/or -url options.

To set the custom image.png logo stored in the /tmp/ directory:

plesk bin branding --custom-logo -file /tmp/image.png

--reset-title Returns the default page title.

To bring back the default page title:

plesk bin branding --reset-title

--reset-logo Returns the default logo.

To bring back the default logo:

plesk bin branding --reset-logo

--set-custom-background Change the Plesk login page’s background color, and/or add an image to it.

To change the Plesk login page’s background color to light blue and to add the /tmp/background.jpg image to the center of the login page:

plesk bin branding --set-custom-background -color '#31a7dc' -fit center -file /tmp/background.jpg

--reset-custom-background Reset the Plesk login page’s background color to the default one, and/or to remove the image from it.

To reset the Plesk login page’s background color to the default one and remove the image from it:

plesk bin branding --reset-custom-background color,file,fit

--show Shows the Plesk login page’s current background color’s HEX code and the URL or path to the image that is currently added to it (if any). Can be used with the -json true option to see the output in JSON.

To see the Plesk login page’s current background color’s HEX code and whether an image was added to it:

plesk bin branding --show

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

To see the utility help:

plesk bin branding --help

Options

Option Parameter Description Example
-file <path>/<imagename>|<URL> Specifies the path or URL to the custom logo or to the image to be added to the login page.

To set the custom image.png logo stored in the /tmp/ directory:

plesk bin branding --custom-logo -file /tmp/image.png

To set the custom image.png logo hosted in https://example.com:

plesk bin branding --custom-logo -file https://example.com/image.png

-url <URL> Specifies the URL that will be opened upon clicking the logo image.

To have https://example.com opened upon clicking the logo image:

plesk bin branding --custom-logo -url https://example.com

-color <HEX code> Specifies the login page’s background color.

To change the Plesk login page’s background color to light blue:

plesk bin branding --set-custom-background -color '#31a7dc'

-fit <fill|fit|center|tile> Specifies the position of the image added to the login page.

To position the image added to the login page in the center of the screen:

plesk bin branding --set-custom-background -fit center

-json <true|false> Specifies whether to show the output of the plesk bin branding --show command in JSON.

To see the output of the plesk bin branding --show command in JSON:

plesk bin branding --show -json true

Setting a custom Plesk favicon

You can replace the default favicon of your Plesk installation with an image of your choice. For example, you can replace the default favicon with the logo of your company for the sake of branding.

Setting a custom favicon

  1. Upload the images with names “favicon.ico” and “favicon.svg” to the “/tmp” directory of the server.

  2. Move the files to the destination folder by running the following commands:

    mv /tmp/favicon.ico /$PRODUCT_ROOT/admin/htdocs/images/logos/favicon.custom.ico

    and

    mv /tmp/favicon.svg /$PRODUCT_ROOT/admin/htdocs/images/logos/favicon.custom.svg

Now the default Plesk favicon is replaced with your image. You will see the new favicon on the browser tab.