From dd438dd34afa2fa6a8d1db0e9029b8e2ea7c6aa2 Mon Sep 17 00:00:00 2001 From: Yevheniia Mala Date: Wed, 3 Dec 2025 15:39:43 +0200 Subject: [PATCH 1/9] TB Edge docs --- _includes/docs/edge/faq.md | 428 ++++++++++++++++++------------------- 1 file changed, 204 insertions(+), 224 deletions(-) diff --git a/_includes/docs/edge/faq.md b/_includes/docs/edge/faq.md index ac63ef3eca..b730462fee 100644 --- a/_includes/docs/edge/faq.md +++ b/_includes/docs/edge/faq.md @@ -1,224 +1,204 @@ -* TOC -{:toc} - -## General Questions - -### What is ThingsBoard Edge {{edgeName}}? -{% if docsPrefix == "pe/edge/" or docsPrefix contains "pe/edge/" %} -

ThingsBoard Edge Professional Edition (PE) is a commercial version of ThingsBoard Edge designed specifically for edge computing scenarios. It provides advanced features and enterprise-grade support for managing and analyzing IoT data at the edge while maintaining seamless synchronization with the ThingsBoard Server (Cloud or On-premise).

-

If you're new to edge computing, we recommend exploring What is Edge? and the Getting Started guides for more detailed information.

-{% else %} -

ThingsBoard Edge Community Edition (CE) is a free, open-source platform designed specifically for edge computing scenarios. It provides essential capabilities for managing and analyzing IoT data at the edge, while staying seamlessly synchronized with the ThingsBoard Server (Cloud or On-premise).

-

If you're new to edge computing, we recommend exploring What is Edge? and the Getting Started guides for more detailed information.

-{% endif %} - - -### Can I customize and modify the ThingsBoard {{edgeName}}? -{% if docsPrefix == "pe/edge/" or docsPrefix contains "pe/edge/" %} -

No, the ThingsBoard {{edgeName}} is a commercial project and can not be modified.

-{% else %} -

Yes, the source code is available on GitHub, and you can fork and modify it to suit your needs. By the way, please consider starring our repository.

-{% endif %} - -### Does ThingsBoard Edge support clustering? - -The **earlier versions** of **ThingsBoard Edge** do not support clustering. It is designed to operate, process and analyze data locally before synchronizing with the central **ThingsBoard Server**. - -Starting **with release 4.0**, Edge supports clustering. Multiple **Edge nodes** can be clustered to provide high availability. If one node fails, the others can seamlessly continue to handle workloads. - -### Do I need an internet connection to use the ThingsBoard Edge? -

No, you can run it completely offline if you need to. The only connection required is to the ThingsBoard Server via gRPC.

-{% if docsPrefix == 'pe/edge/' %} -

However, ThingsBoard Edge does utilize an HTTP(s) connection to the ThingsBoard Server to verify the license. -The URL set in the Cloud Endpoint configuration is used for this validation. -Ensure that the HTTP(s) connection to the server is not blocked by any firewall settings. -The ThingsBoard Server acts as a proxy for ThingsBoard Edge to connect to the ThingsBoard License Portal.

-{% endif %} - -{% if docsPrefix == 'pe/edge/' %} - -### How will the license check be carried out if the connection to the ThingsBoard Server is temporarily not available? -

ThingsBoard Edge can operate offline, without a connection to the ThingsBoard Server, for up to 7 days.

- -{% endif %} - -## Installation & Deployment - -### Does the ThingsBoard Edge support multi-tenancy? -{% if docsPrefix == 'pe/edge/' %} -

No, ThingsBoard Edge Professional Edition does not support multi-tenancy. It is designed for a single tenant and multiple customers, but the customer hierarchy must be taken into account

-

For instance, if an Edge owner is a sub-customer, all the parent entities of that sub-customer up to the tenant level will be provisioned to the Edge. -This means customers from the same hierarchy path can access the same ThingsBoard Edge PE instance.

-

However, you cannot share a ThingsBoard Edge between multiple tenants, and devices from multiple tenants cannot connect to a single ThingsBoard Edge. -If this is required, you'll need to provision multiple ThingsBoard Edge instances for each tenant.

-{% else %} -

No, ThingsBoard Edge Community Edition does not support multi-tenancy. It is designed for a single tenant and a single customer, which means that you cannot share a single ThingsBoard Edge instance between multiple tenants or customers, devices from different tenants cannot be connected to the same ThingsBoard Edge instance.

-

If this is required, you'll need to provision multiple ThingsBoard Edge instances for each tenant.

-{% endif %} - - -### Is there an official Docker image for ThingsBoard Edge? -

Yes, official Docker images are available on Docker Hub.

- -### Can I run ThingsBoard Edge on Raspberry Pi or other edge devices? -

Yes, ThingsBoard Edge is specifically designed to run on a variety of Edge hardware platforms, including single-board computers like Raspberry Pi and other devices with sufficient processing power and memory.

- -### Where does ThingsBoard Edge store time-series data? -

Depending on your database approach, there are two options. If you've chosen a hybrid approach, the time-series data will be stored in Cassandra. Otherwise, the data is stored in the PostgreSQL database, which is well suited for storing and querying entities and local time-series data.

- -### What should I do if I have legacy devices to connect? -

If you have legacy devices that don't natively speak one of the protocols supported by ThingsBoard Edge (such as MQTT, CoAP, or HTTP), you can still connect them by installing ThingsBoard IoT Gateway. It will act as a bridge between your legacy devices and ThingsBoard Edge.

-

ThingsBoard IoT Gateway is available out-of-the-box and requires no additional fees.

- - -## Features & Limitations - -{% if docsPrefix == "pe/edge/" or docsPrefix contains "pe/edge/" %} - -### What features are exclusive to the {{edgeName}}? -

The {{edgeName}} includes all the features of the Community Edition plus additional functionality:

- -{% else %} -### What core features are available in the {{edgeName}}? -

The {{edgeName}} includes features for:

-{% endif %} - -### How many devices can ThingsBoard Edge support? -{% if docsPrefix == 'pe/edge/' %} -

The number of connected devices depends on your subscription plan.

-

Some plans offer 'Unlimited Devices and Assets, thus there are no soft limits on creating devices and assets on the edge side.

-{% else %} -

ThingsBoard Edge doesn’t impose a fixed limit on the number of devices you can connect.

-

In practice, the number of devices you can support depends largely on your hardware resources, system configuration, and the specific use case. -Since ThingsBoard Edge is designed with remote locations with potentially low bandwidth connectivity in mind, we do not recommend connecting more than 1000 devices to a single edge.

-{% endif %} - - -{% if docsPrefix == "edge/" %} -### Does the Community Edition support white-labeling? -

No, white-labeling is available only in the Professional Edition.

- -{% endif %} - -### Can I integrate third-party systems with ThingsBoard Edge? -

Yes, you can integrate the ThingsBoard Edge {{edgeName}} with third-party systems through REST APIs.

-{% if docsPrefix == "pe/edge/" or docsPrefix contains "pe/edge/" %} -

Also, the platform integrations are available for the {{edgeName}}.

-{% else %} -

However, the platform integrations, which are available only in the Professional Edition, are not included in the Community Edition.

-{% endif %} - - -### What databases does the ThingsBoard Edge support? -

The ThingsBoard Edge supports pure SQL or a hybrid SQL + NoSQL (for telemetry storage) approach. For more details on database options, you can check here.

- - -### Can I automate device management and telemetry processing? -

Yes, you can. The Rules Engine allows for event-based processing and alerts.

- - -### Does Edge {{edgeName}} support OTA (Over-the-Air) firmware updates? -

Yes, the {{edgeName}} supports OTA (Over-the-Air) firmware updates.

- -### Is there a mobile app for ThingsBoard Edge {{edgeName}}? -

No, there is no dedicated mobile app for ThingsBoard Edge {{edgeName}}.

-

However, you can access and manage ThingsBoard Edge through a web browser on any device, including mobile devices, by visiting the ThingsBoard Edge dashboard (typically hosted on port 8080).

- -### Does ThingsBoard Edge {{edgeName}} support AI or machine learning integrations? -

Not natively, but you can incorporate AI or ML into your ThingsBoard Edge deployment using custom development or third-party integrations.

- -### How do I upgrade to the latest version of ThingsBoard Edge? -

In order to upgrade to the latest version of ThingsBoard Edge, please follow these instructions.

- - -### How can I connect my device? -

ThingsBoard Edge supports various protocols, including MQTT, CoAP, HTTP, and LwM2M.

-

Legacy devices can be connected to the platform via ThingsBoard Gateway. More information is available on the connectivity page.

-{% if docsPrefix == 'pe/edge/' %} -

You can also use the ThingsBoard Integrations to connect devices from different sources and with custom payloads to the edge.

-{% endif %} - -### Do I need to use a software development kit (SDK)? -

No, many IoT devices are not designed to embed third-party SDKs.

-

ThingsBoard Edge provides a simple API over common IoT protocols, so you can choose any client-side library you like, or even use your own. -Some useful references include MQTT client-side libraries list and C-implementation for CoAP.

- -## Support & Community Assistance - -### What support options are available for the {{edgeName}}? -{% if docsPrefix == "pe/edge/" or docsPrefix contains "pe/edge/" %} -

All subscriptions include optional support.

-

Also, support can be provided by the ThingsBoard community

-{% else %} -

Support for the Community Edition is primarily community-driven, including:

-{% endif %} - - - -{% if docsPrefix == "pe/edge/" or docsPrefix contains "pe/edge/" %} - -### What is optional support? -

This means that Edge support is not bundled with the license. For now, we provide basic support to customers with more than 25 Edge licenses of any type.

- -### Refund and Delivery Policy -

Refund Policy

-

The License fee is non-refundable, regardless of any circumstances. -Customers may manage their subscription plans: update or cancel them. Once the subscription is deleted before expiration, Stripe will keep the balance. -After a certain time period (about an hour) positive Amount due with the remain credits will appear in Billing section of License portal. -This sum is deducted from Total fee whenever particular customer purchase a new plan or a perpetual license.

-

Delivery Policy

-

The software is available for download and installation from our website. -See Installation Guidesfor more details. -In order to activate the software you will need to obtain the license key. -Instruction how to obtain and use the license key is provided in the installation guide. -See How-to get pay-as-you-go subscription or How-to get perpetual license for more details. -Please contact us if you have any questions or require support.

- -### How can I contact ThingsBoard support for billing-related issues? -

You can use the contact us form and select the "Other" topic. Our account managers will assist you with any billing-related issues.

- -### Do you offer 24/7 customer support? -

Yes, we do provide 24/7 support. If this is what you're looking for, please contact us for a more detailed discussion about your specific needs.

- -{% else %} -### What should I do if I find a bug in Community Edition? -

You can report it on GitHub Issues, and the open-source community may help fix it.

- -### Can I contribute to the development of ThingsBoard Edge Community Edition? -

Yes! Pull requests and contributions are welcome on GitHub. By the way, please consider starring our repository.

- -### Is official support available for the Community Edition? -

No, official support is not included in the Community Edition. For official support, consider upgrading to a paid edition.

- -{% endif %} - -{% if docsPrefix == "edge/" %} -## Upgrading to the Professional Edition - -### Can I upgrade from the Community Edition to a paid edition? -

Yes, upgrading is straightforward. Contact the ThingsBoard Sales Team or visit the Pricing Page to select a suitable paid plan. The transition will be guided to ensure data integrity and feature migration.

- - -### How do I start a free trial? -

The Edge free trial license key provided when you create Edge instance inside ThingsBoard Professional Edition or Cloud. -This key is only active for 30 days after activation. -To obtain the permanent license key for Edge, please navigate to the pricing page and select the best licensing option for your case.

- -{% endif %} - - - + + + + +
+
+
+
General Questions
+
Installation & Setup
+
Features & Capabilities
+
Support
+
+
+
+
+
What is ThingsBoard Edge?
+
+

ThingsBoard Edge is a solution that brings data processing and analytics capabilities closer to the data source. It runs on edge devices and gateways, reducing latency and bandwidth usage while maintaining connectivity with the central ThingsBoard server.

+
+
+
+
I can deploy ThingsBoard Server on-site. Why should I deploy ThingsBoard Edge instead?
+
+

Server is designed for centralized deployment and requires robust infrastructure. Edge is lightweight, runs on minimal hardware (like Raspberry Pi), and is purpose-built for distributed locations.

+

Use Edge when you have multiple sites that need local processing with automatic sync to a central Server. Server is your central hub; Edge extends that capability to remote sites that need local processing but don't need the full server infrastructure.

+
+
+
+
What's the difference between Community Edition and Professional Edition?
+
+

Community Edition provides core edge computing features and is suitable for development and small deployments. Professional Edition includes:

+
    +
  • White-labeling capabilities
    • +
  • Advanced RBAC (Role-Based Access Control)
    • +
  • Platform integrations
    • +
  • Custom translation support
    • +
  • Priority support and SLA options
    • +
+
+
+
+
+
+
How do I install ThingsBoard Edge?
+
+

You can install ThingsBoard Edge using several methods:

+
    +
  • Docker installation (recommended for quick setup)
    • +
  • Package installation (Ubuntu/CentOS)
    • +
  • Building from source
    • +
+

See the installation guide for detailed instructions.

+
+
+
+
What are the system requirements?
+
+

Minimum system requirements:

+
    +
  • RAM: 1GB minimum, 2GB recommended
    • +
  • Storage: 10GB minimum
    • +
  • Java: OpenJDK 11 or higher
    • +
  • Network: Stable internet connection for synchronization
    • +
+
+
+
+
Does Edge require constant connection to ThingsBoard Server?
+
+

No. ThingsBoard Edge can operate autonomously during network outages. It processes data locally and stores it until connectivity is restored, at which point it automatically synchronizes with the ThingsBoard server.

+
+
+
+
+
+
What protocols does Edge support?
+
+

ThingsBoard Edge supports the following protocols:

+
    +
  • MQTT
    • +
  • CoAP
    • +
  • HTTP
    • +
  • LwM2M
    • +
+
+
+
+
What happens when Edge loses connection to the server?
+
+

ThingsBoard Edge continues to function during network outages. It processes data locally, executes rule chains, and stores data. Once connectivity is restored, all collected data and events are automatically synchronized with the ThingsBoard server.

+
+
+
+
How long can Edge store data locally?
+
+

The duration depends on your storage capacity and data volume. ThingsBoard Edge stores data in a local database and can retain information until connectivity is restored or storage limits are reached. You can configure data retention policies based on your requirements.

+
+
+
+
+
+
Where can I get support for Edge CE?
+
+

Support options for ThingsBoard Edge Community Edition:

+ +
+
+
+
What license does Edge CE use?
+
+

ThingsBoard Edge Community Edition is distributed under Apache License 2.0, which allows you to use, modify, and distribute the software freely for both commercial and non-commercial purposes.

+
+
+
+
Can I use Edge CE for commercial projects?
+
+

Yes, ThingsBoard Edge Community Edition can be used for commercial projects under the Apache License 2.0. However, for production deployments requiring additional features, SLA guarantees, and professional support, we recommend considering Professional Edition.

+
+
+
+
+
+
\ No newline at end of file From 58fbb5bdd23fdc0dca1921c5aff204559c86c18b Mon Sep 17 00:00:00 2001 From: Yevheniia Mala Date: Wed, 3 Dec 2025 19:21:46 +0200 Subject: [PATCH 2/9] TB Edge docs --- _includes/docs/edge/faq.md | 9 ++------- docs/edge/faq.md | 3 +-- docs/pe/edge/faq.md | 3 +-- 3 files changed, 4 insertions(+), 11 deletions(-) diff --git a/_includes/docs/edge/faq.md b/_includes/docs/edge/faq.md index b730462fee..fffcae80f4 100644 --- a/_includes/docs/edge/faq.md +++ b/_includes/docs/edge/faq.md @@ -1,11 +1,10 @@ + -TBMQ represents an open-source software product developed by ThingsBoard, designed to facilitate communication between MQTT clients. -This particular product is freely available for both personal and commercial purposes, with the added flexibility of being deployable in any desired location. -For individuals new to utilizing the broker, we suggest consulting the comprehensive resources, namely the -[what-is-tbmq](/docs/mqtt-broker/getting-started-guides/what-is-thingsboard-mqtt-broker/) and the -[getting started guide](/docs/mqtt-broker/getting-started/), in order to gain a thorough understanding of its functionality. -Further details can be found on the dedicated page, providing a wealth of additional information. +
+
+
+
Getting Started
+
Configuration & Deployment
+
Connectivity
+
Usage and Capabilities
+
Security and Reliability
+
Subscriptions & Messaging
+
Performance and Scalability
+
Data Storage and Persistence
+
Licensing and Support
+
+
+
+ {% if docsPrefix == null %} +
+
What is TBMQ Community Edition (CE)?
+
+

TBMQ is a high-performance MQTT broker developed by ThingsBoard. It enables efficient, reliable, and scalable communication between MQTT clients and IoT applications. TBMQ supports MQTT 3.x and MQTT 5.0, ensuring compatibility with a wide range of devices and industry use cases.

+

The broker is available in two editions: Community Edition (CE) and Professional Edition (PE).

+

The Community Edition is a free and open-source version, ideal for developers and teams who want to explore, prototype, and test MQTT-based solutions without licensing costs. It provides a robust MQTT broker that can be deployed locally, on-premises, or in the cloud. CE delivers all the essential features for reliable messaging, scalability, and monitoring — making it a perfect starting point for both learning and production-scale use cases.

+

If this is your first experience with TBMQ, we recommend reviewing the What is TBMQ and Getting Started Guide to learn more about its architecture, setup, and key capabilities.

+
+
+ {% endif %} + {% if docsPrefix == "pe/" %} +
+
What is TBMQ Professional Edition (PE)?
+
+

TBMQ is a high-performance MQTT broker developed by ThingsBoard. It enables efficient, reliable, and scalable communication between MQTT clients and IoT applications. TBMQ supports MQTT 3.x and MQTT 5.0, ensuring compatibility with a wide range of devices and industry use cases.

+

The broker is available in two editions: Community Edition (CE) and Professional Edition (PE).

+

The Professional Edition (PE) is the enterprise-grade version of TBMQ, designed for commercial IoT deployments and large-scale production environments. It includes all the capabilities of the Community Edition, plus advanced features such as:

+
    +
  • White-label branding and UI customization
    • +
  • Advanced security and access control
    • +
  • Enhanced monitoring, analytics, and reporting
    • +
  • Professional support and maintenance
    • +
+

PE is built for organizations that require high throughput, operational reliability, and premium management capabilities to run mission-critical IoT infrastructures.

+

If this is your first experience with TBMQ, we recommend reviewing the What is TBMQ and Getting Started Guide to understand its features and deployment options in detail.

+
+
+ {% endif %} +
+
How do I get started?
+
+

We recommend installing TBMQ locally on your laptop or PC using Docker and following the Getting Started Guide. The guide walks you through installation, configuration, and initial testing, helping you establish your first MQTT connections quickly and reliably.

+
+
+
+
How do I install TBMQ?
+
+

You can install TBMQ locally or in the cloud using Docker, Kubernetes scripts, or Helm. Detailed step-by-step guides are available in the Installation Guide, including configuration of Kafka, Redis, and PostgreSQL dependencies.

+
+
+
+
How can I start TBMQ using Docker or Helm?
+
+

To start TBMQ with Docker, run the provided Docker Compose file, which launches all required services (Kafka, Redis, PostgreSQL, and the MQTT broker) in a single command. + For Kubernetes, use the official Helm chart to deploy TBMQ as a scalable, fault-tolerant cluster. The Helm chart includes configurable parameters for persistence, resource limits, and monitoring. + Both methods provide a quick way to get TBMQ running in minutes, whether for testing or production.

+
+
+
+
What are the system requirements for TBMQ?
+
+

TBMQ can run on modest hardware for testing or small-scale evaluation. The minimum requirements to start TBMQ are:

+
    +
  • CPU: 1 core
    • +
  • Memory: 2 GB RAM
    • +
+

However, for stable performance and smoother operation in typical environments, the recommended configuration is:

+
    +
  • CPU: 4 cores
    • +
  • Memory: 8 GB RAM
    • +
  • Storage: 50 GB of free disk space
    • +
  • Operating System: Linux (x86-64 architecture)
    • +
+

For clustered or production environments, hardware needs depend on the expected number of clients and message throughput.

+

High-volume setups should allocate dedicated nodes for Kafka, Redis, and PostgreSQL to ensure optimal scalability and reliability.

+
+
+
+
How can I upgrade TBMQ to a newer version?
+
+

Upgrading TBMQ is straightforward. The Upgrade Guide + provides version-specific instructions and notes about compatibility changes or configuration updates introduced in each release.

+
+
+
-## How do I get started? +
+
+
How do I configure TBMQ for production use?
+
+

For production environments, TBMQ should be configured for performance, security, and fault tolerance. It is recommended to:

+
    +
  • Enable SSL/TLS encryption for MQTT and WebSocket connections.
    • +
  • Configure authentication providers for secure client validation.
    • +
  • Configure an appropriate number of Kafka partitions for each topic, tune producer and consumer parameters, and adjust Redis stateful connection settings to achieve optimal throughput.
    • +
  • Tune JVM memory and thread pool settings according to system resources.
    • +
+
+
+
+
Can I deploy TBMQ in Kubernetes?
+
+

Yes. TBMQ fully supports Kubernetes deployments through the official Helm chart or k8s manifests. This approach provides easy scaling, automatic recovery, and rolling updates. You can configure node roles, persistence volumes, and monitoring integrations directly through Helm values, making it suitable for cloud or hybrid environments.

+
+
+
+
How do I set up clustering in TBMQ?
+
+

TBMQ supports horizontal scaling through clustering. Each node in the cluster handles a portion of MQTT clients and message flow, ensuring reliability and load balancing. Cluster coordination is achieved using Kafka for message routing.

+

To enable clustering, deploy multiple TBMQ instances connected to the same Kafka, Redis, and PostgreSQL services, and configure a unique broker ID (TB_SERVICE_ID) in the environment variables per node.

+
+
+
+
What ports does TBMQ use?
+
+

By default, TBMQ listens on the following ports:

+
    +
  • 1883 – MQTT (plain TCP)
    • +
  • 8883 – MQTT over SSL/TLS
    • +
  • 8084 – MQTT over WebSocket
    • +
  • 8085 – MQTT over Secure WebSocket (WSS)
    • +
  • 8083 - HTTP Web UI access
    • +
+

These ports can be modified in the TBMQ configuration file or via environment variables before startup. Make sure your firewall or Kubernetes ingress rules allow access to the selected ports.

+
+
+
+
How can I enable TLS/SSL for secure connections?
+
+

You can enable SSL/TLS by providing a valid server certificate and private key in the TBMQ configuration. TBMQ supports both server-side encryption and client certificate authentication (X.509) for stronger security. Certificates can be issued by a trusted CA or generated internally for testing. Once configured, restart the broker to apply the changes.

+
+
+
+
How can I configure authentication providers in TBMQ?
+
+

TBMQ uses a pluggable authentication model, allowing you to define how clients are authenticated. You can choose between:

+
    +
  • Basic authentication (client ID, username, and password)
    • +
  • SSL-based authentication (X.509 certificate chain)
    • +
  • JWT authentication (JSON Web Tokens)
    • +
  • Enhanced authentication (MQTT 5.0)
    • +
+

Authentication rules are defined in the database and evaluated during each connection attempt.

+
+
+
-We recommend [installing](/docs/mqtt-broker/install/installation-options/) TBMQ locally on your laptop or PC using Docker -and follow the [getting started guide](/docs/mqtt-broker/getting-started/). +
+
+
Which MQTT protocol versions are supported?
+
+

TBMQ fully supports MQTT 3.1.1 and MQTT 5.0, ensuring compatibility with all major MQTT clients and libraries. Support for MQTT 5.0 introduces advanced features such as shared subscriptions, user properties, topic aliases, enhanced authentication, and reason codes, giving developers greater flexibility and control over client interactions.

+
+
+
+
Does TBMQ support MQTT over WebSocket?
+
+

Yes. TBMQ supports MQTT over WebSocket and Secure WebSocket (WSS), allowing browser-based applications and web dashboards to publish and subscribe to topics in real time. You can enable the WebSocket endpoints by default on:

+
    +
  • 8084 – MQTT over WebSocket
    • +
  • 8085 – MQTT over Secure WebSocket (WSS)
    • +
+

WebSocket support makes it easy to integrate MQTT communication into modern web applications and IoT portals.

+
+
+
+
How can I configure Keep Alive and Clean Start options?
+
+

TBMQ supports Keep Alive and Clean Start according to the MQTT specification.

+
    +
  • Keep Alive defines the maximum allowed idle time between messages from the client. If no packets are sent within this interval, the broker considers the connection lost.
    • +
  • Clean Start (MQTT 5.0) or Clean Session (MQTT 3.1.1) determines whether the broker should maintain the client’s session state after disconnect.
    • +
+

These options can be configured on the client side. TBMQ automatically handles session persistence and message queuing based on the chosen settings, ensuring reliable reconnect behavior.

+
+
+
-## What can I do with TBMQ? +
+
+
What can I do with TBMQ?
+
+

TBMQ enables seamless communication between MQTT clients, ensuring secure and efficient message exchange. It supports advanced MQTT 5.0 features such as shared subscriptions, enhanced authentication, topic aliasing, and flow control, providing flexibility for IoT applications of any scale. TBMQ is built for performance and scalability — whether you’re running a single instance for testing or a clustered setup serving thousands of clients.

+
+
+
+
Where can I host TBMQ?
+
+

You can host TBMQ in cloud environments, on-premises setups, or locally on your laptop or PC. For the fastest setup, we recommend using the Docker installation guide. If you plan to deploy TBMQ for production or cluster environments, refer to the Cluster Setup Guide for step-by-step instructions on configuring multi-node deployments using Docker Compose.

+
+
+
+
Can I replace the default TBMQ logo in the menu?
+
+ {% if docsPrefix == null %} +

The Community Edition of TBMQ does not include a built-in white-labeling feature. However, it is technically possible to replace the default logo by modifying the source code and rebuilding the platform. This approach requires development experience and familiarity with the TBMQ front-end codebase.

+

If you need an easier and fully supported way to customize the interface, consider upgrading to the Professional Edition. It allows you to upload your own logo and favicon, customize login and system pages, and adjust colors and branding palettes — all directly from the web interface, without any code changes.

+ {% endif %} + {% if docsPrefix == "pe/" %} +

Yes. In the Professional Edition, all branding and visual identity settings can be configured directly from the White Label page in the user interface — no code changes required. You can fully adapt the platform to your company’s look and feel with just a few clicks:

+
    +
  • Replace the default TBMQ logo and favicon with your own corporate visuals.
    • +
  • Customize login, dashboard, and system pages to greet users with your brand from the first interaction.
    • +
  • Adjust color palettes, accent tones, logo size, and styling options (including CSS tweaks) to match your identity.
    • +
  • Preview all changes live before publishing them.
    • +
  • Configure custom domains — map your own URL (for example, portal.company.com) so users access TBMQ through your branded domain.
    • +
+

These tools make it easy to deliver a fully branded experience that aligns with your organization’s visual standards.

+ {% endif %} +
+
+
-TBMQ enables seamless communication between MQTT clients, ensuring reliable data exchange. -It provides robust support for MQTT versions 3.x and 5.0, ensuring compatibility with a wide range of clients. -TBMQ enhances both functionality and scalability, making it suitable for IoT deployments of any size. +
+
+
What about security?
+
+

TBMQ ensures secure message exchange by supporting MQTT over SSL/TLS encryption, preventing unauthorized access and data tampering. It allows creating custom authentication providers for validating client credentials, and supports enhanced authentication (MQTT 5.0) for more flexible security models. You can integrate TBMQ with your existing certificate authority or use username/password-based authentication. These features provide a strong foundation for building secure and reliable IoT communication networks.

+
+
+
+
What authentication methods does TBMQ support?
+
+

TBMQ supports multiple authentication mechanisms to ensure secure and flexible client validation. The available methods include:

+
    +
  • Basic authentication – verifies client ID, username, and password credentials stored in the database.
    • +
  • X.509 certificate chain authentication – validates clients using SSL/TLS certificates.
    • +
  • Enhanced authentication (MQTT 5.0) – supports SCRAM-based authentication flows defined by the MQTT 5.0 specification.
    • +
  • JWT authentication – enables token-based authentication and integration with external identity systems via the TBMQ authentication API.
    • +
+

These options allow you to choose the best approach depending on your deployment and security requirements.

+
+
+
+
How can I enable client certificate authentication (SSL)?
+
+

TBMQ supports SSL/TLS encryption and client certificate authentication (X.509 certificate chain). To enable this feature:

+
    +
  1. Provide a valid server certificate and private key in the configuration file.
    2. +
  2. Enable the secure MQTT port (default: 8883).
    3. +
  3. Configure TBMQ to verify client certificates for mutual authentication using X.509 Certificate Chain credentials.
    4. +
+

This ensures that both the client and server validate each other’s identity before establishing a connection, adding a strong layer of security for IoT and enterprise deployments.

+
+
+
+
Does TBMQ support JWT authentication?
+
+

Yes. TBMQ supports JWT (JSON Web Token)–based authentication through authentication providers. This approach enables clients to connect securely using signed tokens instead of static credentials. JWT support is ideal for dynamic or short-lived sessions where credentials are issued by an external identity service.

+
+
+
+
How are unauthorized client connections handled?
+
+

TBMQ automatically detects and logs unauthorized connection attempts. When a client fails authentication, the broker records details such as client ID, IP address, username, and TLS status. This data can be reviewed in the Unauthorized Clients dashboard or queried via API for further analysis.

+
+
+
+
How can I monitor and block unauthorized clients?
+
+

TBMQ provides tools to monitor unauthorized clients directly through the web interface or REST API. Administrators can filter, inspect, and delete recorded entries. You can also apply blocking rules to reject future connection attempts from known malicious IP addresses or repeated offenders. This feature helps maintain system integrity and visibility into potential security risks.

+
+
+
-## Where can I host TBMQ? +
+
+
How does TBMQ manage subscriptions?
+
+

TBMQ manages client subscriptions using a Trie-based data structure, which provides fast and memory-efficient topic lookups. All client subscriptions are consumed from a Kafka topic and stored in memory within the Trie, where each node represents a level in the topic filter hierarchy.

+

The Trie structure enables prefix-based matching, allowing TBMQ to quickly identify all clients subscribed to topics that match a published message. When a PUBLISH message is read from Kafka, TBMQ uses the Trie to determine the set of clients with relevant subscriptions and forwards the message to each of them.

+

This approach ensures high-performance message routing, as the lookup time depends on the length of the topic rather than the total number of subscriptions. It scales efficiently even in large environments with millions of active subscriptions. While this method slightly increases memory usage due to in-memory storage of the Trie, it provides predictable and low-latency message delivery.

+
+
+
+
Does TBMQ support shared subscriptions?
+
+

Yes. TBMQ supports shared subscriptions as defined by the MQTT 5.0 specification. Shared subscriptions allow multiple clients to consume messages from the same topic group in a load-balanced manner. This feature is especially useful for scaling message processing horizontally — for example, distributing telemetry data processing among several backend services.

+
+
+
+
How are retained messages handled in TBMQ?
+
+

TBMQ supports retained messages, which ensure that newly connected subscribers immediately receive the most recent message published on a topic. When a client publishes a retained message, TBMQ stores it and delivers it automatically to any future subscribers of that topic. If a retained message with an empty payload is received, TBMQ clears the retained message for that topic, following the MQTT specification.

+
+
+
+
What is the difference between persistent and non-persistent sessions?
+
+

A persistent session stores the client’s subscriptions and undelivered QoS 1/2 messages, allowing message delivery to resume after reconnecting. A non-persistent session (Clean Start = true) is temporary — all subscriptions and queued messages are discarded when the client disconnects. TBMQ fully supports both modes and automatically handles session recovery for persistent clients after reconnecting.

+
+
+
+
How does TBMQ handle Last Will and Testament (LWT)?
+
+

TBMQ follows the MQTT standard for Last Will and Testament (LWT) messages. When a client connects, it can specify an LWT message that the broker will publish automatically if the client disconnects unexpectedly. This feature helps notify other clients or monitoring systems about abnormal disconnections, improving visibility and reliability in IoT systems.

+
+
+
+
How can I monitor the number of messages published and received?
+
+

TBMQ provides detailed metrics on message throughput, including the number of published, received, and dropped messages. These statistics are available through the built-in monitoring dashboard. Administrators can use these insights to track broker performance and optimize system configuration.

+
+
+
-The hosting options for TBMQ are highly flexible, allowing you to choose from cloud-based environments, on-premises setups, -or even running it locally on your personal laptop or PC. -For initiating the setup process, we advise opting for the [Docker installation](/docs/mqtt-broker/install/docker/), which offers a streamlined and efficient approach. -If you're interested in configuring a cluster setup, a comprehensive [guide](/docs/mqtt-broker/install/cluster/docker-compose-setup/) is available, specifically designed for Docker Compose setups. +
+
+
How many clients and messages per second can TBMQ support?
+
+

TBMQ offers horizontal scalability, meaning it can grow seamlessly with your workload. Each broker node in a cluster handles a portion of the load, ensuring balanced message processing and uninterrupted performance. Actual throughput depends on hardware, configuration, and message characteristics (size, QoS level, persistence). Optimized setups can handle millions of simultaneous client connections and millions of messages per second. For detailed metrics and benchmarks, visit the Performance Test Page.

+
+
+
+
How can I monitor TBMQ performance?
+
+

TBMQ exposes detailed performance metrics through its monitoring dashboard and Prometheus endpoint. You can track key indicators such as:

+
    +
  • Number of connected clients
    • +
  • Message publish and receive rates
    • +
  • Queue sizes and processing latency
    • +
  • Redis and Kafka performance
    • +
+

These metrics can be visualized in Grafana or other observability platforms to gain real-time insights into system health and throughput trends.

+
+
+
+
How does TBMQ handle backpressure when clients are slow?
+
+

TBMQ implements an internal backpressure management mechanism to maintain stable performance when clients are unable to consume messages quickly. When a client’s network channel becomes non-writable, TBMQ temporarily pauses message delivery for that client. Once the channel becomes writable again, queued messages are delivered in the correct order. This design prevents slow consumers from impacting other clients, ensuring consistent throughput across the cluster.

+
+
+
-## What about security? +
+
+
Where does TBMQ store data?
+
+

TBMQ integrates with Kafka, Redis, and PostgreSQL to ensure reliable, high-performance data storage:

+
    +
  • Kafka – handles unprocessed PUBLISH messages, persistent messages for Application clients, and stores client sessions and subscriptions.
    • +
  • Redis – stores Device persistent messages for fast access and recovery.
    • +
  • PostgreSQL – stores metadata such as user credentials, MQTT client credentials, system statistics, etc.
    • +
+

This hybrid architecture ensures data durability, high availability, and efficient delivery across distributed systems.

+
+
+
-TBMQ ensures secure communication by supporting MQTT with SSL/TLS encryption, safeguarding data transmission. -It also allows the creation of client credentials for authentication and authorization, bolstering system security. -With MQTT 5, TBMQ offers enhanced authentication features, enabling more flexible and dynamic client authentication mechanisms. -These measures provide robust protection against unauthorized access and strengthen overall security control in your IoT environment. - -## How many clients and messages per second can TBMQ support? - -TBMQ boasts horizontal scalability, meaning it can be expanded seamlessly to accommodate growing demands. -Each broker, or node, within the cluster possesses identical capabilities and handles a specific subset of the data. -It's worth noting that the actual performance of the system is contingent upon the specific usage scenario, -with factors such as payload size and message rate playing crucial roles in determining the overall efficiency and throughput of the system. -For a comprehensive understanding of the performance capabilities of TBMQ, we recommend referring to the dedicated -[performance test page](/docs/mqtt-broker/reference/100m-connections-performance-test/). - -## Where does TBMQ store data? - -TBMQ utilizes [Kafka](https://kafka.apache.org/), [Redis](https://redis.io/), and [PostgreSQL](https://www.postgresql.org/) for data storage. -Kafka handles unprocessed PUBLISH messages, persistent messages for Application clients, and stores client sessions and subscriptions, ensuring seamless data flow across broker nodes. -Redis is used for Device persistent clients, providing high-performance message storage and delivery. -PostgreSQL stores essential metadata, including user credentials, MQTT client details, and system statistics, ensuring data reliability and integrity. - -## What license type does TBMQ use? - -TBMQ is licensed under Apache 2.0 License. It is free for both personal and commercial usage, and you can deploy it anywhere. - -## How to get support? - -You can use troubleshooting instructions and community resources or [contact us](/docs/contact-us) and learn more about [services](/services/) we provide. +
+
+
What license type does TBMQ use?
+
+ {% if docsPrefix == null %} +

TBMQ CE is distributed under the Apache 2.0 License, allowing both personal and commercial usage. You can freely deploy, modify, and distribute it in any environment without additional licensing costs.

+ {% endif %} + {% if docsPrefix == "pe/" %} +

TBMQ PE is a commercially licensed version of TBMQ available under a subscription-based license. It includes additional enterprise-grade features, support services, and maintenance. Use of the PE version requires a valid license agreement with ThingsBoard, Inc.

+ {% endif %} +
+
+
+
How to get support?
+
+

You can access community-driven troubleshooting guides and documentation, or contact us directly for technical assistance. Learn more about services we provide.

+
+
+
+
+
+
\ No newline at end of file From 47b43217c7a0e6dfe0a5d3bd3a9729109b9d8d13 Mon Sep 17 00:00:00 2001 From: Yevheniia Mala Date: Fri, 5 Dec 2025 18:15:53 +0200 Subject: [PATCH 4/9] TB Edge docs --- _includes/docs/edge/faq.md | 351 ++++++++++++++++++++++++++---- _includes/docs/mqtt-broker/faq.md | 8 - docs/edge/faq.md | 1 + docs/mqtt-broker/faq.md | 2 +- docs/pe/edge/faq.md | 1 + 5 files changed, 306 insertions(+), 57 deletions(-) diff --git a/_includes/docs/edge/faq.md b/_includes/docs/edge/faq.md index fffcae80f4..a06541398e 100644 --- a/_includes/docs/edge/faq.md +++ b/_includes/docs/edge/faq.md @@ -77,123 +77,378 @@ function switchEdgeFaqTab(tabId) {
General Questions
-
Installation & Setup
+
Community vs. Professional Edition
Features & Capabilities
+
Installation & Setup
Support
-
What is ThingsBoard Edge?
+
What is ThingsBoard Edge {{edgeName}}?
-

ThingsBoard Edge is a solution that brings data processing and analytics capabilities closer to the data source. It runs on edge devices and gateways, reducing latency and bandwidth usage while maintaining connectivity with the central ThingsBoard server.

+ {% if docsPrefix == "pe/edge/" %} +

ThingsBoard Edge Professional Edition (PE) is the commercial tier of our edge computing solution. While the Community Edition provides core edge functionality, PE adds enterprise features needed for production deployments at scale.

+ {% else %} +

ThingsBoard Edge Community Edition (CE) is a free, open-source platform designed specifically for edge computing scenarios. It provides essential capabilities for managing and analyzing IoT data at the edge, while staying seamlessly synchronized with the ThingsBoard Server (Cloud or On-premise).

+ {% endif %} +

New to edge computing? Edge computing means processing data where it's generated rather than sending everything to the cloud.

+

See What is Edge? for a detailed introduction, or jump to our Getting Started to begin working with ThingsBoard Edge.

-
I can deploy ThingsBoard Server on-site. Why should I deploy ThingsBoard Edge instead?
+
I can deploy Server on-site. Why should I deploy Edge instead?
-

Server is designed for centralized deployment and requires robust infrastructure. Edge is lightweight, runs on minimal hardware (like Raspberry Pi), and is purpose-built for distributed locations.

-

Use Edge when you have multiple sites that need local processing with automatic sync to a central Server. Server is your central hub; Edge extends that capability to remote sites that need local processing but don't need the full server infrastructure.

+

If you only have one site, deploying ThingsBoard Server on-premises may be enough.

+

Use ThingsBoard Edge when you have multiple or remote locations that need local processing, dashboards, and automation, but you don’t want a full Server at each site.

+

Server stays your central hub, while Edge runs on lightweight hardware at each site and keeps working offline, then syncs data and configuration back to Server.

-
What's the difference between Community Edition and Professional Edition?
+
How do I get ThingsBoard Edge {{edgeName}}?
-

Community Edition provides core edge computing features and is suitable for development and small deployments. Professional Edition includes:

+ {% if docsPrefix == "pe/edge/" %} +

Edge {{edgeName}} is an add-on to your ThingsBoard PE subscription. Your plan includes a base number of Edge instances, and you can purchase additional instances as needed.

+

See the Pricing Page for details on what's included with each plan or contact your System Administrator.

+ {% else %} +

Edge {{edgeName}} is open-source and free to download. Install from our documentation or access source code on GitHub

+

You'll need a ThingsBoard Server instance to connect Edge to. See our Getting Started guide for complete setup instructions.

+ {% endif %} +
+
+
+
What happens if my internet connection drops?
+
+

Edge keeps running. It processes data, triggers alarms, and updates dashboards locally — no cloud required. When connectivity returns, Edge automatically syncs everything with your ThingsBoard Server. No data loss, no manual intervention.

+
+
+
+
Can Edge handle my device volume?
+
+

We recommend up to 1,000 devices per Edge instance based on typical edge hardware and connectivity constraints. You can exceed this number; performance depends on your specific hardware and network conditions.

+

If you need more capacity, you can deploy multiple Edge instances. Alternatively, if you are using version 4.0 or later, you can cluster Edge nodes for high availability.

+
+
+
+
I have devices that use proprietary protocols. Can Edge connect to them?
+
+

Yes. Edge natively supports MQTT, CoAP, HTTP, SNMP, and LwM2M. For other protocols, use:

+
+
Can I customize and modify the Edge {{edgeName}}?
+
+ {% if docsPrefix == "pe/edge/" %} +

No, the ThingsBoard {{edgeName}} is a commercial project and can not be modified.

+ {% else %} +

Yes, the source code is available on GitHub, and you can fork and modify it to suit your needs. By the way, please consider starring our repository.

+ {% endif %} +
+
-
+
+
+
What's the difference between Edge Community Edition and Professional Edition?
+
+

Both editions provide device management, rule engine, dashboards, and standard protocols (MQTT, CoAP, HTTP, etc.).

+

Community Edition is free and open-source.

+

Professional Edition is commercial and adds:

+
    +
  • White-labeling: Deploy under your company's brand
    • +
  • Solution templates: Pre-built IoT solutions ready to install with dashboards, rule chains, and sample devices
    • +
  • Converter library: Ready-to-use decoder functions for 100+ devices across 6 LoRaWAN networks
    • +
  • Scheduler: Automate report generation, attribute updates, and device commands
    • +
+
+
-
How do I install ThingsBoard Edge?
+
Do I need Edge PE if I'm building a commercial product?
-

You can install ThingsBoard Edge using several methods:

+

Not necessarily. Community Edition is production-ready and supports commercial deployments. You can build, sell, and deploy commercial products on CE.

+

The choice between CE and PE depends on your specific requirements.

+

Consider PE if you need to:

    -
  • Docker installation (recommended for quick setup)
    • -
  • Package installation (Ubuntu/CentOS)
    • -
  • Building from source
    • +
  • Deliver a branded product to customers
    • +
  • Connect legacy equipment via OPC-UA or other industrial protocols
    • +
  • Deploy pre-built solutions (irrigation, water metering, waste management, etc.)
    • +
  • Manage multiple end-customers with hierarchical access control
-

See the installation guide for detailed instructions.

-
What are the system requirements?
+
Can I use Edge Professional Edition with Community Edition Server and vise versa?
-

Minimum system requirements:

+

No. Edge edition must match your ThingsBoard Server edition:

    -
  • RAM: 1GB minimum, 2GB recommended
    • -
  • Storage: 10GB minimum
    • -
  • Java: OpenJDK 11 or higher
    • -
  • Network: Stable internet connection for synchronization
    • +
  • Edge CE connects to ThingsBoard Server CE
    • +
  • Edge PE connects to ThingsBoard Server PE
+

PE-specific features (white-labeling, solution templates, integrations, etc.) require both Edge PE and Server PE to function.

-
Does Edge require constant connection to ThingsBoard Server?
+
How many Edge instances can connect to one Server?
-

No. ThingsBoard Edge can operate autonomously during network outages. It processes data locally and stores it until connectivity is restored, at which point it automatically synchronizes with the ThingsBoard server.

+
    +
  • Edge CE: The number of Edge instances is unlimited.
    • +
  • Edge PE: The number of included Edge instances depends on your ThingsBoard PE plan. You can add additional Edge instances with extra cost per month. Check your plan details or contact your administrator to see how many Edge instances are included.
    • +
+
+
+
+
How do I start a free trial?
+
+

Community Edition is free and open-source - no trial needed. Download and use it indefinitely at no cost.

+

For Professional Edition, start a 30-day trial of the Maker plan with Edge Computing add-on enabled. You'll have full access to Edge PE features.

+
-
What protocols does Edge support?
+
What core features are available in the {{edgeName}}?
-

ThingsBoard Edge supports the following protocols:

+ {% if docsPrefix == "pe/edge/" %} +

The {{edgeName}} includes all the features of the Community Edition plus additional functionality:

    +
  • White Labeling
    • +
  • Scheduler
    • +
  • Integrations
    • +
  • Custom menu
    • +
  • and more
+ {% else %} +

The {{edgeName}} includes features for:

    -
  • MQTT
    • -
  • CoAP
    • -
  • HTTP
    • -
  • LwM2M
    • +
  • Device management and telemetry
    • +
  • Rule engine for data processing
    • +
  • Dashboard creation
    • +
  • Support for MQTT, CoAP and HTTP protocols
    • +
  • Open-source extensibility through plugins
+ {% endif %}
+ +
+ {% if docsPrefix == "edge/" %} +
+
How do I get ThingsBoard Edge {{edgeName}}?
+
+

In order to use Edge Professional Edition, you'll need to upgrade to ThingsBoard Professional Edition first. Then, add the Edge Computing add-on to your subscription. Your plan includes a base number of Edge instances, and you can purchase additional instances as needed.

+

See the Pricing Page for details on what's included with each plan or contact your System Administrator.

+
+
+ {% endif %} + +
+
Does the ThingsBoard Edge support multi-tenancy?
+
+

No, ThingsBoard Edge {{edgeName}} does not support multi-tenancy.

+ {% if docsPrefix == 'pe/edge/' %} +

{{edgeName}} supports a single tenant and multiple customers with hierarchy.

+

For instance, if an Edge owner is a sub-customer, all the parent entities of that sub-customer up to the tenant level will be provisioned to the Edge. + This means customers from the same hierarchy path can access the same Edge instance.

+

However, you can not share an instance between multiple tenants, and devices from multiple tenants can not connect to a single Edge instance. + If you need multi-tenancy, provision multiple Edge instances for each tenant.

+ {% else %} +

{{edgeName}} is designed for a single tenant and a single customer. This means that you can not share a single Edge instance between multiple tenants or customers, as well as devices from different tenants can not be connected to the same Edge instance.

+

If you need multi-tenancy, provision multiple Edge instances for each tenant.

+ {% endif %} +
+
+ +
+
How many devices can ThingsBoard Edge support?
+
+ {% if docsPrefix == 'pe/edge/' %} +

The number of connected devices depends on your subscription plan.

+

Some plans offer 'Unlimited Devices and Assets, thus there are no soft limits on creating devices and assets on the edge side.

+ {% else %} +

ThingsBoard Edge doesn’t impose a fixed limit on the number of devices you can connect.

+

In practice, the number of devices you can support depends largely on your hardware resources, system configuration, and the specific use case. + Since ThingsBoard Edge is designed with remote locations with potentially low bandwidth connectivity in mind, we do not recommend connecting more than 1000 devices to a single edge.

+ {% endif %} +
+
+ + {% if docsPrefix == "edge/" %} +
+
Does the Community Edition support white-labeling?
+
+

No, white-labeling is available only in the Professional Edition.

+
+
+ {% endif %} + +
+
Can I integrate third-party systems with ThingsBoard Edge?
+
+

Yes, you can integrate the ThingsBoard Edge {{edgeName}} with third-party systems through REST APIs.

+ {% if docsPrefix == "pe/edge/" %} +

Also, the platform integrations are available for the {{edgeName}}.

+ {% else %} +

However, the platform integrations, which are available only in the Professional Edition, are not included in the Community Edition.

+ {% endif %} +
+
+ +
+
What databases does the ThingsBoard Edge support?
+
+

The ThingsBoard Edge supports pure SQL or a hybrid SQL + NoSQL (for telemetry storage) approach. For more details on database options, you can check here.

+
+
+
-
What happens when Edge loses connection to the server?
+
Can I automate device management and telemetry processing?
-

ThingsBoard Edge continues to function during network outages. It processes data locally, executes rule chains, and stores data. Once connectivity is restored, all collected data and events are automatically synchronized with the ThingsBoard server.

+

Yes, you can. The Rules Engine allows for event-based processing and alerts.

+
-
How long can Edge store data locally?
+
Does Edge {{edgeName}} support OTA (Over-the-Air) firmware updates?
-

The duration depends on your storage capacity and data volume. ThingsBoard Edge stores data in a local database and can retain information until connectivity is restored or storage limits are reached. You can configure data retention policies based on your requirements.

+

Yes, the {{edgeName}} supports OTA (Over-the-Air) firmware updates.

+
+
+ +
+
Is there a mobile app for ThingsBoard Edge {{edgeName}}?
+
+

No, there is no dedicated mobile app for ThingsBoard Edge {{edgeName}}.

+

However, you can access and manage ThingsBoard Edge through a web browser on any device, including mobile devices, by visiting the ThingsBoard Edge dashboard (typically hosted on port 8080).

+
+
+ +
+
Does ThingsBoard Edge {{edgeName}} support AI or machine learning integrations?
+
+

Not natively, but you can incorporate AI or ML into your ThingsBoard Edge deployment using custom development or third-party integrations.

+
+
+ +
+
How do I upgrade to the latest version of ThingsBoard Edge?
+
+

In order to upgrade to the latest version of ThingsBoard Edge, please follow these instructions.

+
+
+ +
+
How can I connect my device?
+
+

ThingsBoard Edge supports various protocols, including MQTT, CoAP, HTTP, and LwM2M.

+

Legacy devices can be connected to the platform via ThingsBoard Gateway. More information is available on the connectivity page.

+ {% if docsPrefix == 'pe/edge/' %} +

You can also use the ThingsBoard Integrations to connect devices from different sources and with custom payloads to the edge.

+ {% endif %} +
+
+ +
+
Do I need to use a software development kit (SDK)?
+
+

No, many IoT devices are not designed to embed third-party SDKs.

+

ThingsBoard Edge provides a simple API over common IoT protocols, so you can choose any client-side library you like, or even use your own. + Some useful references include MQTT client-side libraries list and C-implementation for CoAP.

+
+
+
+ + +
+
Does ThingsBoard Edge support clustering?
+
+

The earlier versions of ThingsBoard Edge do not support clustering. It is designed to operate, process and analyze data locally before synchronizing with the central Server.

+

Starting with release 4.0, Edge supports clustering. Multiple Edge nodes can be clustered to provide high availability. If one node fails, the others can seamlessly continue to handle workloads.

+
+
+ +
+
Is there an official Docker image for ThingsBoard Edge?
+
+

Yes, official Docker images are available on Docker Hub.

+
+
+ +
+
Can I run ThingsBoard Edge on Raspberry Pi or other edge devices?
+
+

Yes, ThingsBoard Edge is specifically designed to run on a variety of Edge hardware platforms, including single-board computers like Raspberry Pi and other devices with sufficient processing power and memory.

+
+
+ +
+
Where does ThingsBoard Edge store time-series data?
+
+

Depending on your database approach, there are two options. If you've chosen a hybrid approach, the time-series data will be stored in Cassandra. Otherwise, the data is stored in the PostgreSQL database, which is well suited for storing and querying entities and local time-series data.

+
+
+ +
+
What should I do if I have legacy devices to connect?
+
+

If you have legacy devices that don't natively speak one of the protocols supported by ThingsBoard Edge (such as MQTT, CoAP, or HTTP), you can still connect them by installing ThingsBoard IoT Gateway. It will act as a bridge between your legacy devices and ThingsBoard Edge.

+

ThingsBoard IoT Gateway is available out-of-the-box and requires no additional fees.

+
-
Where can I get support for Edge CE?
+
What support options are available for the {{edgeName}}?
-

Support options for ThingsBoard Edge Community Edition:

+ {% if docsPrefix == "pe/edge/" %} +

All subscriptions include optional support.

+

Also, support can be provided by the ThingsBoard community

+ {% else %} +

Support for the Community Edition is primarily community-driven, including:

+ {% endif %}
+ + {% if docsPrefix == "pe/edge/" %} +
+
Do you offer 24/7 customer support?
+
+

Yes, we do provide 24/7 support. If this is what you're looking for, please contact us for a more detailed discussion about your specific needs.

+
+
+ {% else %} +
+
What should I do if I find a bug in Community Edition?
+
+

You can report it on GitHub Issues, and the open-source community may help fix it.

+
+
+
-
What license does Edge CE use?
+
Can I contribute to the development of ThingsBoard Edge Community Edition?
-

ThingsBoard Edge Community Edition is distributed under Apache License 2.0, which allows you to use, modify, and distribute the software freely for both commercial and non-commercial purposes.

+

Yes! Pull requests and contributions are welcome on GitHub. By the way, please consider starring our repository.

+
-
Can I use Edge CE for commercial projects?
+
Is official support available for the Community Edition?
-

Yes, ThingsBoard Edge Community Edition can be used for commercial projects under the Apache License 2.0. However, for production deployments requiring additional features, SLA guarantees, and professional support, we recommend considering Professional Edition.

+

No, official support is not included in the Community Edition. For official support, consider upgrading to a paid edition.

+ {% endif %}
+
\ No newline at end of file diff --git a/_includes/docs/mqtt-broker/faq.md b/_includes/docs/mqtt-broker/faq.md index 01070c3a6f..9d8d5686c9 100644 --- a/_includes/docs/mqtt-broker/faq.md +++ b/_includes/docs/mqtt-broker/faq.md @@ -169,7 +169,6 @@ function switchTbmqFaqTab(tabId) { -
How do I configure TBMQ for production use?
@@ -230,7 +229,6 @@ function switchTbmqFaqTab(tabId) {
-
Which MQTT protocol versions are supported?
@@ -261,7 +259,6 @@ function switchTbmqFaqTab(tabId) {
-
What can I do with TBMQ?
@@ -296,7 +293,6 @@ function switchTbmqFaqTab(tabId) {
-
What about security?
@@ -348,7 +344,6 @@ function switchTbmqFaqTab(tabId) {
-
How does TBMQ manage subscriptions?
@@ -389,7 +384,6 @@ function switchTbmqFaqTab(tabId) {
-
How many clients and messages per second can TBMQ support?
@@ -417,7 +411,6 @@ function switchTbmqFaqTab(tabId) {
-
Where does TBMQ store data?
@@ -432,7 +425,6 @@ function switchTbmqFaqTab(tabId) {
-
What license type does TBMQ use?
diff --git a/docs/edge/faq.md b/docs/edge/faq.md index 96951ffc0a..3cf92aa2f3 100644 --- a/docs/edge/faq.md +++ b/docs/edge/faq.md @@ -6,5 +6,6 @@ description: ThingsBoard Edge FAQs --- {% assign docsPrefix = "edge/" %} +{% assign edgeName = "Community Edition" %} {% include docs/edge/faq.md %} diff --git a/docs/mqtt-broker/faq.md b/docs/mqtt-broker/faq.md index 7cd9422b94..b5970e39db 100644 --- a/docs/mqtt-broker/faq.md +++ b/docs/mqtt-broker/faq.md @@ -1,6 +1,6 @@ --- layout: docwithnav-mqtt-broker -title: FAQ +title: MQTT Broker FAQs description: TBMQ FAQ --- diff --git a/docs/pe/edge/faq.md b/docs/pe/edge/faq.md index 96550852b9..5a3c4f6d07 100644 --- a/docs/pe/edge/faq.md +++ b/docs/pe/edge/faq.md @@ -7,4 +7,5 @@ description: ThingsBoard Edge FAQs {% assign docsPrefix = "pe/edge/" %} {% assign peDocsPrefix = "pe/" %} +{% assign edgeName = "Professional Edition" %} {% include docs/edge/faq.md %} \ No newline at end of file From 1c75500d9782c5649c9fd9821e44bc32a66492a8 Mon Sep 17 00:00:00 2001 From: Yevheniia Mala Date: Mon, 8 Dec 2025 17:28:59 +0200 Subject: [PATCH 5/9] TB Edge docs --- _includes/docs/edge/faq.md | 225 +++++++++++++++++------------- _includes/docs/mqtt-broker/faq.md | 4 +- docs/edge/faq.md | 2 +- docs/mqtt-broker/faq.md | 2 +- docs/pe/edge/faq.md | 2 +- 5 files changed, 131 insertions(+), 104 deletions(-) diff --git a/_includes/docs/edge/faq.md b/_includes/docs/edge/faq.md index a06541398e..d3f9afe8ca 100644 --- a/_includes/docs/edge/faq.md +++ b/_includes/docs/edge/faq.md @@ -73,11 +73,13 @@ function switchEdgeFaqTab(tabId) { } +

Edge Computing - {{edgeName}}

+
General Questions
-
Community vs. Professional Edition
+
Edition Comparison & Upgrade
Features & Capabilities
Installation & Setup
Support
@@ -116,6 +118,12 @@ function switchEdgeFaqTab(tabId) { {% endif %}
+
+
Can I run ThingsBoard Edge on Raspberry Pi or other edge devices?
+
+

Yes, ThingsBoard Edge is specifically designed to run on a variety of Edge hardware platforms, including single-board computers like Raspberry Pi and other devices with sufficient processing power and memory.

+
+
What happens if my internet connection drops?
@@ -156,7 +164,7 @@ function switchEdgeFaqTab(tabId) {
What's the difference between Edge Community Edition and Professional Edition?
-

Both editions provide device management, rule engine, dashboards, and standard protocols (MQTT, CoAP, HTTP, etc.).

+

Both editions provide device management, rule engine, dashboards, and standard protocols (MQTT, CoAP, HTTP, etc.).

Community Edition is free and open-source.

Professional Edition is commercial and adds:

    @@ -197,54 +205,55 @@ function switchEdgeFaqTab(tabId) {
    • Edge CE: The number of Edge instances is unlimited.
      • -
    • Edge PE: The number of included Edge instances depends on your ThingsBoard PE plan. You can add additional Edge instances with extra cost per month. Check your plan details or contact your administrator to see how many Edge instances are included.
      • +
    • Edge PE: The number of included Edge instances depends on your ThingsBoard PE plan. You can add extra Edge instances for an additional monthly cost. Check your plan details or contact your administrator to see how many Edge instances are included.
      • +
    +
    +
+
+
Can I migrate from Edge CE to Edge PE?
+
+

Yes, but it requires upgrading your entire system:

+
    +
  • Upgrade your ThingsBoard Server from CE to PE.
    • +
  • Purchase the Edge Computing add-on for your PE license
    • +
  • Reinstall Edge using PE packages
+

Before upgrading: Back up any custom dashboards, rule chains, or configurations. Consult our support team for assistance or see our migration guide for step-by-step instructions.

How do I start a free trial?

Community Edition is free and open-source - no trial needed. Download and use it indefinitely at no cost.

-

For Professional Edition, start a 30-day trial of the Maker plan with Edge Computing add-on enabled. You'll have full access to Edge PE features.

+

For Professional Edition, start a 30-day trial of the Maker plan with Edge Computing add-on enabled. You'll have full access to Edge PE features.

-
What core features are available in the {{edgeName}}?
{% if docsPrefix == "pe/edge/" %} -

The {{edgeName}} includes all the features of the Community Edition plus additional functionality:

    -
  • White Labeling
    • -
  • Scheduler
    • -
  • Integrations
    • -
  • Custom menu
    • -
  • and more
+

Edge {{edgeName}} includes all Community Edition features plus:

+ {% else %} -

The {{edgeName}} includes features for:

+

Edge {{edgeName}} provides complete edge computing functionality:

    -
  • Device management and telemetry
    • -
  • Rule engine for data processing
    • -
  • Dashboard creation
    • -
  • Support for MQTT, CoAP and HTTP protocols
    • -
  • Open-source extensibility through plugins
    • +
  • Device connectivity: MQTT, CoAP, HTTP, SNMP, and LwM2M protocols
    • +
  • Local data processing: Rule engine for real-time analytics and automation
    • +
  • Visualization: Dashboard creation and customization
    • +
  • Data management: Device telemetry collection and attribute management
    • +
  • Open-source: Fully open-source with active community support
{% endif %}
- -
- {% if docsPrefix == "edge/" %} -
-
How do I get ThingsBoard Edge {{edgeName}}?
-
-

In order to use Edge Professional Edition, you'll need to upgrade to ThingsBoard Professional Edition first. Then, add the Edge Computing add-on to your subscription. Your plan includes a base number of Edge instances, and you can purchase additional instances as needed.

-

See the Pricing Page for details on what's included with each plan or contact your System Administrator.

-
-
- {% endif %} -
Does the ThingsBoard Edge support multi-tenancy?
@@ -261,85 +270,122 @@ function switchEdgeFaqTab(tabId) { {% endif %}
- + {% if docsPrefix == "edge/" %}
-
How many devices can ThingsBoard Edge support?
+
Does Edge {{edgeName}} support UI customization options, such as white-labeling or custom menu?
- {% if docsPrefix == 'pe/edge/' %} -

The number of connected devices depends on your subscription plan.

-

Some plans offer 'Unlimited Devices and Assets, thus there are no soft limits on creating devices and assets on the edge side.

- {% else %} -

ThingsBoard Edge doesn’t impose a fixed limit on the number of devices you can connect.

-

In practice, the number of devices you can support depends largely on your hardware resources, system configuration, and the specific use case. - Since ThingsBoard Edge is designed with remote locations with potentially low bandwidth connectivity in mind, we do not recommend connecting more than 1000 devices to a single edge.

- {% endif %} +

White-labeling and custom menu configuration are Professional Edition features that provide UI customization without code changes.

+

{{edgeName}} is open-source, allowing developers to customize the interface by modifying the source code.

- - {% if docsPrefix == "edge/" %} + {% endif %}
-
Does the Community Edition support white-labeling?
+
Does ThingsBoard Edge {{edgeName}} support AI or machine learning integrations?
-

No, white-labeling is available only in the Professional Edition.

+

Yes. Edge includes an AI Request node in the Rule Engine that allows integration with AI services like OpenAI, Azure OpenAI, and custom AI endpoints. You can use this for predictive maintenance, anomaly detection, natural language processing, and other AI-powered analytics.

+

See AI predictive maintenance example for implementation details.

- {% endif %} -
Can I integrate third-party systems with ThingsBoard Edge?
-

Yes, you can integrate the ThingsBoard Edge {{edgeName}} with third-party systems through REST APIs.

+

Yes, Edge {{edgeName}} supports integration through:

{% if docsPrefix == "pe/edge/" %} -

Also, the platform integrations are available for the {{edgeName}}.

+
    +
  • REST APIs: For request/response interactions.
    • +
  • Platform Integrations: For built-in connectors to OPC-UA servers, and other platforms.
    • +
{% else %} -

However, the platform integrations, which are available only in the Professional Edition, are not included in the Community Edition.

+
    +
  • REST APIs: For request/response interactions.
    • +
+

For built-in platform connectors (OPC-UA, CoAP etc.), see Professional Edition Integrations.

{% endif %}
-
-
What databases does the ThingsBoard Edge support?
+
Does ThingsBoard Edge support clustering?
-

The ThingsBoard Edge supports pure SQL or a hybrid SQL + NoSQL (for telemetry storage) approach. For more details on database options, you can check here.

+

Starting with version 4.0, yes. You can cluster multiple Edge nodes for high availability. If one node fails, others continue handling workloads.

+

Earlier versions run as single instances.

+

Refer to Edge Cluster Setup documentation for more details.

+
+
+
+
What databases and message queue implementations does ThingsBoard Edge support?
+
+

Edge {{edgeName}} supports pure SQL and a hybrid SQL + NoSQL (for telemetry storage) approaches, which are:

+
    +
  • PostgreSQL: Default, suitable for most deployments.
    • +
  • PostgreSQL + Cassandra: Hybrid approach for high-volume telemetry - 1M+ devices or >5,000 msg/sec.
    • +
+

Edge also supports different message queue implementations:

+
    +
  • PostgreSQL: Built-in default, suitable for PoC and testing environments - not for production or any sort of cluster deployments.
    • +
  • Kafka: Recommended for production deployments.
    • +
-
Can I automate device management and telemetry processing?
-

Yes, you can. The Rules Engine allows for event-based processing and alerts.

+

Yes. you can. The Rule Engine allows you to automate device workflows, data processing, and alerts based on incoming telemetry.

+

For example, you can automatically provision devices, transform data, trigger actions based on thresholds, or forward telemetry to external systems.

+
+
+
+
Can I run rule chains on Edge?
+
+

Yes. Edge runs rule chains locally for real-time processing. Starting with version 4.0, you can create and edit rule chains directly on Edge. In earlier versions, rule chains are configured as templates on the Server and pushed to Edge.

+

See Edge Rule Chain Templates for more information.

-
Does Edge {{edgeName}} support OTA (Over-the-Air) firmware updates?
-

Yes, the {{edgeName}} supports OTA (Over-the-Air) firmware updates.

+

Yes. You can manage firmware versions, schedule updates, and track deployment status across your devices. See OTA updates documentation for setup instructions.

-
Is there a mobile app for ThingsBoard Edge {{edgeName}}?
-

No, there is no dedicated mobile app for ThingsBoard Edge {{edgeName}}.

-

However, you can access and manage ThingsBoard Edge through a web browser on any device, including mobile devices, by visiting the ThingsBoard Edge dashboard (typically hosted on port 8080).

+

No, there is no dedicated mobile app for ThingsBoard Edge.

+

However, you can access and manage Edge instance through a web browser on any device, including mobile devices. Typically, instance is hosted on port 8080.

- +
+
-
Does ThingsBoard Edge {{edgeName}} support AI or machine learning integrations?
+
Is Edge version tied to Server version?
-

Not natively, but you can incorporate AI or ML into your ThingsBoard Edge deployment using custom development or third-party integrations.

+

Partially. Edge version X.Y.Z works with:

+
    +
  • Server version X.Y.Z (same version)
    • +
  • Server versions X.Y+1 and X.Y+2 (up to two minor versions ahead)
    • +
+

Edge does not work with older Server versions.

+

Example: Edge 3.8.0 works with Server 3.8.0, 3.8.1, and 3.9.0 — but not with Server 3.7.x or earlier. If your Edge is newer than your Server, upgrade the Server first.

+

See also Edge Release Notes

+
+
+
+
How much hardware do I need to run Edge?
+
+

Less than you might think. Edge runs on:

+
    +
  • Raspberry Pi or similar single-board computers
    • +
  • Industrial gateways
    • +
  • Mini PCs or embedded systems
    • +
  • Any machine with 1GB+ RAM for light workloads, 4GB+ for heavy use
    • +
-
-
How do I upgrade to the latest version of ThingsBoard Edge?
+
How to upgrade to the latest version?
-

In order to upgrade to the latest version of ThingsBoard Edge, please follow these instructions.

+

To upgrade to the latest version, follow upgrade instructions.

-
How can I connect my device?
@@ -350,56 +396,39 @@ function switchEdgeFaqTab(tabId) { {% endif %}
- -
-
Do I need to use a software development kit (SDK)?
-
-

No, many IoT devices are not designed to embed third-party SDKs.

-

ThingsBoard Edge provides a simple API over common IoT protocols, so you can choose any client-side library you like, or even use your own. - Some useful references include MQTT client-side libraries list and C-implementation for CoAP.

-
-
-
- -
-
Does ThingsBoard Edge support clustering?
+
How do I install Edge?
-

The earlier versions of ThingsBoard Edge do not support clustering. It is designed to operate, process and analyze data locally before synchronizing with the central Server.

-

Starting with release 4.0, Edge supports clustering. Multiple Edge nodes can be clustered to provide high availability. If one node fails, the others can seamlessly continue to handle workloads.

+

Edge runs on Docker, Ubuntu, CentOS, Windows, and Raspberry Pi. See the Installation Guide for step-by-step instructions.

+

See the Installation Options for step-by-step instructions.

-
Is there an official Docker image for ThingsBoard Edge?
-

Yes, official Docker images are available on Docker Hub.

-
-
- -
-
Can I run ThingsBoard Edge on Raspberry Pi or other edge devices?
-
-

Yes, ThingsBoard Edge is specifically designed to run on a variety of Edge hardware platforms, including single-board computers like Raspberry Pi and other devices with sufficient processing power and memory.

+ {% if docsPrefix == 'pe/edge/' %} +

Yes, the official Docker image is available on Docker Hub.

+ {% else %} +

Yes, the official Docker image is available on Docker Hub.

+ {% endif %}
-
Where does ThingsBoard Edge store time-series data?
-

Depending on your database approach, there are two options. If you've chosen a hybrid approach, the time-series data will be stored in Cassandra. Otherwise, the data is stored in the PostgreSQL database, which is well suited for storing and querying entities and local time-series data.

+

By default, Edge stores time-series data in PostgreSQL, which handles both device metadata and telemetry efficiently for typical deployments.

+

For high-volume scenarios (1M+ devices or >5,000 msg/sec), you can configure a hybrid setup where time-series data is stored in Cassandra while PostgreSQL handles device metadata and attributes.

-
-
What should I do if I have legacy devices to connect?
+
Do I need to use a software development kit (SDK)?
-

If you have legacy devices that don't natively speak one of the protocols supported by ThingsBoard Edge (such as MQTT, CoAP, or HTTP), you can still connect them by installing ThingsBoard IoT Gateway. It will act as a bridge between your legacy devices and ThingsBoard Edge.

-

ThingsBoard IoT Gateway is available out-of-the-box and requires no additional fees.

+

No, many IoT devices are not designed to embed third-party SDKs.

+

ThingsBoard Edge provides a simple API over common IoT protocols, so you can choose any client-side library you like, or even use your own. + Some useful references include MQTT client-side libraries list and C-implementation for CoAP.

-
What support options are available for the {{edgeName}}?
@@ -417,7 +446,6 @@ function switchEdgeFaqTab(tabId) {
- {% if docsPrefix == "pe/edge/" %}
Do you offer 24/7 customer support?
@@ -432,14 +460,12 @@ function switchEdgeFaqTab(tabId) {

You can report it on GitHub Issues, and the open-source community may help fix it.

-
Can I contribute to the development of ThingsBoard Edge Community Edition?

Yes! Pull requests and contributions are welcome on GitHub. By the way, please consider starring our repository.

-
Is official support available for the Community Edition?
@@ -448,7 +474,6 @@ function switchEdgeFaqTab(tabId) {
{% endif %}
-
\ No newline at end of file diff --git a/_includes/docs/mqtt-broker/faq.md b/_includes/docs/mqtt-broker/faq.md index 9d8d5686c9..391d5c31aa 100644 --- a/_includes/docs/mqtt-broker/faq.md +++ b/_includes/docs/mqtt-broker/faq.md @@ -1,5 +1,5 @@ @@ -102,7 +160,7 @@ function switchEdgeFaqTab(tabId) {
I can deploy Server on-site. Why should I deploy Edge instead?

If you only have one site, deploying ThingsBoard Server on-premises may be enough.

-

Use ThingsBoard Edge when you have multiple or remote locations that need local processing, dashboards, and automation, but you don’t want a full Server at each site.

+

Use ThingsBoard Edge when you have multiple or remote locations that need local processing, dashboards, and automation, but you don't want a full Server at each site.

Server stays your central hub, while Edge runs on lightweight hardware at each site and keeps working offline, then syncs data and configuration back to Server.

@@ -137,10 +195,10 @@ function switchEdgeFaqTab(tabId) {

If you need more capacity, you can deploy multiple Edge instances. Alternatively, if you are using version 4.0 or later, you can cluster Edge nodes for high availability.

-
+
I have devices that use proprietary protocols. Can Edge connect to them?
-

Yes. Edge natively supports MQTT, CoAP, HTTP, SNMP, and LwM2M. For other protocols, use:

+

Yes. Edge natively supports MQTT, CoAP, HTTP, SNMP, and LwM2M. For other protocols, use:

  • The ThingsBoard IoT Gateway to bridge legacy devices. Gateway supports Modbus, BACnet, OPC-UA, and more, and is available at no extra cost.
    • {% if docsPrefix == "pe/edge/" %} @@ -149,7 +207,7 @@ function switchEdgeFaqTab(tabId) {
-
+
Can I customize and modify the Edge {{edgeName}}?
{% if docsPrefix == "pe/edge/" %} @@ -159,6 +217,9 @@ function switchEdgeFaqTab(tabId) { {% endif %}
+
+
Load more FAQ
+
@@ -236,10 +297,10 @@ function switchEdgeFaqTab(tabId) { {% if docsPrefix == "pe/edge/" %}

Edge {{edgeName}} includes all Community Edition features plus:

{% else %} @@ -274,7 +335,7 @@ function switchEdgeFaqTab(tabId) {
Does Edge {{edgeName}} support UI customization options, such as white-labeling or custom menu?
-

White-labeling and custom menu configuration are Professional Edition features that provide UI customization without code changes.

+

White-labeling and custom menu configuration are Professional Edition features that provide UI customization without code changes.

{{edgeName}} is open-source, allowing developers to customize the interface by modifying the source code.

@@ -287,20 +348,10 @@ function switchEdgeFaqTab(tabId) {
-
Can I integrate third-party systems with ThingsBoard Edge?
+
Can I integrate devices that are connected via third-party systems such as LoRAWAN?
-

Yes, Edge {{edgeName}} supports integration through:

- {% if docsPrefix == "pe/edge/" %} -
    -
  • REST APIs: For request/response interactions.
    • -
  • Platform Integrations: For built-in connectors to OPC-UA servers, and other platforms.
    • -
- {% else %} -
    -
  • REST APIs: For request/response interactions.
    • -
-

For built-in platform connectors (OPC-UA, CoAP etc.), see Professional Edition Integrations.

- {% endif %} +

Not out-of-the-box. To connect with third-party platforms like LoRaWAN networks, you would need to develop custom integration code.

+

Professional Edition provides ready-to-use Platform Integrations for LoRaWAN networks (ChirpStack, TTN, Loriot), OPC-UA servers, and 30+ other platforms. See Edge Integrations documentation for more details.

@@ -311,48 +362,51 @@ function switchEdgeFaqTab(tabId) {

Refer to Edge Cluster Setup documentation for more details.

-
-
What databases and message queue implementations does ThingsBoard Edge support?
+
+
What databases and uplink message storages does ThingsBoard Edge support?

Edge {{edgeName}} supports pure SQL and a hybrid SQL + NoSQL (for telemetry storage) approaches, which are:

  • PostgreSQL: Default, suitable for most deployments.
  • PostgreSQL + Cassandra: Hybrid approach for high-volume telemetry - 1M+ devices or >5,000 msg/sec.
-

Edge also supports different message queue implementations:

+

Edge also supports different uplink message storages:

  • PostgreSQL: Built-in default, suitable for PoC and testing environments - not for production or any sort of cluster deployments.
  • Kafka: Recommended for production deployments.
-
+
Can I automate device management and telemetry processing?

Yes. you can. The Rule Engine allows you to automate device workflows, data processing, and alerts based on incoming telemetry.

For example, you can automatically provision devices, transform data, trigger actions based on thresholds, or forward telemetry to external systems.

-
+
Can I run rule chains on Edge?

Yes. Edge runs rule chains locally for real-time processing. Starting with version 4.0, you can create and edit rule chains directly on Edge. In earlier versions, rule chains are configured as templates on the Server and pushed to Edge.

See Edge Rule Chain Templates for more information.

-
+
Does Edge {{edgeName}} support OTA (Over-the-Air) firmware updates?

Yes. You can manage firmware versions, schedule updates, and track deployment status across your devices. See OTA updates documentation for setup instructions.

-
+
Is there a mobile app for ThingsBoard Edge {{edgeName}}?

No, there is no dedicated mobile app for ThingsBoard Edge.

However, you can access and manage Edge instance through a web browser on any device, including mobile devices. Typically, instance is hosted on port 8080.

+
+
Load more FAQ
+
@@ -361,7 +415,7 @@ function switchEdgeFaqTab(tabId) {

Partially. Edge version X.Y.Z works with:

  • Server version X.Y.Z (same version)
    • -
  • Server versions X.Y+1 and X.Y+2 (up to two minor versions ahead)
    • +
  • Server versions X.Y+1 and X.Y+2 (up to two minor versions ahead))

Edge does not work with older Server versions.

Example: Edge 3.8.0 works with Server 3.8.0, 3.8.1, and 3.9.0 — but not with Server 3.7.x or earlier. If your Edge is newer than your Server, upgrade the Server first.

@@ -413,14 +467,14 @@ function switchEdgeFaqTab(tabId) { {% endif %}
-
+
Where does ThingsBoard Edge store time-series data?

By default, Edge stores time-series data in PostgreSQL, which handles both device metadata and telemetry efficiently for typical deployments.

For high-volume scenarios (1M+ devices or >5,000 msg/sec), you can configure a hybrid setup where time-series data is stored in Cassandra while PostgreSQL handles device metadata and attributes.

-
+
Do I need to use a software development kit (SDK)?

No, many IoT devices are not designed to embed third-party SDKs.

@@ -428,6 +482,9 @@ function switchEdgeFaqTab(tabId) { Some useful references include MQTT client-side libraries list and C-implementation for CoAP.

+
+
Load more FAQ
+
diff --git a/_includes/docs/faq.md b/_includes/docs/faq.md index 780cec0fc5..32ee3c5c8a 100644 --- a/_includes/docs/faq.md +++ b/_includes/docs/faq.md @@ -1,150 +1,622 @@ -* TOC -{:toc} - - -{% if docsPrefix contains 'pe/' or docsPrefix contains 'paas/' %} -## What is ThingsBoard Professional Edition? -{% else %} -## What is ThingsBoard Community Edition? -{% endif %} - -ThingsBoard is a comprehensive open-source IoT platform designed for device connectivity, data collection, processing, visualization, and remote device management. It supports IoT protocols like MQTT, CoAP, HTTP, LWM2M and provides a flexible, scalable foundation for building both prototype and production-level IoT solutions. - -The platform is available in two main editions: Community Edition (CE) and Professional Edition (PE).
- -{% if docsPrefix contains 'pe/' or docsPrefix contains 'paas/' %} -The **Professional Edition** is the enterprise-grade version tailored for commercial IoT deployments. It includes all the features of the Community Edition and adds advanced capabilities that help accelerate time-to-market, enhance security, improve scalability, and deliver a polished, production-ready solution. This edition is designed for businesses that require high performance, operational reliability, and premium features.
-{% else %} -The **Community Edition** is a free, open-source version. It is a powerful and scalable multi-tenant solution, ideal for teams looking to experiment, test hypotheses, build proof-of-concepts, or launch MVPs without upfront costs. It offers the flexibility and agility needed in development.
-{% endif %} - -If this is your first experience with the platform we recommend to review [what-is-thingsboard](/docs/{{docsPrefix}}getting-started-guides/what-is-thingsboard/) -and [getting started guide](/docs/{{docsPrefix}}getting-started-guides/helloworld/). -You can find more information on the dedicated page. - -## How do I get started? - -{% if docsPrefix contains 'paas/' %} -We recommend to follow the [getting started guide](/docs/{{docsPrefix}}getting-started-guides/helloworld/). -{% else %} -We recommend to [install](/docs/user-guide/install/{{docsPrefix}}installation-options/) ThingsBoard locally on your laptop or PC using Docker -and follow the [getting started guide](/docs/{{docsPrefix}}getting-started-guides/helloworld/). -{% endif %} - -## What can I do with ThingsBoard? - -ThingsBoard provides out-of-the-box IoT solution that will enable server-side infrastructure for your IoT applications. -You can find more information by browsing [guides](/docs/{{docsPrefix}}user-guide/) and [device library](/docs/{{docsPrefix}}/devices-library/). - -{% unless docsPrefix contains 'paas/' %} -## Where can I host ThingsBoard? - -You can host ThingsBoard in the cloud, on-premises or locally on your laptop, PC or even Raspberry Pi. We recommend to get started with Docker installation - - - [Linux & Mac OS](/docs/user-guide/install/{{docsPrefix}}docker/) - - [Windows](/docs/user-guide/install/{{docsPrefix}}docker-windows/) - -You can also take a look at [cluster setup](/docs/user-guide/install/{{docsPrefix}}cluster-setup/) guide. -{% endunless %} - -## How to connect my device? - -ThingsBoard provides -[MQTT](/docs/{{docsPrefix}}reference/mqtt-api), -[CoAP](/docs/{{docsPrefix}}reference/coap-api), -[HTTP](/docs/{{docsPrefix}}reference/http-api), and. -[LwM2M](/docs/{{docsPrefix}}reference/lwm2m-api) protocols support. -**Existing** devices may be connected to the platform using **[ThingsBoard Gateway](/docs/iot-gateway/what-is-iot-gateway/)**. -You can find more information on the [connectivity](/docs/{{docsPrefix}}reference/protocols/) page. - -## Do I need to use an SDK? - -No, many IoT devices can't afford to embed third-party SDK. ThingsBoard provides quite simple API over common IoT protocols. You can choose any client-side library you like or use your own. -Some useful references: - - - [MQTT client-side libraries list](https://github.com/mqtt/mqtt.github.io/wiki/libraries) - - [C-implementation for CoAP](https://libcoap.net/) - -## What about security? - -You can use MQTT (over SSL) or HTTPS protocols for transport encryption. - -Each device has unique access token credentials that is used to setup connection. Credentials type is pluggable, so X.509 certificates support is coming soon. - -## How much devices can ThingsBoard support? - -ThingsBoard platform is horizontally scalable. Each server node in the cluster is unique. -Scalability is achieved using [consistent-hashing](https://en.wikipedia.org/wiki/Consistent_hashing) load balancing algorithm between the cluster nodes. -Actual performance depends on usage scenario of connected devices. -{% unless docsPrefix contains 'paas/' %} -For example, small commodity hardware cluster can support [several millions](/docs/{{docsPrefix}}reference/iot-platform-deployment-scenarios/#1-million-smart-meters-tco) of devices connected over MQTT. -{% endunless %} - -## Where does ThingsBoard store data? - -The data is stored in [Cassandra](https://cassandra.apache.org/) database. Cassandra suites well for storage and querying of time-series data and provides high availability and fault-tolerance. - -## What license type does ThingsBoard use? - -ThingsBoard is licensed under [Apache 2.0 License](https://en.wikipedia.org/wiki/Apache_License#Version_2.0). -It is free for both personal and commercial usage and you can deploy it anywhere. - -## How can I check which version of ThingsBoard I’m currently using? - -{% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" %} -ThingsBoard Cloud is a fully managed platform that is regularly updated to the latest version by the ThingsBoard team, so you don't need to worry about maintenance or upgrades. -{% elsif page.docsPrefix == "pe/" or docsPrefix == "pe/" %} -There are several ways to check the platform version in ThingsBoard Professional Edition. -The easiest way is to log in as SysAdmin. On the home page, you will find a widget in the bottom-left corner of the screen displaying the current platform version and indicating whether an upgrade is available. - -Alternatively, if you don’t have access to the SysAdmin account, open [White-Labeling](/docs/{{docsPrefix}}user-guide/white-labeling/) tab from the side menu. -Enable the **Show platform name and version** option to see the current version of the platform. -{% else %} -There are several ways to check the platform version in ThingsBoard Community Edition. -The easiest way is to log in as SysAdmin. On the home page, you will find a widget in the bottom-left corner of the screen showing the current platform version and whether an upgrade is available. -{% endif %} - - -## Can I replace the default ThingsBoard logo in the menu? - -{% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" %} -In the ThingsBoard Cloud, all branding can be configured directly from the user interface using the built-in [White-Labeling](/docs/{{docsPrefix}}user-guide/white-labeling/#customize-thingsboard-web-interface) module. -Here’s what you can do in just a few clicks: -- Replace the ThingsBoard logo and favicon with your own corporate visuals -- Customize login and system pages to greet users with your brand from the start -- Adjust color schemes and styles (primary, accent colors, logo size, CSS tweaks) to match your identity -- Preview changes live before applying them -- Configure custom domain: map your own domain name (e.g., portal.company.com) so users access the platform via your branded URL - -And it doesn’t stop at the logo. With ThingsBoard Cloud you can: -- Set up custom [email templates](/docs/{{docsPrefix}}user-guide/mail-templates/), so all platform notifications reflect your brand -- Add [custom translations](/docs/{{docsPrefix}}user-guide/custom-translation/), ensuring the platform “speaks” your users’ language -- Create [custom menus](/docs/{{docsPrefix}}user-guide/custom-menu/), adapting navigation to your business workflows - -This gives you a fully branded platform: your users see your logo, your colors, your emails, and even your tailored menus. -{% elsif page.docsPrefix == "pe/" or docsPrefix == "pe/" %} -In the Professional Edition, all branding can be configured directly from the user interface using the built-in [White-Labeling](/docs/{{docsPrefix}}user-guide/white-labeling/#customize-thingsboard-web-interface) module. -Here’s what you can do in just a few clicks: -- Replace the ThingsBoard logo and favicon with your own corporate visuals -- Customize login and system pages to greet users with your brand from the start -- Adjust color schemes and styles (primary, accent colors, logo size, CSS tweaks) to match your identity -- Preview changes live before applying them -- Configure custom domains: map your own domain name (e.g., portal.company.com) so users access the platform via your branded URL - -And it doesn’t stop at the logo. With PE you can: -- Set up custom [email templates](/docs/{{docsPrefix}}user-guide/mail-templates/), so all platform notifications reflect your brand -- Add [custom translations](/docs/{{docsPrefix}}user-guide/custom-translation/), ensuring the platform “speaks” your users’ language -- Create [custom menus](/docs/{{docsPrefix}}user-guide/custom-menu/), adapting navigation to your business workflows - -This gives you a fully branded platform: your users see your logo, your colors, your emails, and even your tailored menus. -{% else %} -The Community Edition does not include a built-in white-labeling feature. However, it is technically possible to replace the default ThingsBoard logo by modifying the source code and rebuilding the platform. This requires development expertise and familiarity with ThingsBoard’s codebase. Please note that such changes will need to be reapplied after each upgrade of the platform. - -If you need a more streamlined and configurable option, we recommend considering the Professional Edition. With Professional Edition, you can effortlessly upload your own logo and favicon, customize login and system pages, adjust colors and branding palettes, and even tailor [email templates](/docs/pe/user-guide/mail-templates/), [translations](/docs/pe/user-guide/custom-translation/), and [custom menus](/docs/pe/user-guide/custom-menu/) - all directly from the user interface, without touching the code. This empowers your organization to deliver a fully branded, professional-grade experience to your customers and tenants in just a few clicks. - -More details: [PE White-Labeling Guide](/docs/pe/user-guide/white-labeling/#customize-thingsboard-web-interface). -{% endif %} - -## How to get support? - -You can use troubleshooting instructions and community resources or [contact us](/docs/contact-us) and learn more about [services](/services/) we provide. + + + + +

Open Source IoT Platform

+ +
+
+
+
General
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +
ThingsBoard Add-ons
+
Private Cloud
+ {% endif %} +
AI Capabilities
+
Deployments & Limits
+
Security & Compliance
+
Support & Assistance
+
+
+
+
+
What is ThingsBoard?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

ThingsBoard Professional Edition (PE) is an advanced IoT platform designed for production-grade deployments, offering enterprise features, white-labeling, advanced security, and official support. It is ideal for businesses looking to deploy scalable, reliable IoT solutions with professional backing.

+

ThingsBoard is an IoT platform for data collection, processing, visualization, and device management. It provides out-of-the-box components and APIs to significantly accelerate development and lower costs while maintaining control of your solution and data.

+

See What is ThingsBoard? to learn more about the platform's architecture and capabilities, or jump to our Getting Started Guide to begin building your first IoT project.

+ {% else %} +

ThingsBoard Community Edition (CE) is the free and open-source IoT platform for collecting, storing, analyzing, and visualizing data from IoT devices. It is designed for developers and businesses who want full control over their IoT infrastructure without licensing fees.

+

ThingsBoard is an open-source IoT platform for data collection, processing, visualization, and device management. It provides out-of-the-box components and APIs to significantly accelerate development and lower costs while maintaining control of your solution and data.

+

See What is ThingsBoard? to learn more about the platform's architecture and capabilities, or jump to our Getting Started Guide to begin building your first IoT project.

+ {% endif %} +
+
+
+
Is ThingsBoard free?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

No, Professional Edition requires a paid subscription.

+ {% else %} +

Yes, it is completely free, with no licensing fees or hidden costs.

+ {% endif %} +
+
+
+
What's the difference between Community Edition and Professional Edition?
+
+

Community Edition is free and open-source, suitable for development, testing, and production use without licensing costs. It includes essential features for IoT device management, data collection, visualization, and rule processing.

+

Professional Edition includes all features from CE and offers advanced features such as white-labeling, role-based access control (RBAC), platform integrations, solution templates, scheduler, and enterprise support.

+

See the PE product page for detailed feature comparison table.

+
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +
+
Can I use Community Edition for commercial projects?
+
+

Yes. CE is licensed under Apache 2.0, allowing commercial use without restrictions. You can build, sell, and deploy commercial products on CE.

+
+
+ {% endif %} +
+
How do I get started with ThingsBoard?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Start with ThingsBoard Cloud for immediate access, or follow our installation guide to deploy PE on your infrastructure.

+

To connect your first device and build dashboards, explore the Getting Started Guide.

+ {% else %} +

Start with Live Demo for immediate access, or install ThingsBoard CE locally by following installation guide.

+

To connect your first device and build dashboards, explore the Getting Started Guide.

+ {% endif %} +
+
+
+
Can I migrate from CE to PE?
+
+

Yes, you can migrate from ThingsBoard Community Edition to Professional Edition without losing telemetry data and/or configurations. The upgrade process preserves your existing setup, ensuring a seamless transition.

+

However, please note that any custom modifications made directly to the source code of the Community Edition will be removed during the upgrade process.

+

See the ThingsBoard instructions for upgrading from Community Edition. Back up your data before starting.

+
+
+
+
What protocols does ThingsBoard support?
+
+

ThingsBoard supports MQTT, CoAP, HTTP, LwM2M, and SNMP.

+

For legacy devices, use ThingsBoard IoT Gateway which supports Modbus, BACnet, OPC-UA, and more.

+
+
+
+
Are there device limits?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Limits vary by subscription plan. Cloud plans range from 30 devices (Maker) to unlimited (Enterprise). Self-managed subscriptions range from 10 devices (Maker) to unlimited (Enterprise).

+ {% else %} +

No, there are no programmatic limits, but performance depends on your server(s) capacity.

+ {% endif %} +
+
+
+
Are there API rate limits?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Yes, each Cloud plan has specific API and rate limits. Self-managed plans have no programmatic API limits but depend on infrastructure capacity.

+ {% else %} +

No built-in API rate limits in the software itself, but performance depends on infrastructure.

+ {% endif %} +
+
+
+
Can I integrate with third-party systems?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Yes, through REST APIs, Rule Engine, and Platform Integrations (PE-only feature with 30+ built-in connectors for OPC-UA, LoRaWAN networks, cloud platforms, etc.).

+ {% else %} +

Yes, you can integrate ThingsBoard Community Edition with third-party systems through REST APIs or Rule Engine.

+ {% endif %} +
+
+
+
Does ThingsBoard support white-labeling?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Yes, white-labeling is available starting from the Prototype plan and above.

+ {% else %} +

No, white-labeling is available only in the Professional Edition.

+ {% endif %} +
+
+
+
Can I try Professional Edition before purchasing?
+
+

Yes, start a 30 days free trial with Maker plan or request a demo. The trial includes access to all PE features for evaluation.

+
+
+
+
Where can I find the source code?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Professional Edition is proprietary software. Source code is not publicly available.

+ {% else %} +

The source code is available on GitHub. You can fork, modify, and contribute to the project under the Apache 2.0 license.

+ {% endif %} +
+
+
+
Can I contribute to ThingsBoard?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Professional Edition is closed-source and does not accept external contributions.

+ {% else %} +

Yes! Pull requests and contributions are welcome on GitHub. Check the contribution guidelines before submitting.

+ {% endif %} +
+
+
+
Load more FAQ
+
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +
+
+
What is a ThingsBoard Add-on?
+
+

Add-ons are complementary products that extend ThingsBoard Professional Edition capabilities. They integrate seamlessly with your ThingsBoard instance and require a PE subscription to use. Add-ons include ThingsBoard Edge PE (edge computing), and Trendz Analytics (advanced analytics/AI).

+
+
+
+
What add-ons are available for ThingsBoard?
+
+

ThingsBoard Edge PE and Trendz Analytics.

+
+
+
+
What is ThingsBoard Edge?
+
+

ThingsBoard Edge is an edge computing solution that runs locally at remote sites, processing data with reduced latency while maintaining sync with your central ThingsBoard server. It operates offline and automatically syncs when connectivity returns.

+

Edge Professional Edition, included as an add-on to ThingsBoard PE subscriptions, adds enterprise features such as white-labeling, solution templates, platform integrations, scheduler, and customer hierarchy management to edge computing core capabilities.

+

See Edge documentation for setup and configuration details.

+
+
+
+
How many Edge instances are included with PE?
+
+

The number of included Edge instances depends on your subscription plan. Additional instances can be purchased separately. Check your plan details or contact us for specifics.

+
+
+
+
What is Trendz Analytics?
+
+

Trendz Analytics is an advanced analytics and reporting tool for ThingsBoard. It provides predictive analytics, automated reporting, and data visualization beyond ThingsBoard's built-in capabilities. Trendz requires a separate subscription and integrates with both CE and PE.

+

See Trendz documentation for more information.

+
+
+
+
Can I use Edge and/or Trendz with ThingsBoard Community Edition?
+
+
    +
  • Edge CE: Yes, you can use Edge Community Edition with ThingsBoard CE Server. It's free and open-source as well as ThingsBoard CE.
    • +
  • Trendz Analytics: No, Trendz requires ThingsBoard Professional Edition.
    • +
+

Note: Edge CE only connects to ThingsBoard CE Server, not PE Server.

+
+
+
+
Can I use Edge and/or Trendz without ThingsBoard?
+
+

No, they are both designed to complement the capabilities of ThingsBoard, not to function as standalone solutions. Neither can operate independently:

+
    +
  • Edge PE: Requires connection to sync with ThingsBoard PE Server (Cloud, Private Cloud, or self-managed).
    • +
  • Trendz Analytics: Requires ThingsBoard PE as its data source.
    • +
+
+
+
+
Can I try add-ons before purchasing?
+
+

Yes,you can start a 30-day trial of the Maker plan with Edge Computing and Trendz add-ons enabled. You'll have full access to add-ons features.

+
+
+
+
Load more FAQ
+
+
+
+
+
What is ThingsBoard Private Cloud?
+
+

ThingsBoard Private Cloud is a fully managed, isolated ThingsBoard Professional Edition instance hosted in a dedicated environment. It provides enterprise security, compliance, and performance while eliminating infrastructure management overhead.

+
+
+
+
How is Private Cloud different from ThingsBoard Cloud?
+
+

Private Cloud provides a dedicated, isolated environment for your organization, whereas ThingsBoard Cloud is a shared multi-tenant SaaS platform. Private Cloud offers enhanced security, custom SLAs, and infrastructure isolation for compliance-sensitive industries.

+
+
+
+
Can I choose where Private Cloud is hosted?
+
+

Yes, Private Cloud can be deployed in your preferred AWS, Azure, or GCP region to meet data residency and latency requirements.

+
+
+
+
Who manages Private Cloud infrastructure?
+
+

ThingsBoard team manages all infrastructure, updates, monitoring, and maintenance. You focus on your IoT application while we handle platform operations.

+
+
+
+
What support is included with Private Cloud?
+
+

Private Cloud includes priority support, dedicated success management, and custom SLA options. Support levels are defined in your service agreement.

+
+
+
+
Can I customize Private Cloud configuration?
+
+

Yes, Private Cloud supports custom configurations including white-labeling, custom domains, and infrastructure scaling to match your requirements.

+
+
+
+
Is Private Cloud compliant with security standards?
+
+

Private Cloud is designed to support compliance requirements including GDPR, HIPAA, and ISO 27001. Specific compliance certifications depend on your deployment configuration and service agreement.

+
+
+
+
How do I get started with Private Cloud?
+
+

Contact sales to discuss your requirements. We'll help you design the right Private Cloud configuration for your use case.

+
+
+
+
Load more FAQ
+
+
+ {% endif %} +
+
+
Does ThingsBoard support AI integration?
+
+

Yes, Professional Edition includes an AI Request node in the Rule Engine that allows integration with AI services like OpenAI, Azure OpenAI, and custom AI endpoints.

+
+
+
+
Can I use AI for predictive maintenance?
+
+

Yes, CE/PE includes built-in AI integration capabilities. You can use the AI Request node to send telemetry data to machine learning models for predictive analytics, anomaly detection, and maintenance scheduling.

+

See predictive maintenance example for implementation details.

+
+
+
+
Which AI providers are supported?
+
+

ThingsBoard supports OpenAI, Azure OpenAI, and custom API endpoints. You can integrate any AI service that provides a REST API.

+
+
+
+
Can I train custom ML models with ThingsBoard data?
+
+

Yes, export historical telemetry via REST API or data export features to train models externally. Deploy trained models as API endpoints and integrate them using the AI Request node.

+
+
+
+
Does AI functionality work offline with ThingsBoard Edge?
+
+

Yes, if you deploy AI models locally at edge locations. Edge can call local AI endpoints without cloud connectivity. Configure the AI Request node to use local API endpoints.

+
+
+
+
Are there examples of AI use cases?
+
+

Yes, see documentation for examples including anomaly detection, predictive maintenance, and natural language processing.

+
+
+
+
Do I need a separate AI subscription?
+
+

ThingsBoard integration is included, but you need subscriptions to external AI services (OpenAI, Azure, etc.) if using those providers. Custom AI endpoints are entirely under your control.

+
+
+
+
Can I process AI requests in batches?
+
+

Yes, the Rule Engine allows batch processing. Aggregate telemetry data and send batched requests to AI endpoints to optimize costs and performance.

+
+
+
+
Load more FAQ
+
+
+
+
+
Where can I install ThingsBoard?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Professional Edition can be deployed as: ThingsBoard Cloud (fully managed SaaS), Private Cloud (dedicated managed environment), or self-hosted on your infrastructure (on-premises or cloud VM).

+ {% else %} +

You can install the Community Edition on your virtual machine, local servers, or deploy it on cloud platforms like AWS, Azure, or GCP. Installation guides support Docker, Kubernetes, and manual installations.

+ {% endif %} +
+
+
+
Does ThingsBoard support clustering?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Yes, clustering is supported in all deployment options.

+ {% else %} +

Yes, clustering is fully supported in the Community Edition.

+ {% endif %} +

See cluster setup guide for configuration details.

+
+
+
+
What are the hardware requirements?
+
+

Minimum: 2 CPU cores, 4GB RAM for testing. Recommended for production: 8+ CPU cores, 16GB+ RAM. Requirements scale with device count and message volume. See hardware sizing guide for detailed recommendations.

+
+
+
+
How many devices can ThingsBoard handle?
+
+

ThingsBoard scales horizontally via clustering. Single-node deployments handle thousands of devices. Clustered deployments can manage millions of devices with appropriate hardware and configuration.

+
+
+
+
What databases does ThingsBoard support?
+
+

ThingsBoard supports PostgreSQL (default), Cassandra (for high-volume time-series data), or TimescaleDB (PostgreSQL extension for time-series). Hybrid configurations (PostgreSQL + Cassandra) are recommended for large-scale deployments.

+
+
+
+
Can I deploy ThingsBoard in a Docker container?
+
+

Yes, official Docker images are available on Docker Hub. Docker Compose files simplify deployment with all dependencies included.

+
+
+
+
Is Kubernetes supported?
+
+

Yes, Kubernetes deployment is fully supported with Helm charts available. See Kubernetes installation guide for details.

+
+
+
+
Load more FAQ
+
+
+
+
+
Is ThingsBoard secure?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Security depends on deployment type. Cloud/Private Cloud deployments are hosted on secure infrastructure with encryption, monitoring, and regular security updates. Self-hosted deployments require you to manage infrastructure security, network configuration, and SSL/TLS setup.

+ {% else %} +

Yes, but security depends on your deployment setup and infrastructure.

+ {% endif %} +

ThingsBoard provides device authentication, encrypted communication (SSL/TLS), role-based access control, and audit logging. Follow security best practices for secure deployments.

+
+
+
+
Does ThingsBoard support encryption?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Yes, transport encryption (TLS/SSL) is supported. Additional encryption features may depend on your subscription plan and deployment type.

+ {% else %} +

Yes, the Community Edition includes transport encryption (TLS/SSL).

+ {% endif %} +

For data-at-rest encryption, configure database-level encryption. See security documentation for setup instructions.

+
+
+
+
How are devices authenticated?
+
+

ThingsBoard supports multiple authentication methods: access tokens, X.509 certificates, and username/password. Each device receives unique credentials. See device authentication guide for configuration.

+
+
+
+
Does ThingsBoard support role-based access control (RBAC)?
+
+

Yes, both editions support RBAC. Professional Edition includes advanced RBAC with custom roles, hierarchical permissions, and group-based access control.

+
+
+
+
Can I integrate with external authentication providers?
+
+

Yes, ThingsBoard supports OAuth2, LDAP, and SAML integration. Professional Edition includes additional SSO options. See authentication configuration for setup.

+
+
+
+
Are there audit logs?
+
+

Yes, ThingsBoard logs user actions, API calls, and system events. Professional Edition provides enhanced audit logging with detailed tracking and export capabilities.

+
+
+
+
+
+
What support is available for CE?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Support varies by plan: Cloud Maker/Prototype (community support), Startup+ (email support with SLA), Growth+ (priority support), Enterprise (dedicated support team).

+ {% else %} +

The ThingsBoard team does not provide dedicated support for Community Edition users. Support is community-driven through GitHub, Stack Overflow, and community forums.

+ {% endif %} +
+
+
+
Where can I get help?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Professional Edition users with Startup+ plans have access to ThingsBoard Support Team via email. Enterprise plans include dedicated support channels and faster response times.

+ {% else %} +

GitHub (report issues, contribute), Stack Overflow (developer questions), Documentation (guides and tutorials), Community forum (discussions and advice).

+ {% endif %} +
+
+
+
Do you offer professional services?
+
+

Yes, ThingsBoard offers consulting, custom development, training, and deployment assistance. Contact sales to discuss your requirements.

+
+
+
+
How do I report a bug?
+
+ {% if page.docsPrefix contains "paas/" or docsPrefix contains "paas/" or page.docsPrefix == "pe/" or docsPrefix == "pe/" %} +

Professional Edition users should contact support through their designated channel. Include detailed reproduction steps, logs, and system information.

+ {% else %} +

Report bugs on GitHub Issues. Include detailed reproduction steps, logs, and system information. Community members and maintainers will investigate.

+ {% endif %} +
+
+
+
Are there training resources?
+
+

Yes, comprehensive documentation, video tutorials, and sample projects are available. Professional services include custom training programs. See learning resources for more.

+
+
+
+
Can I get help with deployment?
+
+

Yes, professional services include deployment assistance, architecture review, and production setup. Contact us to discuss your deployment needs.

+
+
+
+
+
+
\ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md index bde3a98763..b14937c9ce 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,6 +1,6 @@ --- layout: docwithnav -title: FAQ +title: Frequently Asked Questions description: ThingsBoard FAQ --- diff --git a/docs/paas/eu/faq.md b/docs/paas/eu/faq.md index 264ea3840d..5599f395fa 100644 --- a/docs/paas/eu/faq.md +++ b/docs/paas/eu/faq.md @@ -1,6 +1,6 @@ --- layout: docwithnav-paas-eu -title: FAQ +title: Frequently Asked Questions description: ThingsBoard FAQ --- diff --git a/docs/paas/faq.md b/docs/paas/faq.md index d321780ef9..d10711a929 100644 --- a/docs/paas/faq.md +++ b/docs/paas/faq.md @@ -1,6 +1,6 @@ --- layout: docwithnav-paas -title: FAQ +title: Frequently Asked Questions description: ThingsBoard FAQ --- diff --git a/docs/pe/faq.md b/docs/pe/faq.md index 37255abcfd..2234718a8b 100644 --- a/docs/pe/faq.md +++ b/docs/pe/faq.md @@ -1,6 +1,6 @@ --- layout: docwithnav-pe -title: FAQ +title: Frequently Asked Questions description: ThingsBoard FAQ --- From 0567bc44fce365a683e26f3dbc25ca5fe0026447 Mon Sep 17 00:00:00 2001 From: Yevheniia Mala Date: Mon, 15 Dec 2025 18:30:41 +0200 Subject: [PATCH 7/9] TB Edge docs --- _includes/docs/edge/faq.md | 2 +- _includes/docs/edge/index.md | 370 +++++++++++++++++++++++++++++++---- _includes/docs/faq.md | 264 ++++++++++++++++++------- docs/edge/index.md | 3 +- docs/pe/edge/index.md | 6 +- 5 files changed, 528 insertions(+), 117 deletions(-) diff --git a/_includes/docs/edge/faq.md b/_includes/docs/edge/faq.md index eb3ce8c40c..0ccb2e13c1 100644 --- a/_includes/docs/edge/faq.md +++ b/_includes/docs/edge/faq.md @@ -423,7 +423,7 @@ function resetEdgeLoadMore(categoryId) {
-
How much hardware do I need to run Edge?
+
What hardware do I need to run Edge?

Less than you might think. Edge runs on: