Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 23 additions & 18 deletions _includes/docs/pe/user-guide/white-labeling.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,13 @@
* TOC
{:toc}

ThingsBoard web interface allows you to configure your company or product logo and color scheme in a few clicks with zero coding efforts and no service restart required.
White labeling lets you tailor your ThingsBoard instance to match your brand and preferences—especially useful for companies delivering IoT solutions to their customers.

{% if docsPrefix == "pe/" %}
Sysadmin, Tenant and Customer Administrators can configure color scheme, icon, favicon and custom translation of system components and end-user dashboard elements.
But only System and Tenant Administrators are able to set up customer email templates to interact with the users.
Set your company or product name, upload your logo, choose color palettes, use a custom menu or translations—all without writing code or restarting the service.

By default, the Tenant inherits the Sysadmin UI configuration, and the Customer inherits the Tenant UI configuration. But Tenant and Customer Administrators are able to set up their own White Labeling configuration.
{% endif %}
{% if docsPrefix contains "paas/" %}
Tenant and Customer Administrators can configure color scheme, icon, favicon and custom translation of system components and end-user dashboard elements.
But only Tenant Administrator are able to set up customer email templates to interact with the users.
<br><b><font size="4">Practical video course 🎥</font></b>

By default, the Customer inherits the Tenant UI configuration. But the Customer Administrator are able to set up their own White Labeling configuration.
{% endif %}
Watch this practical video course for a step-by-step guide to personalizing the look and feel of your IoT platform.

&nbsp;
<div id="video">
Expand All @@ -25,13 +18,25 @@ By default, the Customer inherits the Tenant UI configuration. But the Customer
</div>
</div>

## White labeling settings
## Basics & Inheritance

To configure your company or product logo and color scheme, go to the "White labeling" page.
White labeling is configured based on the level you&#39;re signed in under:
{% unless docsPrefix contains "paas/" %}- **System Administrator level** — sets the platform&#39;s default branding for all tenants and their customers.{% endunless %}
- **Tenant level** — inherits the system branding and can override it for the specific tenant and its customers.
- **Customer level** — inherits the tenant&#39;s branding and can customize the UI for that customer and its users.

{% include images-gallery.html imageCollection="white-labeling-default" %}
**Inheritance flow:** System → Tenant → Customer. Lower levels can override settings within their scope.

### Customize ThingsBoard web interface
## Customize ThingsBoard web interface

{% capture difference %}
**Please note:** To configure **White labeling**, you need the appropriate [permissions](/docs/{{docsPrefix}}user-guide/rbac/){:target="_blank"}.
{% endcapture %}
{% include templates/info-banner.md content=difference %}

To configure your company or product **logo** and **color scheme**, go to the "White labeling" page.

{% include images-gallery.html imageCollection="white-labeling-default" %}

In the "General" tab you can set or change the following options:

Expand Down Expand Up @@ -82,7 +87,7 @@ The final look of the customized user interface:

{% include images-gallery.html imageCollection="white-labeling-custom" %}

#### Advanced CSS
### Advanced CSS

Using CSS, you can stylize any elements of the ThingsBoard user interface as you wish. Such elements can be background, icons, fonts, etc.

Expand Down Expand Up @@ -138,9 +143,9 @@ An example of CSS code to customize the appearance of the sidebar menu:

Using the functionality described in this documentation, you can customize the appearance of the ThingsBoard UI according to your preferences.

### Customize the login page
## Customize the login page

On the "Login" tab, you can configure the login page for your clients.
On the "Login" tab, you can configure the **login page** for your clients.

- Enter the registered domain name, or refer to [this documentation](/docs/{{docsPrefix}}domains/#domain-registration){:target="_blank"} to learn how to register a new domain;
- It is recommended to prevent usage of hostnames from headers of the request;
Expand Down
6 changes: 2 additions & 4 deletions _includes/docs/user-guide/ui/assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,9 @@ Assets help logically and efficiently structure your IoT project, making it easi

> ThingsBoard supports asset management functions via both the web UI and the [REST API](/docs/{{docsPrefix}}reference/rest-api/){:target="_blank"}.

<b><font size="4">Practical video course 🎥</font></b>
<br><b><font size="4">Practical video course 🎥</font></b>

Watch the practical video course, which includes a detailed explanation of how to create and use assets in ThingsBoard.

> The course includes hands-on examples to help you better understand how to manage dashboards, assets, and devices — including their configuration and real-world usage.
Watch this practical video course to learn how to configure and manage ThingsBoard dashboards, resources, and devices, and how to use them in real-world scenarios.

&nbsp;
<div id="video">
Expand Down