Skip to content

Commit ab79d9d

Browse files
fix build errors with broken mongosh refs
1 parent 1ca84ae commit ab79d9d

File tree

5 files changed

+27
-29
lines changed

5 files changed

+27
-29
lines changed

source/appendix/security/appendixC-openssl-client.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -174,10 +174,9 @@ B. Generate the Test PEM File for Client
174174

175175
mongosh --tls --tlsCertificateSelector subject="<TestClientCertificateCommonName>"
176176

177-
Although still available, :option:`--ssl <mongosh --ssl>` and
178-
:option:`--sslCertificateSelector <mongo
179-
--sslCertificateSelector>` are :ref:`deprecated as of MongoDB 4.2
180-
<4.2-tls>`.
177+
Although still available, ``--ssl`` and
178+
``--sslCertificateSelector`` are
179+
:ref:`deprecated as of MongoDB 4.2 <4.2-tls>`.
181180

182181
**For MongoDB 4.0 and earlier**
183182

source/core/security-x.509.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,12 @@ To connect and authenticate using x.509 client certificate:
8484

8585
- For MongoDB 4.0 and earlier, include the following options for the client:
8686

87-
- :option:`--ssl <mongosh --ssl>`
87+
- ``--ssl``
8888

89-
- :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`
89+
- ``--sslPEMKeyFile``
9090

91-
- :option:`--sslPEMKeyPassword <mongosh --sslPEMKeyPassword>` option if
92-
the :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>` is encrypted.
91+
- ``--sslPEMKeyPassword`` option if
92+
the ``--sslPEMKeyFile`` is encrypted.
9393

9494
- :option:`--authenticationDatabase '$external'
9595
<mongo --authenticationDatabase>`

source/reference/connection-string.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -449,7 +449,7 @@ Alternatively, you can also use the equivalent :urioption:`ssl=true
449449

450450
If the :binary:`mongo` shell specifies additional
451451
:ref:`tls/ssl <mongo-shell-ssl>` options from the
452-
command-line, use the :option:`--ssl <mongosh --ssl>`
452+
command-line, use the ``--ssl``
453453
command-line option instead.
454454

455455
* - .. urioption:: tlsCertificateKeyFile

source/tutorial/configure-ssl-clients.txt

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -201,9 +201,8 @@ On Windows and macOS,
201201
mongosh --tls --host hostname.example.com --tlsCertificateSelector subject="myclient.example.net"
202202

203203
Although still available, :mongosh:`mongosh </>`
204-
:option:`--ssl <mongosh --ssl>`, :option:`--sslCAFile <mongo
205-
--sslCAFile>`, :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`,
206-
:option:`--sslCertificateSelector <mongosh --sslCertificateSelector>`
204+
``--ssl``, ``--sslCAFile``, ``--sslPEMKeyFile``, and
205+
``--sslCertificateSelector`` options
207206
are :ref:`deprecated as of MongoDB 4.2 <4.2-tls>`.
208207

209208
Avoid Use of ``--tlsAllowInvalidCertificates`` Option
@@ -243,31 +242,31 @@ Avoid Use of ``--tlsAllowInvalidCertificates`` Option
243242
* - SSL Option (Deprecated in 4.2)
244243
- Notes
245244

246-
* - :option:`--ssl <mongosh --ssl>`
245+
* - ``--ssl``
247246
- Enables TLS/SSL connection.
248247

249-
* - :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`
248+
* - ``--sslPEMKeyFile``
250249

251250
- Specifies the :file:`.pem` file that contains
252251
:mongosh:`mongosh </>`'s certificate and key to present to
253252
the :binary:`~bin.mongod` or :binary:`~bin.mongos` instance.
254253

255-
* - :option:`--sslPEMKeyPassword <mongosh --sslPEMKeyPassword>`
254+
* - ``--sslPEMKeyPassword``
256255

257256
- If :mongosh:`mongosh </>`'s certificate key file is encrypted.
258257

259-
* - :option:`--sslCAFile <mongosh --sslCAFile>`
258+
* - ``--sslCAFile``
260259

261260
- Specifies the Certificate Authority (CA) :file:`.pem` file for
262261
verification of the certificate presented by the
263262
:binary:`~bin.mongod` or the :binary:`~bin.mongos` instance.
264263

265-
* - :option:`--sslCertificateSelector <mongosh --sslCertificateSelector>`
264+
* - ``--sslCertificateSelector``
266265

267266
- If running on Windows or macOS, use a certificate from the
268267
system certificate store. (*New in version 4.0*)
269268

270-
For a complete list of :mongosh:`mongosh </>`'s ``ssl``
269+
For a complete list of ``ssl``
271270
options, see :ref:`SSL Options <mongo-shell-ssl>`.
272271

273272
For TLS/SSL connections, :mongosh:`mongosh </>` validates the
@@ -303,7 +302,7 @@ To connect to a :binary:`~bin.mongod` or :binary:`~bin.mongos` instance
303302
that requires :ref:`encrypted communication <ssl-mongod-ssl-cert-key>`,
304303
start :mongosh:`mongosh </>` with:
305304

306-
- :option:`--ssl <mongosh --ssl>`
305+
- ``--ssl``
307306

308307
- :option:`--host <mongosh --host>` and :option:`--sslCAFile <mongo
309308
--sslCAFile>` to validate the server certificate.
@@ -341,12 +340,12 @@ To connect to a :binary:`~bin.mongod` or :binary:`~bin.mongos` that
341340
requires :ref:`CA-signed client certificates
342341
<ssl-mongod-ca-signed-ssl-cert-key>`, start :mongosh:`mongosh </>` with:
343342

344-
- :option:`--ssl <mongosh --ssl>`
343+
- ``--ssl``
345344

346345
- :option:`--host <mongosh --host>` and the :option:`--sslCAFile <mongo
347346
--sslCAFile>` to validate the server certificate,
348347

349-
- :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>` option to specify
348+
- ``--sslPEMKeyFile`` option to specify
350349
the client certificate to present to the server.
351350

352351
For example, consider a :binary:`~bin.mongod` instance running on
@@ -367,9 +366,9 @@ On Windows and macOS,
367366
You can also use the :option:`--sslCertificateSelector <mongo
368367
--sslCertificateSelector>` option to specify the client certificate
369368
from the system certificate store instead of using
370-
:option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`. If the CA file
369+
``--sslPEMKeyFile``. If the CA file
371370
is also in the system certificate store, you can omit the
372-
:option:`--sslCAFile <mongosh --sslCAFile>` option as well. For
371+
``--sslCAFile`` option as well. For
373372
example, to use a certificate with the ``CN`` (Common Name) of
374373
``myclient.example.net`` and the CA file from the system certificate
375374
store on macOS, start :mongosh:`mongosh </>` with the following

source/tutorial/configure-x509-client-authentication.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -463,13 +463,13 @@ authenticate with the client certificate.
463463
* - Option
464464
- Notes
465465

466-
* - :option:`--ssl <mongosh --ssl>`
466+
* - ``--ssl``
467467
-
468468

469-
* - :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`
469+
* - ``--sslPEMKeyFile``
470470
- Client's x.509 file.
471471

472-
* - :option:`--sslCAFile <mongosh --sslCAFile>`
472+
* - ``--sslCAFile``
473473

474474
- Certificate Authority file to verify the
475475
certificate presented by
@@ -506,13 +506,13 @@ authenticate with the client certificate.
506506
* - Option
507507
- Notes
508508

509-
* - :option:`--ssl <mongosh --ssl>`
509+
* - ``--ssl``
510510
-
511511

512-
* - :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`
512+
* - ``--sslPEMKeyFile``
513513
- Client's x.509 file.
514514

515-
* - :option:`--sslCAFile <mongosh --sslCAFile>`
515+
* - ``--sslCAFile``
516516

517517
- Certificate Authority file to verify the
518518
certificate presented by

0 commit comments

Comments
 (0)