Skip to content

Commit ec4b020

Browse files
committed
PYTHON-1993 Use dochub for stable CSFLE documentation links
1 parent e31a0ef commit ec4b020

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

doc/examples/encryption.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,17 @@ Client-Side Field Level Encryption
44
New in MongoDB 4.2, client-side field level encryption allows an application
55
to encrypt specific data fields in addition to pre-existing MongoDB
66
encryption features such as `Encryption at Rest
7-
<https://docs.mongodb.com/manual/core/security-encryption-at-rest/>`_ and
7+
<https://dochub.mongodb.org/core/security-encryption-at-rest>`_ and
88
`TLS/SSL (Transport Encryption)
9-
<https://docs.mongodb.com/manual/core/security-transport-encryption/>`_.
9+
<https://dochub.mongodb.org/core/security-tls-transport-encryption>`_.
1010

1111
With field level encryption, applications can encrypt fields in documents
1212
*prior* to transmitting data over the wire to the server. Client-side field
1313
level encryption supports workloads where applications must guarantee that
1414
unauthorized parties, including server administrators, cannot read the
1515
encrypted data.
1616

17-
.. seealso:: The MongoDB documentation for `Client-Side Field Level Encryption
18-
<https://docs.mongodb.com/manual/core/security-client-side-encryption/>`_.
17+
.. mongodoc:: client-side-field-level-encryption
1918

2019
Dependencies
2120
------------
@@ -38,10 +37,10 @@ mongocryptd
3837

3938
The ``mongocryptd`` binary is required for automatic client-side encryption
4039
and is included as a component in the `MongoDB Enterprise Server package
41-
<https://docs.mongodb.com/manual/administration/install-enterprise/>`_.
40+
<https://dochub.mongodb.org/core/install-mongodb-enterprise>`_.
4241
For detailed installation instructions see
4342
`the MongoDB documentation on mongocryptd
44-
<https://docs.mongodb.com/manual/reference/security-client-side-encryption-appendix/#mongocryptd>`_.
43+
<https://dochub.mongodb.org/core/client-side-field-level-encryption-mongocryptd>`_.
4544

4645
``mongocryptd`` performs the following:
4746

@@ -53,7 +52,7 @@ For detailed installation instructions see
5352
- Rejects read/write operations that may return unexpected or incorrect results
5453
when applied to an encrypted field. For supported and unsupported operations,
5554
see `Read/Write Support with Automatic Field Level Encryption
56-
<https://docs.mongodb.com/manual/reference/security-client-side-query-aggregation-support/>`_.
55+
<https://dochub.mongodb.org/core/client-side-field-level-encryption-read-write-support>`_.
5756

5857
A MongoClient configured with auto encryption will automatically spawn the
5958
``mongocryptd`` process from the application's ``PATH``. Applications can
@@ -107,7 +106,7 @@ Providing Local Automatic Encryption Rules
107106
The following example shows how to specify automatic encryption rules via the
108107
``schema_map`` option. The automatic encryption rules are expressed using a
109108
`strict subset of the JSON Schema syntax
110-
<https://docs.mongodb.com/manual/reference/security-client-side-automatic-json-schema/>`_.
109+
<https://dochub.mongodb.org/core/client-side-field-level-encryption-automatic-encryption-rules>`_.
111110

112111
Supplying a ``schema_map`` provides more security than relying on
113112
JSON Schemas obtained from the server. It protects against a
@@ -144,7 +143,7 @@ will result in an error.::
144143
CodecOptions())
145144

146145
# Create a new data key and json schema for the encryptedField.
147-
# https://docs.mongodb.com/manual/reference/security-client-side-automatic-json-schema/
146+
# https://dochub.mongodb.org/core/client-side-field-level-encryption-automatic-encryption-rules
148147
data_key_id = client_encryption.create_data_key(
149148
'local', key_alt_names=['pymongo_encryption_example_1'])
150149
schema = {
@@ -234,7 +233,7 @@ encryption using
234233
:class:`~pymongo.encryption.ClientEncryption` to create a new encryption
235234
data key and create a collection with the
236235
`Automatic Encryption JSON Schema Syntax
237-
<https://docs.mongodb.com/manual/reference/security-client-side-automatic-json-schema/>`_::
236+
<https://dochub.mongodb.org/core/client-side-field-level-encryption-automatic-encryption-rules>`_::
238237

239238
import os
240239

0 commit comments

Comments
 (0)