Skip to content

Commit c270252

Browse files
atomic fix - further attempt at making the docs style match existing content
1 parent 9e680a9 commit c270252

2 files changed

Lines changed: 12 additions & 11 deletions

File tree

docs/source/userguide/commands.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,16 +194,17 @@ More info on the general OVMS MQTT topic scheme can be found
194194
TLS client certificate commands
195195
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
196196

197-
For MQTT brokers requiring client certificate authentication (mTLS), use::
197+
If the broker needs a client certificate (mTLS)::
198198

199199
OVMS# server v3 tlsclient import <cert_path> <key_path>
200200
OVMS# server v3 tlsclient status
201+
OVMS# server v3 tlsclient info
201202
OVMS# server v3 tlsclient check
202203
OVMS# server v3 tlsclient reload
203204
OVMS# server v3 tlsclient clear
204205

205-
Certificate and key files are stored under ``/store/tls/``. Use ``import`` to load PEM files,
206-
``check`` to validate the pair, and ``reload`` to apply changes to the active connection.
206+
Files are stored under ``/store/tls/``. Use ``check`` to validate the cert/key pair,
207+
``reload`` to reconnect and apply changes.
207208

208209

209210
------------------

docs/source/userguide/components.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -123,13 +123,13 @@ Send all ``v.b`` metrics except ``v.b.soc``::
123123
OVMS# config set server.v3 metrics.include v.b.*
124124
OVMS# config set server.v3 metrics.exclude v.b.soc
125125

126-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
126+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
127127
Broker compatibility options
128-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
128+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
129129

130-
Some MQTT brokers impose limits that require additional configuration:
130+
Some brokers have additional requirements:
131131

132-
- ``retain.depth.limit`` (default: ``no``) — omits the RETAIN flag on topics deeper than 8 path segments. Required for AWS IoT Core.
132+
- ``retain.depth.limit`` (default: ``no``) — omits the RETAIN flag on topics deeper than 8 path segments. Needed for AWS IoT Core, which silently drops retained publishes on topics deeper than 8 levels.
133133

134134
Example::
135135

@@ -142,12 +142,12 @@ Example::
142142

143143
These options can also be set from the **Config → Server V3 (MQTT)** web page.
144144

145-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
145+
^^^^^^^^^^^^^^^^^^^^^^^^^
146146
TLS client authentication
147-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
147+
^^^^^^^^^^^^^^^^^^^^^^^^^
148148

149-
MQTT brokers that require client certificate authentication (mTLS) are supported.
150-
Paste PEM-encoded certificate and key into the **Config → Server V3 (MQTT)** web page,
149+
The module supports client certificate authentication (mTLS) for brokers that need it.
150+
Paste the PEM certificate and key into the **Config → Server V3 (MQTT)** web page,
151151
or use the CLI::
152152

153153
OVMS# server v3 tlsclient import /sd/client.crt /sd/client.key

0 commit comments

Comments
 (0)