Line 1: |
Line 1: |
| {{Template: Networking_rutxxx_manual_fw_disclosure | | {{Template: Networking_rutxxx_manual_fw_disclosure |
| | fw_version = {{#switch: {{{series}}} | | | fw_version = {{#switch: {{{series}}} |
− | | RUT2XX = {{{series}}}_R_00.01.12 | + | | RUT2XX = {{{series}}}_R_00.01.14.3 |
− | | RUT9XX = {{{series}}}_R_00.06.07}} | + | | RUT9XX = {{{series}}}_R_00.06.08.2}} |
| | series = {{{series}}} | | | series = {{{series}}} |
| }} | | }} |
Line 29: |
Line 29: |
| <table class="nd-mantable"> | | <table class="nd-mantable"> |
| <tr> | | <tr> |
− | <th>field name</th> | + | <th>Field name</th> |
− | <th>value</th> | + | <th>Value</th> |
− | <th>description</th> | + | <th>Description</th> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>Enable</td> | | <td>Enable</td> |
| <td>yes | no; default: '''no'''</td> | | <td>yes | no; default: '''no'''</td> |
− | <td>Toggles MQTT Broker ON or OFF</td> | + | <td>Toggles MQTT Broker ON or OFF.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>Local Port</td> | | <td>Local Port</td> |
| <td>integer [0..65535]; default: <b>1883</b></td> | | <td>integer [0..65535]; default: <b>1883</b></td> |
− | <td>Specifies the local port that the MQTT broker will listen to</td> | + | <td>Specifies the local port that the MQTT broker will listen to.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>Enable Remote Access</td> | | <td>Enable Remote Access</td> |
| <td>yes | no; default: '''no'''</td> | | <td>yes | no; default: '''no'''</td> |
− | <td>If enabled, MQTT Broker will be reachable by remote user (from WAN)</td> | + | <td>If enabled, MQTT Broker will be reachable by remote user (from WAN).</td> |
| </tr> | | </tr> |
| </table> | | </table> |
Line 58: |
Line 58: |
| <table class="nd-mantable"> | | <table class="nd-mantable"> |
| <tr> | | <tr> |
− | <th>field name</th> | + | <th>Field name</th> |
− | <th>value</th> | + | <th>Value</th> |
− | <th>description</th> | + | <th>Description</th> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>Use TLS/SSL</td> | | <td>Use TLS/SSL</td> |
| <td>yes | no; default: '''no'''</td> | | <td>yes | no; default: '''no'''</td> |
− | <td>Toggles the use of TLS/SSL certificates ON or OFF</td> | + | <td>Toggles the use of TLS/SSL certificates ON or OFF.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>CA File</td> | | <td>CA File</td> |
| <td>.ca file; default: '''none'''</td> | | <td>.ca file; default: '''none'''</td> |
− | <td>'''Certificate authority''' is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate</td> | + | <td>'''Certificate authority''' is an entity that issues digital certificates. A digital certificate certifies the ownership of a public key by the named subject of the certificate.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>CERT File</td> | | <td>CERT File</td> |
| <td>.crt file; default: '''none'''</td> | | <td>.crt file; default: '''none'''</td> |
− | <td>Certificate file is a type of digital certificate that is used by client systems to make authenticated requests to a remote server. Client certificates play a key role in many mutual authentication designs, providing strong assurances of a requester's identity</td> | + | <td>Certificate file is a type of digital certificate that is used by client systems to make authenticated requests to a remote server. Client certificates play a key role in many mutual authentication designs, providing strong assurances of a requester's identity.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>Key File</td> | | <td>Key File</td> |
| <td>.key file; default: '''none'''</td> | | <td>.key file; default: '''none'''</td> |
− | <td>Private key for client to establish connection</td> | + | <td>Private key for client to establish connection.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>TLS version</td> | | <td>TLS version</td> |
| <td>tlsv1.1 | tlsv1.2 | Support all; default: '''Support all'''</td> | | <td>tlsv1.1 | tlsv1.2 | Support all; default: '''Support all'''</td> |
− | <td>Authenticates a client to a server and establishes precisely who they are</td> | + | <td>Authenticates a client to a server and establishes precisely who they are.</td> |
| </tr> | | </tr> |
| </table> | | </table> |
Line 97: |
Line 97: |
| <table class="nd-mantable"> | | <table class="nd-mantable"> |
| <tr> | | <tr> |
− | <th>field name</th> | + | <th>Field name</th> |
− | <th>value</th> | + | <th>Value</th> |
− | <th>description</th> | + | <th>Description</th> |
| </tr> | | </tr> |
| <tr> | | <tr> |
Line 148: |
Line 148: |
| </table> | | </table> |
| | | |
− | ===Micellaneous=== | + | ====Topics==== |
| + | ---- |
| + | The <b>Topic</b> section is used to add and configure topics for MQTT communication. |
| + | |
| + | [[File:Networking_rut_manual_mqtt_broker_settings_bridge_topics.png|border|class=tlt-border]] |
| + | |
| + | <table class="nd-mantable"> |
| + | <tr> |
| + | <th>Field</th> |
| + | <th>Value</th> |
| + | <th>Description</th> |
| + | </tr> |
| + | <tr> |
| + | <td>Topic</td> |
| + | <td>string; default: <b>none</b></td> |
| + | <td>The name of this topic.</td> |
| + | </tr> |
| + | <tr> |
| + | <td>Direction</td> |
| + | <td>OUT | IN | BOTH; default: <b>OUT</b></td> |
| + | <td>Specifies the direction in which messages for this topic can be shared in.</td> |
| + | </tr> |
| + | <tr> |
| + | <td>QoS level</td> |
| + | <td>integer; default: <b>0</b></td> |
| + | <td>The publish/subscribe QoS level for this topic..</td> |
| + | </tr> |
| + | <tr> |
| + | <td>Delete</td> |
| + | <td>- (interactive button)</td> |
| + | <td>Deletes the topic next to it.</td> |
| + | </tr> |
| + | </table> |
| + | |
| + | ===Miscellaneous=== |
| ---- | | ---- |
| The last section of MQTT Broker parameters is called '''Miscellaneous'''. It contains parameters that are related to neither Security nor Bridge. | | The last section of MQTT Broker parameters is called '''Miscellaneous'''. It contains parameters that are related to neither Security nor Bridge. |
Line 163: |
Line 197: |
| <td>ACL File</td> | | <td>ACL File</td> |
| <td>.ACL file; default: '''none'''</td> | | <td>.ACL file; default: '''none'''</td> |
− | <td>The contents of this file are used to control client access to topics of the broker</td> | + | <td>The contents of this file are used to control client access to topics of the broker.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>Password File</td> | | <td>Password File</td> |
| <td>password file; default: '''none'''</td> | | <td>password file; default: '''none'''</td> |
− | <td>The Password file stores user names and corresponding passwords, used for authentication. The file can be produced by mosquitto_passwd on the ssh command line, see https://mosquitto.org/man/mosquitto_passwd-1.html</td> | + | <td>The Password file stores user names and corresponding passwords, used for authentication. The file can be produced by mosquitto_passwd on the ssh command line, see https://mosquitto.org/man/mosquitto_passwd-1.html </td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>Persistence</td> | | <td>Persistence</td> |
| <td>yes | no; default: '''no'''</td> | | <td>yes | no; default: '''no'''</td> |
− | <td>If enabled, connection, subscription and message data will be written to the disk. Otherwise, the data is stored in the router’s memory only</td> | + | <td>If enabled, connection, subscription and message data will be written to the disk. Otherwise, the data is stored in the router’s memory only.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>Allow Anonymous</td> | | <td>Allow Anonymous</td> |
| <td>yes | no; default: '''yes'''</td> | | <td>yes | no; default: '''yes'''</td> |
− | <td>If enabled, the Broker allows anonymous access</td> | + | <td>If enabled, the Broker allows anonymous access.</td> |
| </tr> | | </tr> |
| </table> | | </table> |
Line 197: |
Line 231: |
| <td>Enable</td> | | <td>Enable</td> |
| <td>yes | no; default: '''no'''</td> | | <td>yes | no; default: '''no'''</td> |
− | <td>Toggles the MQTT Publisher ON or OFF</td> | + | <td>Toggles the MQTT Publisher ON or OFF.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>Hostname</td> | | <td>Hostname</td> |
| <td>host | ip; default: '''none'''</td> | | <td>host | ip; default: '''none'''</td> |
− | <td>Broker’s IP address or hostname</td> | + | <td>Broker’s IP address or hostname.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>Port</td> | | <td>Port</td> |
| <td>integer [0..65535]; default: '''1883'''</td> | | <td>integer [0..65535]; default: '''1883'''</td> |
− | <td>Specifies the port used for connecting to the Broker</td> | + | <td>Specifies the port used for connecting to the Broker.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>Username</td> | | <td>Username</td> |
| <td>string; default: '''none'''</td> | | <td>string; default: '''none'''</td> |
− | <td>User name used for authentication when connecting to the Broker</td> | + | <td>User name used for authentication when connecting to the Broker.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |
| <td>Password</td> | | <td>Password</td> |
| <td>string; default: '''none'''</td> | | <td>string; default: '''none'''</td> |
− | <td>Password used for authentication when connecting to the Broker</td> | + | <td>Password used for authentication when connecting to the Broker.</td> |
| </tr> | | </tr> |
| <tr> | | <tr> |