Skip to content

Commit 82b4c60

Browse files
committed
Add admonition for crypt shared lib path config
1 parent cb555b5 commit 82b4c60

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/howto/queryable-encryption.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,5 +285,29 @@ settings::
285285
},
286286
}
287287

288+
289+
.. admonition:: Dynamic library path configuration
290+
291+
The Automatic Encryption Shared Library is platform‑specific. Make sure to
292+
download the correct version for your operating system and architecture,
293+
and configure your environment so the system can locate it.
294+
295+
Use the following variables depending on your platform:
296+
297+
+---------------+---------------------------------+
298+
| **Platform** | **Environment Variable** |
299+
+---------------+---------------------------------+
300+
| Windows | ``PATH`` |
301+
+---------------+---------------------------------+
302+
| macOS | ``DYLD_FALLBACK_LIBRARY_PATH`` |
303+
+---------------+---------------------------------+
304+
| Linux | ``LD_LIBRARY_PATH`` |
305+
+---------------+---------------------------------+
306+
307+
For example on macOS, you can set the ``DYLD_FALLBACK_LIBRARY_PATH``
308+
environment variable in your shell before starting your Django application::
309+
310+
$ export DYLD_FALLBACK_LIBRARY_PATH="/path/to/mongo_crypt_shared_v1.dylib:$DYLD_FALLBACK_LIBRARY_PATH"
311+
288312
You are now ready to :doc:`start developing applications
289313
</topics/queryable-encryption>` with Queryable Encryption!

0 commit comments

Comments
 (0)