- Domain Registration
- Logging in with Your Domain
- Viewing Domain Details
- Deleting a Domain
- How to Create an A Record for Your Domain
- How to Create a CNAME Record for Your Domain
- Troubleshooting
After installing TBMQ PE, as described in the Installation Options guide, your instance is accessible by default via its public IP address or the DNS record of the cloud Load Balancer. However, configuring a custom domain name provides several important advantages:
- Simplified access - users can log in using an easy-to-remember hostname instead of an IP or Load Balancer DNS name.
- Secure SSL connections - domains enable the use of trusted SSL/TLS certificates.
- White labeling - TBMQ uses the domain to apply custom branding to the login page (logos, titles, and colors). The domain simplifies configuration management, as each TBMQ deployment supports only one login page branding configuration.
- OAuth 2.0 / SSO integration - multiple domains allow separate login configurations for each authentication provider.
Domain Registration
To use your own hostname with TBMQ, you must first configure DNS and then register the domain inside TBMQ.
Step 1. Configure DNS
On your DNS provider’s website:
-
Add an A record (or CNAME record) to map your domain to the IP or hostname where TBMQ is hosted.
-
Add a valid SSL certificate for the chosen domain.
Step 2. Register Domain in TBMQ
- Log in to your TBMQ PE account.
- Go to the "OAuth 2.0" page of the "Security" section. On the "Domains" tab click the "plus" icon;
- Enter valid domain name in the "Domain name" field and click "Add" button;
- You can see your domain name on the "Domains" tab.
Logging in with Your Domain
After successful registration, you can access your TBMQ instance using the configured domain name. Open a web browser and enter the domain in the address bar - you should see the TBMQ login page.
Viewing Domain Details
To view details about a registered domain, simply click on it to open the domain details dialog.
Deleting a Domain
To delete the domain click “trash” icon in the domain’s row you want to delete. In the confirmation dialog, click “Yes” if you are sure you want to delete the domain.
How to Create an A Record for Your Domain
What Is an A Record?
An A record (Address Record) links a domain name directly to an IPv4 address. It tells DNS resolvers where to find your server.
Example:
1
mqtt.mycompany.com → 203.0.113.45
When to Use an A Record
Use an A record when your TBMQ instance has a fixed public IP address - for example, a VM, Kubernetes service, or on-premise server.
How to Create an A Record
The exact procedure depends on your DNS provider. Refer to their documentation for detailed instructions:
- Amazon Route 53
- GoDaddy
- Cloudflare
- ClouDNS
- Google Cloud DNS
- Name.com
- DNSimple
- Infoblox NIOS
- Namecheap
If your provider is not listed, check their documentation or contact their support team for assistance.
How to Create a CNAME Record for Your Domain
What Is a CNAME Record?
A CNAME (Canonical Name Record) maps one domain name to another domain name. It acts as an alias, allowing several domains or subdomains to point to the same hostname.
Example:
1
mqtt.mycompany.com → broker.mycompany.net
When to Use a CNAME Record
Use a CNAME record when:
- You want multiple domains (e.g.,
mqtt.mycompany.com,iot.mycompany.com) to resolve to the same host. - Your server’s IP may change, but the target domain remains constant.
- You want to simplify DNS management by maintaining only one A record (on the primary domain).
How to Create a CNAME Record
Each DNS provider has its own interface for adding CNAME records. Below are direct links to their setup guides:
- Amazon Route 53
- GoDaddy
- Cloudflare
- ClouDNS
- Google Cloud DNS
- Name.com
- easyDNS
- DNSimple
- DNSMadeEasy
- No-IP.com
- Infoblox NIOS
- Namecheap
If your provider is not listed, check their documentation or contact their support team for assistance.
Troubleshooting
If your domain does not resolve or TBMQ is not accessible, verify the DNS configuration.
Check DNS Record
Use the Google Admin Toolbox DIG or run the following command on Linux:
1
dig your-domain.com any
Replace your-domain.com with your actual domain name.
Example:
1
dig mqtt.mycompany.com any
Review the Output
If no ANSWER SECTION appears, the record was not added correctly.
For example, this output shows no record found:
1
2
;; ANSWER SECTION:
mqtt.mycompany.com. 3600 IN HINFO "RFC8482" ""
A correct record should look like this:
1
2
;; ANSWER SECTION:
mqtt.mycompany.com. 3600 IN CNAME broker.mycompany.net.
or, if using an A record:
1
2
;; ANSWER SECTION:
mqtt.mycompany.com. 3600 IN A 203.0.113.45
Contact Support
If the configuration appears correct but the issue persists, please contact us for further assistance.