@@ -90,9 +90,34 @@ you add this variable to your rc files. For example:
90
90
The binary referenced in this section can be a pre-release version of
91
91
libmongocrypt which is not recommended for production environments.
92
92
93
+ Automatic Encryption Shared Library
94
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95
+
96
+ The Automatic Encryption Shared Library is a dynamic library that enables your
97
+ client application to perform automatic encryption. It is only required for
98
+ automatic encryption, which is an enterprise-only feature.
99
+ If you only intend to use explicit encryption, you may skip this step.
100
+ The Automatic Encryption Shared Library provides the same functionality as
101
+ mongocryptd (see below), but does not require you to spawn another process
102
+ to perform automatic encryption.
103
+
104
+ For installation instructions, see
105
+ `the MongoDB manual <https://www.mongodb.com/docs/manual/core/queryable-encryption/reference/shared-library/#download-the-automatic-encryption-shared-library>`_.
106
+
107
+ When automatic encryption is enabled, libmongocrypt will look for the shared
108
+ library in the system library path, or try to load the library from a particular
109
+ place if ``:crypt_shared_lib_path`` option is provided when creating a client.
110
+ If the library can be loaded, then the driver will not try to spawn mongocryptd daemon.
111
+ The daemon will be still spawned if the shared library cannot be found.
112
+
113
+ It is also possible to require using the shared library by passing
114
+ ``crypt_shared_lib_required: true`` option when creating a client. In this case,
115
+ an error will be raised if the shared library cannot be loaded.
116
+
93
117
mongocryptd
94
118
~~~~~~~~~~~
95
119
120
+ Mongocryptd is an alternative to the Automatic Encryption Shared Library.
96
121
Mongocryptd is a daemon that tells the driver which fields to encrypt in a
97
122
given operation. It is only required for automatic encryption, which is an
98
123
enterprise-only feature. If you only intend to use explicit encryption, you may
0 commit comments