From 2af448cc083199b90c2a8bb939ba257874e5f057 Mon Sep 17 00:00:00 2001 From: Dmitry Rybakov Date: Mon, 8 May 2023 09:16:35 +0200 Subject: [PATCH] MONGOID-5614 Document ffi dependency (#5615) Co-authored-by: Alex Bevilacqua --- docs/tutorials/automatic-encryption.txt | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/tutorials/automatic-encryption.txt b/docs/tutorials/automatic-encryption.txt index 04d1144d2e..6b3af35f2e 100644 --- a/docs/tutorials/automatic-encryption.txt +++ b/docs/tutorials/automatic-encryption.txt @@ -48,7 +48,8 @@ You can find the detailed description of how to install the necessary dependencies in `the driver documentation. `_ Note the version of the Ruby driver being used in your application and select -the appropriate steps below: +the appropriate steps below. + Install ``libmongocrypt`` ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -97,6 +98,17 @@ need to be installed manually. ``mongocryptd`` comes pre-packaged with enterprise builds of the MongoDB server (versions 4.2 and newer). For installation instructions, see the `MongoDB manual `_. +Add ``ffi`` to your Gemfile +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The MongoDB Ruby driver uses the `ffi gem `_ to call +functions from ``libmongocrypt``. As this gem is not a dependency of +the driver, it will need to be manually added to your ``Gemfile``: + +.. code-block:: ruby + + gem 'ffi' + Create a Customer Master Key ============================