|
| 1 | +* TOC |
| 2 | +{:toc} |
| 3 | + |
| 4 | +### Overview |
| 5 | + |
| 6 | +{% capture white-labeling-note %} |
| 7 | +The **white labeling** feature is supported only in the **Professional Edition**. |
| 8 | +{% endcapture %} |
| 9 | +{% include templates/info-banner.md content=white-labeling-note %} |
| 10 | + |
| 11 | +**White labeling** in **ThingsBoard** allows businesses to customize the platform's appearance and branding to align with their own corporate identity. |
| 12 | +Please refer to the **ThingsBoard White Labeling** [documentation](/docs/pe/user-guide/white-labeling/){: target="_blank"}. There you will find step-by-step instructions on how to customize the **ThingsBoard logo** and web **interface**. |
| 13 | + |
| 14 | +The **white labeling** feature supports particular **hierarchy**. |
| 15 | +The tenant can override the configurations set by the system administrator, |
| 16 | +tenant-set configurations can be overridden by the customer, and so on. |
| 17 | + |
| 18 | + {: style="display: block; margin: auto; max-height: 400px"} |
| 19 | + |
| 20 | +Similarly, **white-labeling** configurations are propagated to the **Edge instances**: |
| 21 | + |
| 22 | +* **Tenant-Owned Edge:** If the edge is owned by a **tenant**, the white labeling settings are retrieved from the **tenant level** and merged with those from the system administrator. |
| 23 | + |
| 24 | +{: style="display: block; margin: auto; max-height: 280px"} |
| 25 | + |
| 26 | +* **Customer-Owned Edge:** If the edge is owned by a **customer**, the white labeling settings are taken from the **customer** of the edge and merged with those from the tenant and system administrator. |
| 27 | + |
| 28 | +{: style="display: block; margin: auto; max-height: 390px"} |
| 29 | + |
| 30 | +However, the displayed interface depends on the **account** used to log in to an **Edge** instance. |
| 31 | + |
| 32 | +_**For example:** When a user logs in to a **customer-owned Edge** with the **tenant account**, that user will see the interface for a **tenant**._ |
| 33 | + |
| 34 | +{: style="display: block; margin: auto; max-height: 400px"} |
| 35 | + |
| 36 | +### Edge Login Page |
| 37 | + |
| 38 | +**ThingsBoard** also allows customization of the login page. In a **multi-tenant environment**, domain-based branding defines the configurations that apply at login, meaning that different tenants can have different branding configurations. Read about **login page configurations** [here](/docs/pe/user-guide/white-labeling/#customize-the-login-page){: target="_blank"}. |
| 39 | + |
| 40 | +_**For example:** If a user logs in from a specific domain (companyA.com), ThingsBoard applies the white labeling settings associated with that domain. If no custom domain is set, the default settings apply._ |
| 41 | + |
| 42 | +On the **Edge side** domain name is **not used** in any way. |
| 43 | + |
| 44 | +{% capture edge-login %} |
| 45 | +The appearance of the **Edge login page** depends on the **ownership** only. |
| 46 | +{% endcapture %} |
| 47 | +{% include templates/info-banner.md content=edge-login %} |
| 48 | + |
| 49 | +_**For example:** When a user logs in to the **customer-owned Edge**, the **customer's** white-labeling login configurations are applied._ |
| 50 | + |
| 51 | +{: style="display: block; margin: auto; max-height: 450px"} |
| 52 | + |
| 53 | +### Other Configurations |
| 54 | + |
| 55 | +The **white labeling** configuration for **Edge** is designed in the same way as for the **Platform (Server or Cloud)**. Please refer to the **Platform White Labeling documentation** for detailed configuration instructions: |
| 56 | +* [Custom translation](/docs/pe/user-guide/custom-translation/){: target="_blank"} |
| 57 | +* [Custom menu](/docs/pe/user-guide/custom-menu/){: target="_blank"} |
| 58 | + |
| 59 | +### Next Steps |
| 60 | + |
| 61 | +{% include templates/edge/guides-banner-edge.md %} |
| 62 | + |
0 commit comments