Change the application login page logo and background
You can edit the User Console login page to replace the default logo with your corporate logo or other image. You can also modify or replace the default background image and other page elements to better fit your organization or brand.

Note: The User Console login page uses CSS properties that start with "#login
" for easy identification. The method for changing the logo and background for other available themes, like Crystal and Sapphire, is the same. Each theme uses different style definitions, image types, names, and file paths.
Follow the steps below to change the default logo and background images for the User Console login page theme.
Back up and remove the default image file for the logo from the
/pentaho-server/pentaho-solutions/system/common-ui/resources/themes/<*theme-name*>/images
directory of the theme you want to change.
Ruby (default)
header_logo.svg
Crystal
puc-login-logo.png
Sapphire
pentaho-logo-white.png
2. Rename the new image file to match the name of the logo file that you are replacing, and then copy the new image file into the `\pentaho-server\pentaho-solutions\system\common-ui\resources\themes\<*theme-name*>\images` directory.
Update the style definitions for your image. Navigate to the
\pentaho-server\pentaho-solutions\system\common-ui\resources\themes\<theme name>
directory for the theme you are changing and then open the.css
file with a text editor.
Ruby (default)
globalRuby.css
Crystal
globalCrystal.css
Sapphire
globalSapphire.css
4. Locate the **\#login-header-logo** property, then adjust the dimensions and margin for the new image.
(Optional) You can back up and remove the background image file. If not replacing the background image, proceed to the next step.
The background image file is located in the
\pentaho-server\pentaho-solutions\system\common-ui\resources\themes\<*theme-name*>\images
directory of the theme you want to change. Use the following table to locate your theme and image.Ruby (default)
bg.svg
Crystal
login-crystal-bg.jpeg
Sapphire
#0F2B5B
Rename the new background image file to match the name of the background file that you are replacing, and then copy the new image file into the `\pentaho-server\pentaho-solutions\system\common-ui\resources\themes\<*theme-name*>\images` directory.
Update the image dimensions for your background. Navigate to the
\server\pentaho-server\pentaho-solutions\system\common-ui\resources\themes\<*theme-name*>
directory and open the.css
file with a text editor.Locate the #login-background property, then adjust the dimensions, position, and other properties for the background image.
6. Save and close the file.
Clear the web browser cache and restart the server to see the new logo.
The default theme logo is removed, and your custom logo appears in its place. If you replaced the background image, the new background also appears. You can also use the same process to modify or replace the remaining elements on the login page.
Last updated
Was this helpful?