customize-look-feel.md

title
Customize the Look and Feel of Harbor

The primary look & feel of Harbor supports to be customized with several simple steps. All the relevant customization in configurations are saved in the setting.json file under $HARBOR_DIR/src/portal/src folder with json format and will be loaded when Harbor is launched.

Configure

Open the setting.json file, you'll see the default content as shown below:

{
  "headerBgColor": {
    "darkMode": "",
    "lightMode": ""
  },
  "loginBgImg": "",
  "loginTitle": "",
  "product": {
    "name": "",
    "logo": "",
    "introduction": ""
  }
}

Change the values of configuration if you want to override the default style to your own. Here are references:

• headerBgColor: The background color of the page header, support either HEX or RGB value. e.g: #004a70 and rgb(210,110,235).
  • darkMode: The background color of the page header for the dark mode.
  • lightMode: The background color of the page header for the light mode.
• loginBgImg: The name path of the background image displayed in the login page, e.g: 'login_bg.png'. The image file should be put in the images folder. Suggest the size of this image should be bigger than 800px*600px.
• loginTitle: The full product title displayed in the login page.
• Product: Contain metadata / description of the product.
  • name: The name of the product.
  • logo: The name path of the product logo, e.g: 'logo.png'. The image file should be put in the images folder.
  • introductions: The introduction about the product, which are displayed in the About dialog.

Build

Once the setting.json configurations has been updated, re-build your product to apply the new changes.