Articles in this section

How to change Plesk title, logo, favicon and background image for login screen

DoNotDelete:docref kb: how-to

Question

How to change Plesk title, logo, favicon and background image for login screen?

Answer

Starting on Plesk version 18.0.59 the ability to configure a custom background for the login page was added at Tools & Settings > Branding under Plesk Appearance section.
The following items can be edited:

  • Custom title:

    Screenshot 2024-02-16 at 16.23.09.png

  • Custom Logo:

    Screenshot 2024-02-16 at 16.24.23.png

  • Custom Favicon:

    Screenshot 2024-02-16 at 16.25.05.png

  • Custom Background:

    Screenshot 2024-02-16 at 16.28.39.png

The supported file formats for these customizations are *.apng, *.avif, *.bmp, *.gif, *.ico, *.jpeg, *.png, *.svg, *.tiff, and *.webp. Understanding the background fit options — Fill, Fit, Center, Tile — can help in achieving the desired appearance for your Plesk background:

  • Fill - the image fills the entire screen area
  • Fit - enlarge or shrink the image according to your screen’s width to get a proper fit
  • Center - smaller images will set with a border on your screen whereas the larger images will display only the center part of the image leaving the rest out of view.
  • Tile - this setting sets the multiple tiles of the image on your monitor and suits best to the small texture images
CLI/API

Also, background parameters can be controlled via CLI/API.

  • Set custom login page background:

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

  • Reset custom login page background:

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

  • Current settings of custom background:

    # plesk bin branding --show
    background-color: #31a7dc
    background-file: https://203.0.113.2:8443/images/TVR07m4P8KU.jpeg
    background-fit: center

  • Output in json format is also possible:

    # plesk bin branding --show -json true
    {"background-color":"#31a7dc","background-file":"https://203.0.113.2:8443/images/TVR07m4P8KU.jpeg","background-fit":"center"}

Note: Please be aware of certain limitations when customizing branding elements in Plesk, detailed in the article:: What are the known limitations of branding settings in Plesk?

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.