@@ -19,45 +19,45 @@ To get started using in-use encryption in your project, the
1919to be compiled with `libmongocrypt <https://github.com/mongodb/libmongocrypt>`_
2020(enabled by default).
2121
22- Additionally, either `crypt_shared`_ or `mongocryptd`_ are required in order to
22+ Additionally, either `` crypt_shared`` or `` mongocryptd`` are required in order to
2323use *automatic* client-side encryption. Neither is required for *explicit*
2424encryption.
2525
2626
27- crypt_shared
28- ~~~~~~~~~~~~
27+ `` crypt_shared``
28+ ~~~~~~~~~~~~~~~~
2929
3030The :manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`
31- (crypt_shared) provides the same functionality as mongocryptd_ , but does not
31+ (`` crypt_shared`` ) provides the same functionality as ``mongocryptd`` , but does not
3232require you to spawn another process to perform automatic encryption.
3333
34- By default, the PHP driver attempts to load crypt_shared from the system path(s)
35- and uses it automatically if found. To load crypt_shared from another location,
34+ By default, the PHP driver attempts to load `` crypt_shared`` from the system path(s)
35+ and uses it automatically if found. To load `` crypt_shared`` from another location,
3636use the ``cryptSharedLibPath`` auto encryption
3737:php:`driver option <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`
38- when constructing a client. If the driver cannot load crypt_shared it will
39- attempt to fallback to using mongocryptd by default. The
40- ``cryptSharedLibRequired`` option may be used to always require crypt_shared and
38+ when constructing a client. If the driver cannot load `` crypt_shared`` it will
39+ attempt to fallback to using `` mongocryptd`` by default. The
40+ ``cryptSharedLibRequired`` option may be used to always require `` crypt_shared`` and
4141fail if it cannot be loaded.
4242
4343For detailed installation instructions see the MongoDB documentation for the
4444:manual:`Automatic Encryption Shared Library </core/queryable-encryption/reference/shared-library/>`.
4545
4646
47- mongocryptd
48- ~~~~~~~~~~~
47+ `` mongocryptd``
48+ ~~~~~~~~~~~~~~~
4949
50- The mongocryptd binary is an alternative requirement for automatic client-side
50+ The `` mongocryptd`` binary is an alternative requirement for automatic client-side
5151encryption and is included as a component in the
5252:manual:`MongoDB Enterprise Server package </administration/install-enterprise/>`.
5353For detailed installation instructions see the
5454:manual:`MongoDB documentation on mongocryptd </core/csfle/reference/mongocryptd/>`.
5555
56- mongocryptd performs the following:
56+ `` mongocryptd`` performs the following:
5757
5858- Parses the automatic encryption rules specified in the client configuration.
5959 If the ``schemaMap`` auto encryption driver option contains invalid syntax,
60- mongocryptd returns an error.
60+ `` mongocryptd`` returns an error.
6161
6262- Uses the specified automatic encryption rules to mark fields in read and write
6363 operations for encryption.
@@ -67,11 +67,11 @@ mongocryptd performs the following:
6767 see :manual:`Supported Operations for Automatic Encryption </core/csfle/reference/supported-operations/>`.
6868
6969A client configured with auto encryption will automatically spawn the
70- mongocryptd process from the application's ``PATH``. Applications can control
70+ `` mongocryptd`` process from the application's ``PATH``. Applications can control
7171the spawning behavior via various auto encryption
7272:php:`driver options <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`.
7373
74- mongocryptd is only responsible for supporting automatic client-side encryption
74+ `` mongocryptd`` is only responsible for supporting automatic client-side encryption
7575and does not itself perform any encryption or decryption.
7676
7777
@@ -208,7 +208,7 @@ Explicit Encryption
208208~~~~~~~~~~~~~~~~~~~
209209
210210Explicit encryption is a MongoDB community feature and does not use
211- crypt_shared_ or mongocryptd_ . Explicit encryption is provided by the
211+ ``crypt_shared`` or ``mongocryptd`` . Explicit encryption is provided by the
212212:php:`MongoDB\Driver\ClientEncryption <mongodb-driver-clientencryption>` class.
213213
214214.. literalinclude:: /examples/encryption/csfle-explicit_encryption.php
0 commit comments