diff --git a/en_US/access-control/authn/assets/authn-MongoDB_ee.png b/en_US/access-control/authn/assets/authn-MongoDB_ee.png new file mode 100644 index 000000000..6e523aa45 Binary files /dev/null and b/en_US/access-control/authn/assets/authn-MongoDB_ee.png differ diff --git a/en_US/access-control/authn/assets/authn-mongodb-1.png b/en_US/access-control/authn/assets/authn-mongodb-1.png deleted file mode 100644 index 28fe874a9..000000000 Binary files a/en_US/access-control/authn/assets/authn-mongodb-1.png and /dev/null differ diff --git a/en_US/access-control/authn/mongodb.md b/en_US/access-control/authn/mongodb.md index f9dbdcb29..e77b19ff9 100644 --- a/en_US/access-control/authn/mongodb.md +++ b/en_US/access-control/authn/mongodb.md @@ -55,7 +55,7 @@ You can use EMQX Dashboard to configure how to use MongoDB for password authenti In the EMQX Dashboard, click **Access Control** -> **Authentication** from the left navigation menu. On the **Authentication** page, click **Create** at the top right corner. Click to select **Password-Based** as **Mechanism**, and **MongoDB** as **Backend** to go to the **Configuration** tab, as shown below. -Authenticate with MondoDB +![authn-MongoDB_ee](./assets/authn-MongoDB_ee.png) Follow the instructions below on how to configure the authentication: diff --git a/en_US/access-control/authz/assets/authz-MongoDB_ee.png b/en_US/access-control/authz/assets/authz-MongoDB_ee.png index 6e523aa45..5b8fa2fb5 100644 Binary files a/en_US/access-control/authz/assets/authz-MongoDB_ee.png and b/en_US/access-control/authz/assets/authz-MongoDB_ee.png differ diff --git a/en_US/access-control/authz/mongodb.md b/en_US/access-control/authz/mongodb.md index c27fcb47c..f8d488758 100644 --- a/en_US/access-control/authz/mongodb.md +++ b/en_US/access-control/authz/mongodb.md @@ -60,11 +60,11 @@ You can use EMQX Dashboard to configure how to use MongoDB for user authorizatio authz-MongoDB_ee -3. Follow the instructions below to do the configuration. +3. Follow the instructions below to configure the settings. **Connect**: Fill in the information needed to connect MongDB. - - **MongoDB Mode**: Select how MongoDB is deployed, including **Single**, **Replica Set,** and **Sharding**. + - **MongoDB Mode**: Select how MongoDB is deployed, including `Single`, `Replica Set`, and `Sharding`. - **Server**: Specify the server address that EMQX is to connect (`host:port`). - **Database**: MongoDB database name. - **Collection**: Name of MongoDB collection where authorization rules are stored; Data type: strings. @@ -73,15 +73,18 @@ You can use EMQX Dashboard to configure how to use MongoDB for user authorizatio **TLS Configuration**: Turn on the toggle switch if you want to enable TLS. - **Connection Configuration**: Set the concurrent connections and waiting time before a connection is timed out. + **Filter**: A map interpreted as MongoDB selector for credential lookup. [Placeholders](./authz.md#authorization-placeholders) are supported. - - **Pool size** (optional): Input an integer value to define the number of concurrent connections from an EMQX node to MongoDB. Default: **8**. + **Advanced Settings**: + + - **Auth Source**: Specify the authentication source to use when connecting to MongoDB. This could be a specific database or a MongoDB authentication database that manages user credentials. + - **Use Legacy Protocol**: Select whether to use MongoDB's legacy protocol for communicating with the database. Options are `auto`, `true`, and `false`. The default is `auto`, which will attempt to automatically determine if the newer protocol is supported. + - **Record Limit**: Limit the number of authorization records to fetch from MongoDB. + - **Skip**: Set the number of authorization records to skip when retrieving the list of records. + + - **Pool size** (optional): Input an integer value to define the number of concurrent connections from an EMQX node to MongoDB. Default: `8`. - **Connect Timeout** (optional): Specify the waiting period before EMQX assumes the connection is timed out. Units supported include milliseconds, second, minute, and hour. - - **Authorization configuration**: Fill in the authorization-related settings: - - - A map interpreted as MongoDB selector for credential lookup. [Placeholders](./authz.md#authorization-placeholders) are supported. - + 4. Click **Create** to finish the settings. ## Configure with Configuration Items diff --git a/en_US/dashboard/assets/connections_subscriptions.png b/en_US/dashboard/assets/connections_subscriptions.png index d0e6869a5..885b3fce0 100644 Binary files a/en_US/dashboard/assets/connections_subscriptions.png and b/en_US/dashboard/assets/connections_subscriptions.png differ diff --git a/en_US/dashboard/assets/dashboard_preview.png b/en_US/dashboard/assets/dashboard_preview.png index dde18a994..219c89632 100644 Binary files a/en_US/dashboard/assets/dashboard_preview.png and b/en_US/dashboard/assets/dashboard_preview.png differ diff --git a/en_US/dashboard/assets/message_rate.png b/en_US/dashboard/assets/message_rate.png index e1b8dc618..de57e776c 100644 Binary files a/en_US/dashboard/assets/message_rate.png and b/en_US/dashboard/assets/message_rate.png differ diff --git a/en_US/dashboard/assets/mqtt-settings-retainer.png b/en_US/dashboard/assets/mqtt-settings-retainer.png index ca0f88088..6bb07861c 100644 Binary files a/en_US/dashboard/assets/mqtt-settings-retainer.png and b/en_US/dashboard/assets/mqtt-settings-retainer.png differ diff --git a/en_US/dashboard/dashboard.md b/en_US/dashboard/dashboard.md index b0a03ce86..f1c1cb1f8 100644 --- a/en_US/dashboard/dashboard.md +++ b/en_US/dashboard/dashboard.md @@ -16,7 +16,7 @@ In EMQX, messages represent the key data transmitted by all connected MQTT clien The card in the upper left corner of this overview page provides a clearer and easier way to monitor the rate changes in the current volume of messages incoming and outgoing in the system (message rate is measured in how many messages per second) by visualizing the rate spectrum with real-time rate values. -![message_rate](./assets/message_rate.png) +message_rate ### Connections and Subscriptions diff --git a/en_US/dashboard/retained.md b/en_US/dashboard/retained.md index 37ab29cd2..24d6f2efa 100644 --- a/en_US/dashboard/retained.md +++ b/en_US/dashboard/retained.md @@ -46,4 +46,5 @@ Below are detailed descriptions of each field. | Max Payload Size | Bytesize | | 1MB | Retain the maximum payload value of the message. If the payload value exceeds the maximum value, the EMQX will treat the retained reserved message as a normal message. | | Message Expire Interval | Duration | | Never Expire | The expiration time of the retained message, and 0 means never expire. If the message expiration interval is set in the PUBLISH packet, the message expiration interval in the PUBLISH packet shall prevail. | | Message Clear Interval | Duration | | Disabled | Interval to clean up expired messages. | -| Deliver Rate | Integer | ≥ 0 | 1000 | The maximum rate of delivering retain messages. | +| Max Publish Rate | Integer | ≥ 0 | 2000 | The maximum rate of publishing retained messages. Messages published over the limit are delivered but not stored as retained. | +| Deliver Rate | Integer | ≥ 0 | 1000 | The maximum rate of delivering retained messages. | diff --git a/en_US/data-integration/assets/action_statistics.png b/en_US/data-integration/assets/action_statistics.png index 07f03fb2e..fd898e226 100644 Binary files a/en_US/data-integration/assets/action_statistics.png and b/en_US/data-integration/assets/action_statistics.png differ diff --git a/en_US/data-integration/assets/choose-connector-type.png b/en_US/data-integration/assets/choose-connector-type.png index 1062aa9f1..fe781b59d 100644 Binary files a/en_US/data-integration/assets/choose-connector-type.png and b/en_US/data-integration/assets/choose-connector-type.png differ diff --git a/en_US/data-integration/assets/config-connector.png b/en_US/data-integration/assets/config-connector.png index eefb19ed0..0733b8ea1 100644 Binary files a/en_US/data-integration/assets/config-connector.png and b/en_US/data-integration/assets/config-connector.png differ diff --git a/en_US/data-integration/assets/rule-test-result.png b/en_US/data-integration/assets/rule-test-result.png index cdda2f35f..35509e7ce 100644 Binary files a/en_US/data-integration/assets/rule-test-result.png and b/en_US/data-integration/assets/rule-test-result.png differ diff --git a/en_US/data-integration/assets/rule_statistics.png b/en_US/data-integration/assets/rule_statistics.png index 2067cbd45..79267431e 100644 Binary files a/en_US/data-integration/assets/rule_statistics.png and b/en_US/data-integration/assets/rule_statistics.png differ diff --git a/en_US/data-integration/assets/rules/create-rules.png b/en_US/data-integration/assets/rules/create-rules.png index 57f9f3a8a..fc6ab8323 100644 Binary files a/en_US/data-integration/assets/rules/create-rules.png and b/en_US/data-integration/assets/rules/create-rules.png differ diff --git a/en_US/data-integration/assets/search_rules.png b/en_US/data-integration/assets/search_rules.png index fc1329b88..c86e9a95d 100644 Binary files a/en_US/data-integration/assets/search_rules.png and b/en_US/data-integration/assets/search_rules.png differ diff --git a/en_US/data-integration/assets/test-sql.png b/en_US/data-integration/assets/test-sql.png index 9e9af2325..a25ca63f2 100644 Binary files a/en_US/data-integration/assets/test-sql.png and b/en_US/data-integration/assets/test-sql.png differ diff --git a/en_US/data-integration/assets/view_connector.png b/en_US/data-integration/assets/view_connector.png index aaa1d5969..c24f7a6e4 100644 Binary files a/en_US/data-integration/assets/view_connector.png and b/en_US/data-integration/assets/view_connector.png differ diff --git a/en_US/data-integration/assets/view_rules.png b/en_US/data-integration/assets/view_rules.png index 8623b3d53..742fdbf7e 100644 Binary files a/en_US/data-integration/assets/view_rules.png and b/en_US/data-integration/assets/view_rules.png differ diff --git a/en_US/data-integration/assets/webhook.png b/en_US/data-integration/assets/webhook.png index 802134acc..d6a0a861e 100644 Binary files a/en_US/data-integration/assets/webhook.png and b/en_US/data-integration/assets/webhook.png differ diff --git a/en_US/data-integration/connector.md b/en_US/data-integration/connector.md index 34058ea2f..d2ac64e70 100644 --- a/en_US/data-integration/connector.md +++ b/en_US/data-integration/connector.md @@ -48,7 +48,7 @@ You can also create a connector during the process of creating a Sink/Source, wh ## View and Manage Connectors -After a connector is created, you can view its basic information on the Connector page. You can also enable or disable it, and manage it, such as editing the settings, creating rules, duplicating the connector, or deleting it through the **Actions** column of the connector list. +After a connector is created, you can view its basic information on the Connectors page. You can also enable or disable it, and manage it, such as editing the settings, creating rules, duplicating the connector, or deleting it through the **Actions** column of the connector list. view_connector diff --git a/en_US/data-integration/rule-get-started.md b/en_US/data-integration/rule-get-started.md index c8dbf0ab3..0f47ef1ec 100644 --- a/en_US/data-integration/rule-get-started.md +++ b/en_US/data-integration/rule-get-started.md @@ -7,7 +7,7 @@ The demonstration on this page takes the republish action as an example, describ ## Define a Data Source Log in to the EMQX Dashboard and click **Integration** -> **Rules** in the left navigation menu. -Click the **Create** button on the **Rule** page and you will be directed to the **Create Rule** page. Here, you can define the data source for your rule and determine the subsequent actions for the filtered messages. +Click the **Create** button on the **Rules** page and you will be directed to the **Create Rule** page. Here, you can define the data source for your rule and determine the subsequent actions for the filtered messages. Enter a name for your rule and add a note to facilitate future management. In the **SQL Editor**, you can customize the statements to add a data source that suits your business needs. For this tutorial, keep the default setting, which selects and returns all messages under topics that follow the `"t/#"` pattern (e.g., `t/a`, `t/a/b`, `t/a/b/c`, etc.). @@ -27,12 +27,12 @@ You can use simulated data to execute SQL statements. Before adding actions and Follow the instructions below to test the SQL statement: -1. Turn on the **Try It Out** toggle switch to enable the SQL statement testing. +1. Turn on the **Try It Out** toggle switch on the **Create Rule** page to enable the SQL statement testing. 2. Select the **Data Source** that matches the SQL and ensure it is consistent with the specified source in the rule (FROM clause). 3. Enter test data. Once you select the data source, EMQX provides default values for all simulated data fields, such as **Client ID**, **Username**, **Topic**, **QoS**, **Payload**, etc. Modify them to appropriate values as needed. 4. Click the **Run Test** button to submit the test. If everything is normal, a **Test Passed** prompt will be displayed. -test-sql +![test-sql](./assets/test-sql.png) The processing result of SQL will be presented in the **Output Result** section in JSON format. All the fields in SQL processing results can be referenced in the form of `${key}` by the subsequent actions (built-in actions or Sink). For a detailed explanation of the fields, see [SQL Data Sources and Fields](./rule-sql-events-and-fields.md). @@ -145,7 +145,7 @@ For more usage guides on testing rules, you can refer to the blog [Enhancing Dat ## View Rules -The **Rule** page provides a comprehensive list of all the rules you have created. +The **Rules** page provides a comprehensive list of all the rules you have created. Each entry in the list displays basic information, including the rule ID, associated source, enable status, and the number of actions. Hovering over the source reveals the corresponding SQL statement details. To modify a rule's configuration, click **Settings** in the **Actions** column. You can also use the **More** button to duplicate or delete a rule. @@ -153,7 +153,7 @@ Each entry in the list displays basic information, including the rule ID, associ You can also view rules in the [Flow Designer](../flow-designer/introduction.md) by navigating to **Integration** -> **Flow Designer**. Rules created on the **Rules** page and those created through the Flow Designer are fully interoperable. -To view the rule statistics and action execution information for a rule, click the rule ID on **Rule** page or the rule name on the **Flows** page. +To view the rule statistics and action execution information for a rule, click the rule ID on **Rules** page or the rule name on the **Flows** page. ![view_rules_flows](./assets/view_rules_flows.png) diff --git a/en_US/data-integration/schema-registry.md b/en_US/data-integration/schema-registry.md index 5cd7d84e6..1d8b5fc81 100644 --- a/en_US/data-integration/schema-registry.md +++ b/en_US/data-integration/schema-registry.md @@ -114,7 +114,7 @@ Starting with version 5.8.1, EMQX supports configuring an external Confluent Sch You can configure an external schema registry directly through the EMQX Dashboard, making it easy to manage your schema integration. -Go to **Integration** -> **Schema** on EMQX Dashboard. Select the **External** tab on the Schema page. +Go to **Integration** -> **Schema Registry** on EMQX Dashboard. Select the **External** tab on the Schema page. Click the **Create** button at the upper right corner. Configure the following fields: diff --git a/en_US/data-integration/webhook.md b/en_US/data-integration/webhook.md index 41673174c..c83e7985b 100644 --- a/en_US/data-integration/webhook.md +++ b/en_US/data-integration/webhook.md @@ -83,7 +83,7 @@ python3 http_server.py ### Create Webhook -1. Click **Integration** -> **Webhook** from the Dashboard left menu. +1. Click **Integration** -> **Webhooks** from the Dashboard left menu. 2. Click the **Create** button on the page. 3. Enter Webhook name and notes, which should be a combination of uppercase and lowercase English letters and numbers. Here you can enter `my_webhook`. 4. Select the trigger according to your needs, in this case, select **All messages and events**. For other options, refer to [How it Works](#how-it-works). diff --git a/zh_CN/dashboard/assets/message_rate.png b/zh_CN/dashboard/assets/message_rate.png index 170fe7081..cca110ba4 100644 Binary files a/zh_CN/dashboard/assets/message_rate.png and b/zh_CN/dashboard/assets/message_rate.png differ diff --git a/zh_CN/dashboard/assets/mqtt-setting-retainer.png b/zh_CN/dashboard/assets/mqtt-setting-retainer.png index de14dd0b2..319333058 100644 Binary files a/zh_CN/dashboard/assets/mqtt-setting-retainer.png and b/zh_CN/dashboard/assets/mqtt-setting-retainer.png differ diff --git a/zh_CN/dashboard/retained.md b/zh_CN/dashboard/retained.md index 16db8accf..e6040caaf 100644 --- a/zh_CN/dashboard/retained.md +++ b/zh_CN/dashboard/retained.md @@ -44,4 +44,5 @@ EMQX 默认将保存 3 类系统主题的保留消息，如果是集群环境， | 最大负载大小 | 字节大小 | | 1MB | 保留消息的最大负载大小。如果负载大小超过最大值，EMQX 将把保留的保留消息视为普通消息。 | | 消息过期间隔 | 时长 | | 永不过期 | 保留消息的过期时间，0 表示永不过期。如果在 PUBLISH 数据包中设置了消息过期时间间隔，则以 PUBLISH 数据包中的消息过期时间间隔为准。 | | 消息清理间隔 | 时长 | | 禁用 | 清理过期消息的间隔。 | +| 最大发布速率 | 整数 | ≥ 0 | 2000 | 发布保留消息的最大速率。超过限制发布的消息会被投递，但不会存储为保留消息。 | | 派发速率 | 整数 | ≥ 0 | 1000 | 派发保留消息的最大速率。 |