Skip to content
This repository was archived by the owner on May 22, 2026. It is now read-only.

Commit 8a856e7

Browse files
dmytro-landiakdeaflynxShvaykaD
authored
TBMQ Release 2.2.0 (#2258)
* tbmq integrations structure * TBMQ product page release 2.1.0 init. * tbmq config page updated, added ie config page * TBMQ product page updated images, news, features. * tbmq IE overview documentation - added structure - wip * tbmq IE diagrams * tbmq IE overview doc updates, still wip * tbmq IE overview doc refactored the initial part * tbmq IE overview doc improvement, downlink topics description * tbmq IE overview doc minor changes * tbmq ie overview pre-final adjustments * tbmq ie overview more text adjustments * tbmq IE overview doc roadmap section and more improvements * tbmq roadmap and release notes * TBMQ docs add integrations http, mqtt, kafka init text. * TBMQ docs improvement of the integration guides (use WebSocket Client). * TBMQ docs remove NEW label from old docs. * tbmq integrations overview refactoring * TBMQ docs: improved MQTT, Kafka. * tbmq updated broker config page * tbmq supported features updated * TBMQ docs: HTTP integration added screenshots. * TBMQ docs: MQTT integration added screenshots. * TBMQ docs: Kafka integration added screenshots. * TBMQ docs: integrations added Events screenshots. * TBMQ docs: added Need Help page. * tbmq minor text improvements to http, mqtt and kafka integrations * tbmq msg description for integrations * tbmq warn banner for mqtt integration * tbmq config page fix netty leak detector * TBMQ product page: updated 2.1 release news. * tbmq integrations check connection button explained * tbmq config page changed doc font * tbmq shared subs doc improvements * tbmq backpressure doc not finished * tbmq ie pages changed doc font * tbmq backpressure doc improvements * TBMQ docs: In Monitoring page added Resource usage. * tbmq backpressure doc minor additional note for persistent device client * tbmq resource usage block in monitoring doc corrected * tbmq resource usage png * docs home structure improvements for tbmq * tbmq backpressure doc added recommendations section * tbmq client type doc clarity and explanation improvements * tbmq added structure for new doc - msg delivery strategies * tbmq msg delivery strategies doc, config docs updated * tbmq health endpoint doc * tbmq docker compose use 80 port * tbmq config pages update * tbmq health doc improvements * tbmq health doc minor text polishing * tbmq blocked clients doc init * tbmq blocked client feature completion * tbmq minor changes in blocked clients doc * tbmq added image to blocked client doc * tbmq minor improvements for pricing * tbmq added new Kafka topics description * TBMQ Security update docs init implementation. * Update TBMQ Security docs. * jwt auth init commit * Update TBMQ Security docs. * Added basic JWT signature verifier description * Revert changes to _config.yml * Update TBMQ Security docs: remove SECURITY_MQTT_BASIC_ENABLED, SECURITY_MQTT_SSL_ENABLED. * Added JWT provider configuration sections * Added more configuration examples * Update TBMQ authentication related docs, screenshots (2.2.0). * TBMQ update Security docs. * minor updates to JWT docs * Security overview page + administration UI setting improvements * Basic authentication docs improvements + additional links in overview * minor improvements to x509 and basic authentication pages * added security warn about downgrade-attacks in auth execution order * TBMQ 2.2 update screenshots, docs. * tbmq minor text improvements * tbmq text corrections for security auth guides * TBMQ 2.2 update jwt screenshot. * tbmq updated x509 overview screenshot * tbmq mqtt and http over ssl docs * tbmq docker compose guide with mqtts * tbmq docker installations mqtts config * tbmq docker cluster doc improvements for mqtts - one-way and two-way * minot text improvement for tbmq docker cluster guide * tbmq basic authentication examples * tbmq jwt authentication examples * tbmq x509 authentication examples * tbmq mqtts description fix typos * tbmq config pages update * tbmq upgrade instructions * tbmq release notes * TBMQ product page SEO optimization. * TBMQ product, try it now pages SEO optimization. * TBMQ try it now, docs pages - add links to product page. * Updated helm upgrading section * TBMQ product page SEO optimization. * tbmq release notes - deprecation of env vars info * tbmq landing page improvements * TBMQ product page SEO optimization. * TBMQ product page minor text update. * tbmq upgrade to 2.2.0 sections * tbmq set v2.2.0 --------- Co-authored-by: deaflynx <artemio.babak@gmail.com> Co-authored-by: ShvaykaD <dshvaika@thingsboard.io> Co-authored-by: Artem Babak <ababak@thingsboard.io>
1 parent 0b445fb commit 8a856e7

145 files changed

Lines changed: 3324 additions & 556 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,6 @@ release:
100100
pe_flutter_app_ver: 1.6.0
101101
ce_dart_client_ver: 4.0.0
102102
pe_dart_client_ver: 4.0.0
103-
broker_full_ver: 2.1.0
104-
broker_branch: release-2.1.0
103+
broker_full_ver: 2.2.0
104+
broker_branch: release-2.2.0
105105
trendz_ver: 1.13.2

_data/mqtt-broker/docs-home.yml

Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,42 @@ toc:
66
- title: What is TBMQ?
77
path: /docs/mqtt-broker/getting-started-guides/what-is-thingsboard-mqtt-broker/
88
- title: Configuration
9-
new: true
109
section:
1110
- title: TBMQ
1211
path: /docs/mqtt-broker/install/config/
1312
- title: TBMQ Integration Executor
1413
path: /docs/mqtt-broker/install/ie-config/
15-
new: true
1614
- title: Security
17-
path: /docs/mqtt-broker/security/
15+
section:
16+
- title: Overview
17+
path: /docs/mqtt-broker/security/overview/
18+
- title: MQTT over SSL
19+
path: /docs/mqtt-broker/security/mqtts/
20+
- title: MQTT Listeners
21+
path: /docs/mqtt-broker/security/listeners/
22+
- title: Authentication
23+
section:
24+
- title: Basic
25+
path: /docs/mqtt-broker/security/authentication/basic/
26+
- title: X.509 Certificate Chain
27+
path: /docs/mqtt-broker/security/authentication/x509/
28+
- title: JWT
29+
new: true
30+
path: /docs/mqtt-broker/security/authentication/jwt/
31+
- title: SCRAM
32+
path: /docs/mqtt-broker/security/authentication/scram/
33+
- title: Enable HTTPS
34+
path: /docs/mqtt-broker/security/https/
1835
- title: Integration with ThingsBoard
1936
path: /docs/mqtt-broker/user-guide/integrations/how-to-connect-thingsboard-to-tbmq/
20-
- title: Features
37+
- title: MQTT Features
2138
section:
2239
- title: MQTT protocol
2340
path: /docs/mqtt-broker/user-guide/mqtt-protocol/
2441
- title: Topics & Wildcards
2542
path: /docs/mqtt-broker/user-guide/topics/
2643
- title: Quality of Service (QoS)
2744
path: /docs/mqtt-broker/user-guide/qos/
28-
- title: TBMQ client type
29-
path: /docs/mqtt-broker/user-guide/mqtt-client-type/
3045
- title: MQTT over WebSocket
3146
path: /docs/mqtt-broker/user-guide/mqtt-over-ws/
3247
- title: Shared Subscriptions
@@ -37,6 +52,21 @@ toc:
3752
path: /docs/mqtt-broker/user-guide/last-will/
3853
- title: Keep Alive
3954
path: /docs/mqtt-broker/user-guide/keep-alive/
55+
- title: Other Features
56+
new: true
57+
section:
58+
- title: TBMQ Client Type
59+
path: /docs/mqtt-broker/user-guide/mqtt-client-type/
60+
- title: Blocked Clients
61+
path: /docs/mqtt-broker/other/blocked-client/
62+
- title: Backpressure
63+
path: /docs/mqtt-broker/user-guide/backpressure/
64+
- title: Msg Delivery Strategies
65+
path: /docs/mqtt-broker/other/msg-delivery-strategy/
66+
- title: PROXY Protocol
67+
path: /docs/mqtt-broker/other/proxy-protocol/
68+
- title: Health API
69+
path: /docs/mqtt-broker/other/health/
4070
- title: Integrations
4171
new: true
4272
section:
@@ -68,11 +98,6 @@ toc:
6898
path: /docs/mqtt-broker/user-guide/ui/users/
6999
- title: Settings
70100
path: /docs/mqtt-broker/user-guide/ui/settings/
71-
- title: Other Features
72-
new: true
73-
section:
74-
- title: PROXY Protocol
75-
path: /docs/mqtt-broker/other/proxy-protocol/
76101
- title: Subscriptions
77102
path: /docs/mqtt-broker/subscription/
78103
- title: Need Help?

_data/mqtt-broker/reference.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ toc:
1313
section:
1414
- title: "Point-to-point: 1M Msg/sec Throughput"
1515
path: /docs/mqtt-broker/reference/1m-throughput-p2p-performance-test/
16-
new: true
1716
- title: "Fan-out: 3M Msg/sec Throughput"
1817
path: /docs/mqtt-broker/reference/3m-throughput-single-node-performance-test/
1918
- title: "Fan-in: 100M MQTT Connections"

_data/pages_info.yml

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -844,6 +844,15 @@
844844
"/docs/mqtt-broker/mqtt-client-credentials-management/":
845845
url: "/docs/mqtt-broker/mqtt-client-credentials-management/"
846846
redirect_from: []
847+
"/docs/mqtt-broker/other/blocked-client/":
848+
url: "/docs/mqtt-broker/other/blocked-client/"
849+
redirect_from: []
850+
"/docs/mqtt-broker/other/health/":
851+
url: "/docs/mqtt-broker/other/health/"
852+
redirect_from: []
853+
"/docs/mqtt-broker/other/msg-delivery-strategy/":
854+
url: "/docs/mqtt-broker/other/msg-delivery-strategy/"
855+
redirect_from: []
847856
"/docs/mqtt-broker/other/proxy-protocol/":
848857
url: "/docs/mqtt-broker/other/proxy-protocol/"
849858
redirect_from: []
@@ -868,15 +877,39 @@
868877
"/docs/mqtt-broker/search/":
869878
url: "/docs/mqtt-broker/search/"
870879
redirect_from: []
871-
"/docs/mqtt-broker/security/":
872-
url: "/docs/mqtt-broker/security/"
880+
"/docs/mqtt-broker/security/authentication/basic/":
881+
url: "/docs/mqtt-broker/security/authentication/basic/"
882+
redirect_from: []
883+
"/docs/mqtt-broker/security/authentication/jwt/":
884+
url: "/docs/mqtt-broker/security/authentication/jwt/"
885+
redirect_from: []
886+
"/docs/mqtt-broker/security/authentication/scram/":
887+
url: "/docs/mqtt-broker/security/authentication/scram/"
888+
redirect_from: []
889+
"/docs/mqtt-broker/security/authentication/x509/":
890+
url: "/docs/mqtt-broker/security/authentication/x509/"
891+
redirect_from: []
892+
"/docs/mqtt-broker/security/https/":
893+
url: "/docs/mqtt-broker/security/https/"
894+
redirect_from: []
895+
"/docs/mqtt-broker/security/listeners/":
896+
url: "/docs/mqtt-broker/security/listeners/"
897+
redirect_from: []
898+
"/docs/mqtt-broker/security/mqtts/":
899+
url: "/docs/mqtt-broker/security/mqtts/"
900+
redirect_from: []
901+
"/docs/mqtt-broker/security/overview/":
902+
url: "/docs/mqtt-broker/security/overview/"
873903
redirect_from: []
874904
"/docs/mqtt-broker/subscription/":
875905
url: "/docs/mqtt-broker/subscription/"
876906
redirect_from: []
877907
"/docs/mqtt-broker/troubleshooting/":
878908
url: "/docs/mqtt-broker/troubleshooting/"
879909
redirect_from: []
910+
"/docs/mqtt-broker/user-guide/backpressure/":
911+
url: "/docs/mqtt-broker/user-guide/backpressure/"
912+
redirect_from: []
880913
"/docs/mqtt-broker/user-guide/integrations/how-to-connect-thingsboard-to-tbmq/":
881914
url: "/docs/mqtt-broker/user-guide/integrations/how-to-connect-thingsboard-to-tbmq/"
882915
redirect_from: []

_includes/docs/mqtt-broker/getting-started-guides/what-is-thingsboard-mqtt-broker.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
**TBMQ** represents an open-source MQTT message broker. It has the capacity to handle more than **4M** concurrent client connections,
2+
**TBMQ** represents an open-source <a target="_blank" href="/products/mqtt-broker/">MQTT message broker</a>. It has the capacity to handle more than **4M** concurrent client connections,
33
supporting a minimum of [3M messages per second throughput](/docs/mqtt-broker/reference/3m-throughput-single-node-performance-test/) per single-node deployment
44
with low latency delivery.
55
In the cluster mode, its capabilities are further enhanced,
@@ -45,6 +45,7 @@ Our implementation ensures reliable performance and compatibility across diverse
4545
* All MQTT v5.0 features
4646
* Multi-node cluster support
4747
* X.509 certificate chain authentication support
48+
* JWT authentication
4849
* Access control (ACL) based on client ID, username, or X.509 certificate chain
4950
* REST query support for clients’ sessions and subscriptions
5051
* Rate limits of message processing
@@ -54,6 +55,8 @@ Our implementation ensures reliable performance and compatibility across diverse
5455
* Integrations with external systems (HTTP, MQTT, Kafka)
5556
* Kafka topics and consumer groups monitoring
5657
* Proxy protocol
58+
* Blocked clients
59+
* MQTT channel backpressure support
5760

5861
## Architecture
5962

_includes/docs/mqtt-broker/getting-started.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Introduction
66

7-
The goal of this tutorial is to showcase the fundamental usage of [TBMQ](/docs/mqtt-broker/getting-started-guides/what-is-thingsboard-mqtt-broker/).
7+
The goal of this tutorial is to showcase the fundamental usage of <a target="_blank" href="/products/mqtt-broker/">TBMQ</a>.
88
Through this tutorial, you will gain knowledge and proficiency in the following areas:
99

1010
* Establishing connections between MQTT clients and the broker.
@@ -47,21 +47,19 @@ sysadmin
4747

4848
## Configure client authentication & authorization
4949

50-
In order to secure the connection to the broker we should enable Basic or TLS authentication.
51-
In this tutorial, we will focus on the [Basic](/docs/mqtt-broker/security/#basic-authentication) authentication type.
52-
For this, we have set `SECURITY_MQTT_BASIC_ENABLED` environment variable to `true` in the `docker-compose.yml` downloaded in the previous step.
50+
In order to secure the connection to the broker, we should [enable Basic authentication](/docs/mqtt-broker/security/authentication/basic/).
5351

5452
Once Basic authentication is enabled, it is necessary to create MQTT Client Credentials of type `Basic` to authenticate and validate the connecting client.
5553

56-
* Navigate to "Credentials" tab, click "+" in the top right corner of the table.
54+
* Navigate to _Authentication_ - _Credentials_ tab, click "+" in the top right corner of the table.
5755
* Input credentials name. For example, "Getting Started Credentials".
5856
* Input "username" and "password" with chosen values. For example, use `username` and `password` values respectively.
5957
* Authorization rules are set to allow publishing/subscribing to any topic by default.
6058
* Click "Add" to save credentials.
6159

6260
{% include images-gallery.html imageCollection="broker-mqtt-creds-creation" %}
6361

64-
A wider range of authentication methods can be found within the [security guide](/docs/mqtt-broker/security/), offering enhanced options for ensuring secure access.
62+
A wider range of authentication methods can be found within the [security guide](/docs/mqtt-broker/security/overview/), offering enhanced options for ensuring secure access.
6563

6664
## Publishing and Subscribing to Topics
6765

@@ -116,7 +114,7 @@ This tool uses your host, port, and client credentials data to construct `mosqui
116114

117115
Please follow these steps to generate commands for "Getting Started Credentials":
118116

119-
1. Open the 'Client Credentials' page from the left-hand menu.
117+
1. Open the _Authentication_ - _Credentials_ page from the left-hand menu.
120118
2. Click on row with client credentials "Getting Started Credentials" to open the details.
121119
3. Click on the "Check connectivity" button.
122120
4. In the opened window, select your operating system and install the necessary client tools.

_includes/docs/mqtt-broker/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**TBMQ** is a highly scalable and fault-tolerant MQTT broker designed for efficient message routing between connected devices using the MQTT protocol.
1+
**TBMQ** is a highly scalable and fault-tolerant <a target="_blank" href="/products/mqtt-broker/">MQTT broker</a> designed for efficient message routing between connected devices using the MQTT protocol.
22

33
With the ability to manage over **4M** concurrent client connections, TBMQ delivers a minimum [throughput of 3M messages per second](/docs/mqtt-broker/reference/3m-throughput-single-node-performance-test/)
44
in single-node deployment with low latency.

0 commit comments

Comments
 (0)