Skip to content

Commit c85e70c

Browse files
committed
Fix links in encryption tutorial
1 parent de1f890 commit c85e70c

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

docs/tutorial/encryption.txt

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,31 +27,31 @@ encryption.
2727
crypt_shared
2828
~~~~~~~~~~~~
2929

30-
The :manual:`Automatic Encryption Shared Library </manual/core/queryable-encryption/reference/shared-library/>`
30+
The :manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`
3131
(crypt_shared) provides the same functionality as mongocryptd_, but does not
3232
require you to spawn another process to perform automatic encryption.
3333

3434
By default, the PHP driver attempts to load crypt_shared from the system path(s)
3535
and uses it automatically if found. To load crypt_shared from another location,
3636
use the ``cryptSharedLibPath`` auto encryption
37-
:php:`driver option <mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`
37+
:php:`driver option <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`
3838
when constructing a client. If the driver cannot load crypt_shared it will
3939
attempt to fallback to using mongocryptd by default. The
4040
``cryptSharedLibRequired`` option may be used to always require crypt_shared and
4141
fail if it cannot be loaded.
4242

4343
For detailed installation instructions see the MongoDB documentation for the
44-
:manual:`Automatic Encryption Shared Library </manual/core/queryable-encryption/reference/shared-library/>`.
44+
:manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`.
4545

4646

4747
mongocryptd
4848
~~~~~~~~~~~
4949

5050
The mongocryptd binary is an alternative requirement for automatic client-side
5151
encryption and is included as a component in the
52-
:manual:`MongoDB Enterprise Server package </manual/administration/install-enterprise/>`.
52+
:manual:`MongoDB Enterprise Server package </administration/install-enterprise/>`.
5353
For detailed installation instructions see the
54-
:manual:`MongoDB documentation on mongocryptd </manual/core/csfle/reference/mongocryptd/>`.
54+
:manual:`MongoDB documentation on mongocryptd </core/csfle/reference/mongocryptd/>`.
5555

5656
mongocryptd performs the following:
5757

@@ -64,12 +64,12 @@ mongocryptd performs the following:
6464

6565
- Rejects read/write operations that may return unexpected or incorrect results
6666
when applied to an encrypted field. For supported and unsupported operations,
67-
see :manual:`Supported Operations for Automatic Encryption </manual/core/csfle/reference/supported-operations/>`.
67+
see :manual:`Supported Operations for Automatic Encryption </core/csfle/reference/supported-operations/>`.
6868

6969
A client configured with auto encryption will automatically spawn the
7070
mongocryptd process from the application's ``PATH``. Applications can control
7171
the spawning behavior via various auto encryption
72-
:php:`driver options <mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`.
72+
:php:`driver options <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`.
7373

7474
mongocryptd is only responsible for supporting automatic client-side encryption
7575
and does not itself perform any encryption or decryption.
@@ -78,6 +78,7 @@ and does not itself perform any encryption or decryption.
7878
Managing Encryption Keys
7979
------------------------
8080

81+
.. seealso:: :manual:`Encryption Key Management </core/csfle/fundamentals/manage-keys/>` in the MongoDB manual
8182

8283
Creating an Encryption Key
8384
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -101,8 +102,6 @@ more than one encryption key or create them dynamically.
101102
.. literalinclude:: /examples/create_data_key.php
102103
:language: php
103104

104-
.. seealso:: :manual:`Encryption Key Management </csfle/fundamentals/manage-keys/>` in the MongoDB manual
105-
106105

107106
Referencing Encryption Keys by an Alternative Name
108107
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -127,11 +126,11 @@ Client-Side Field Level Encryption
127126
----------------------------------
128127

129128
Introduced in MongoDB 4.2,
130-
:manual:`Client-Side Field Level Encryption </manual/core/csfle/>` allows an
129+
:manual:`Client-Side Field Level Encryption </core/csfle/>` allows an
131130
application to encrypt specific data fields in addition to pre-existing MongoDB
132131
encryption features such as
133-
:manual:`Encryption at Rest </manual/core/security-encryption-at-rest/>` and
134-
:manual:`TLS/SSL (Transport Encryption) </manual/core/security-transport-encryption/>`.
132+
:manual:`Encryption at Rest </core/security-encryption-at-rest/>` and
133+
:manual:`TLS/SSL (Transport Encryption) </core/security-transport-encryption/>`.
135134

136135
With field level encryption, applications can encrypt fields in documents prior
137136
to transmitting data over the wire to the server. Client-side field level
@@ -150,7 +149,7 @@ Automatic Client-Side Field Level Encryption
150149

151150
Automatic client-side field level encryption is enabled by creating a client and
152151
specifying the ``autoEncryption``
153-
:php:`driver option <mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`.
152+
:php:`driver option <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`.
154153
The following examples demonstrate how to setup automatic client-side field
155154
level encryption and use a
156155
:php:`MongoDB\\Driver\\ClientEncryption <class.mongodb-driver-clientencryption>`
@@ -184,7 +183,7 @@ Server-Side Field Level Encryption Enforcement
184183
The MongoDB 4.2+ server supports using schema validation to enforce encryption
185184
of specific fields in a collection. This schema validation will prevent an
186185
application from inserting unencrypted values for any fields marked with the
187-
:manual:`"encrypt`` JSON schema keyword </core/csfle/reference/encryption-schemas/>`.
186+
:manual:`"encrypt" JSON schema keyword </core/csfle/reference/encryption-schemas/>`.
188187

189188
The following example sets up a collection with automatic encryption using a
190189
``$jsonSchema`` validator and
@@ -214,7 +213,7 @@ Although automatic encryption requires MongoDB 4.2+ enterprise or a MongoDB 4.2+
214213
Atlas cluster, automatic *decryption* is supported for all users. To configure
215214
automatic decryption without automatic encryption set the
216215
``bypassAutoEncryption`` auto encryption
217-
:php:`driver option <mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`
216+
:php:`driver option <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`
218217
when constructing a client.
219218

220219
.. literalinclude:: /examples/csfle-explicit_encryption_automatic_decryption.php
@@ -225,7 +224,7 @@ Queryable Encryption
225224
--------------------
226225

227226
Introduced in MongoDB 7.0,
228-
:manual:`Queryable Encryption </manual/core/queryable-encryption/>` is another
227+
:manual:`Queryable Encryption </core/queryable-encryption/>` is another
229228
form of in-use encryption. Data is encrypted client-side. Queryable Encryption
230229
supports indexed encrypted fields, which are further processed server-side.
231230

0 commit comments

Comments
 (0)