White-labeling: Login

The Login tab on the White labeling page lets you customize the login page your clients see when accessing your ThingsBoard instance via a custom domain.

1. Navigate to the White labeling ⇾ Login.
2. Set up your domain configuration:
   • Enter your registered Domain name, or follow the domain registration guide to set one up
   • Fill in the Base URL field (include protocol — http or https — and port if it differs from 80 or 443)
3. (Optional) Enable the Prohibit to use hostname from the client request headers option (recommended for production environments — this helps prevent issues related to hostname-based attacks).
4. Configure the login page appearance:
   • Set a custom Application title
   • Replace the default Website icon and Logo with your own (use “Browse from gallery” or “Set link” options)
   • Set the Logo height in pixels
5. Customize the color scheme:
   • Define the Primary palette color
   • Define the Accent palette color
   • You can use the Customize button for each palette to select specific colors
6. (Optional) Add advanced customization:
   • Click Advanced CSS to add custom CSS styling
   • Enable Dark foreground if needed for your design
   • Set the Page background color using the color picker
7. (Optional) Configure platform name and version display:
   • Check Show platform name and version to display ThingsBoard version information
   • Set the Platform Name (default: “ThingsBoard”)
   • Set the Platform version (auto-populated with current version)
   • Choose the Platform name and version position (e.g., “Bottom of the login form”)
8. Click Save.

Access your custom domain to verify the result.

ThingsBoard supports customer self-registration — a sign-up page where customers can create accounts with predefined roles, dashboards, and permissions. The login page appearance (logo, colors, background) also applies to the sign-up form.

Domain Configuration

Field	Description
Domain name	The custom domain name for your ThingsBoard instance
Base URL	Public URL for your custom domain (include protocol — http/https — and port if it differs from 80 or 443)

Security

Field	Description
Prohibit to use hostname from the client request headers	When enabled, ThingsBoard ignores the hostname sent in client request headers and uses the configured Base URL instead. Recommended for production environments; may cause security issues when disabled.

Appearance

Field	Description
Application title	Custom title displayed on the login page
Website icon	Favicon for the browser tab (upload or link)
Logo	Main logo displayed on the login page (upload or link)
Logo height, px	Height of the logo in pixels

Color Customization

Field	Description
Primary palette	Main color scheme for the login page (click “Customize” to select specific colors)
Accent palette	Secondary accent color scheme
Advanced CSS	Custom CSS rules for advanced styling
Dark foreground	Option to use dark text/foreground elements
Page background color	Background color of the login page

Platform Information Display

Field	Description
Show platform name and version	Display ThingsBoard version information on the login page
Platform Name	Name of the platform (default: “ThingsBoard”)
Platform version	Version number of ThingsBoard
Platform name and version position	Where to display the platform info (e.g., “Bottom of the login form”, “Under the logo”)