Stop the war

Stand with Ukraine flag

Support Ukraine
Try it now Pricing
Cloud
Community Edition Professional Edition Cloud Edge PE Edge IoT Gateway License Server Trendz Analytics Mobile Application PE Mobile Application MQTT Broker
Documentation > Key concepts > Domains
Getting Started
Devices Library Guides API FAQ
On this page

Managing domain

The ThingsBoard Cloud allows registering your custom domain to have the required host name for user’s access, links, etc. When you register valid domain, the ThingsBoard Cloud automatically requests the SSL certificate from Let’s Encrypt for the latter and manages further certificate renewals. After domain registration, your tenant and application(s) will be accessible via your domain name using a secure (HTTPS) connection. Like Web UI all other ThingsBoard Cloud services such as MQTT/HTTP/CoAP transports or HTTP integrations will be accessible via your custom domain name.

Domain registration

Doc info icon

Note
You must be owner of the domain you are registering.

In order to use your own host name instead of thingsboard.cloud you must register it first. Follow the next steps to do that:

  • On your DNS provider’s website, you must add a canonical record for your domain to map it with thingsboard.cloud. See How to Create a CNAME Record For Your Domain for details. Once done, you can start the registration procedure;
  • Go to the “Settings” page, then navigate to the “Domain” tab. On the “Domain” tab click on the “Register domain” button;
  • Enter valid domain name in the input field and click on the “Register” button.
  • You will be prompted a reminder about the CNAME;
  • Click on the “I’ve added CNAME records” button. Once you confirm the canonical name is in place, the domain verification and certificate provisioning will start. Be patient, this process can take a while;
  • If succeeded, you will see your domain name on the “Domain” tab.
Go to the "Settings" page, then navigate to the "Domain" tab. On the "Domain" tab click on the "Register domain" button;
Go to the "Settings" page, then navigate to the "Domain" tab. On the "Domain" tab click on the "Register domain" button;
Enter valid domain name in the input field and click on the "Register" button;
Enter valid domain name in the input field and click on the "Register" button;
You will be prompted a reminder about the CNAME;
You will be prompted a reminder about the CNAME;
Click on the "I've added CNAME records" button. Once you confirm the canonical name is in place, the domain verification and certificate provisioning will start. Be patient, this process can take a while;
Click on the "I've added CNAME records" button. Once you confirm the canonical name is in place, the domain verification and certificate provisioning will start. Be patient, this process can take a while;
If succeeded, you will see your domain name on the "Domain" tab.
If succeeded, you will see your domain name on the "Domain" tab.

Customize the login page URL

To have a customized Web UI access, go to White labeling section. You need the Login tab. Enter the recently registered domain name. It is recommended to fill the Base URL field and prevent usage of hostnames from headers of the request.

Go to the "White Labeling" page, then navigate to the "Login" tab. Enter the domain name and the base URL in the corresponding fields. Don't forget to check the box "Prohibit to use hostname from the client request headers". Then save all changes;
Go to the "White Labeling" page, then navigate to the "Login" tab. Enter the domain name and the base URL in the corresponding fields. Don't forget to check the box "Prohibit to use hostname from the client request headers". Then save all changes;
Now you can use your domain name to access ThingsBoard Cloud Web UI and services. Try to login by entering the chosen domain name in the browser address line.
Now you can use your domain name to access ThingsBoard Cloud Web UI and services. Try to login by entering the chosen domain name in the browser address line.

Now you can use your domain name to access ThingsBoard Cloud Web UI and services. Try to login by entering the chosen domain name in the browser address line.

Proceed with further customization of Login page to accomplish the platform re-branding.

Domain details

To view a registered domain details click “Domain details” button on the “Domain” tab. Domain details dialog displays information about registered domain CNAME record and issued “SSL certificate” details including current validity period (Not before and Not after). The certificate is valid for 90 days. Please note that ThingsBoard Cloud will automatically renew the certificate earlier than 30 days before it expires, no action is required from your part unless you change or delete the domain CNAME record.

To view a registered domain details click "Domain details" button on the "Domain" tab;
To view a registered domain details click "Domain details" button on the "Domain" tab;
ThingsBoard Cloud will automatically renew the certificate earlier than 30 days before it expires, no action is required from your part unless you change or delete the domain CNAME record.
ThingsBoard Cloud will automatically renew the certificate earlier than 30 days before it expires, no action is required from your part unless you change or delete the domain CNAME record.

Delete domain

To delete a registered domain click “Delete” button on the “Domain” tab. In the confirmation dialog, click “Yes” if you are sure you want to delete the domain. Once confirmed, the domain information and associated SSL certificate will be deleted and you will not be able to access ThingsBoard Cloud web interface and services using that domain. Please note that you can always re-register the same or a different domain using Domain registration procedure.

To delete a registered domain click "Delete" button on the "Domain" tab;
To delete a registered domain click "Delete" button on the "Domain" tab;
In the confirmation dialog, click "Yes" if you are sure you want to delete the domain.
In the confirmation dialog, click "Yes" if you are sure you want to delete the domain.

How to Create a CNAME Record For Your Domain

The procedure of adding CNAME record to DNS database depending on your DNS service Provider. Below is the list of instructions for some popular DNS providers:

If none of the above-listed DNS providers is one your are ordering service from, try to get this information on the provider’s website or by contacting their support.

Troubleshooting

Firs of all you need to check if you have added CNAME to your domain correctly:

Use Google Admin Toolbox or “dig” command if your OS system is Linux:

1

dig $YOUR_DOMAIN_NAME any

Replace $YOUR_DOMAIN_NAME with your domain value.

For example, $YOUR_DOMAIN_NAME is mydomain.thingsboard.online:

1

dig mydomain.thingsboard.online any

The “dig” command in Linux is used to gather DNS information. It stands for Domain Information Groper, and it collects data about Domain Name Servers. The “dig” command is helpful for diagnosing DNS problems, but is also used to display DNS information.

The output of “dig” command could vary duy to your domain setup. For example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

$ dig mydomain.thingsboard.online any

; <<>> DiG 9.16.1-Ubuntu <<>> mydomain.thingsboard.online any
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 27275
;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 1

;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 65494
;; QUESTION SECTION:
;mydomain.thingsboard.online.	IN	ANY

;; ANSWER SECTION:
mydomain.thingsboard.online. 3600 IN	HINFO	"RFC8482" ""

;; Query time: 36 msec
;; SERVER: 127.0.0.53#53(127.0.0.53)
;; WHEN: чт чер 29 15:36:44 EEST 2023
;; MSG SIZE  rcvd: 77

This output shows that there are NO CNAME added to the mydomain.thingsboard.online domain (“ANSWER SECTION” block).

Correct output should look like that:

1
2
3
4

...
;; ANSWER SECTION:
mydomain.thingsboard.online. 3600 IN	CNAME	thingsboard.cloud
...

If all the things are correct, but some issue still persists - please Contact us for further support.