Skip to content

Commit

Permalink
MONGOID-5614 Document ffi dependency (#5615)
Browse files Browse the repository at this point in the history
Co-authored-by: Alex Bevilacqua <alex@alexbevi.com>
  • Loading branch information
comandeo-mongo and alexbevi committed May 8, 2023
1 parent 85ad705 commit 2af448c
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/tutorials/automatic-encryption.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ You can find the detailed description of how to install the necessary
dependencies in `the driver documentation. <https://www.mongodb.com/docs/ruby-driver/current/reference/client-side-encryption/#installation>`_

Note the version of the Ruby driver being used in your application and select
the appropriate steps below:
the appropriate steps below.


Install ``libmongocrypt``
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -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 <https://mongodb.com/docs/manual/reference/security-client-side-encryption-appendix/#installation>`_.

Add ``ffi`` to your Gemfile
~~~~~~~~~~~~~~~~~~~~~~~~~~~

The MongoDB Ruby driver uses the `ffi gem <https://github.com/ffi/ffi>`_ 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
============================

Expand Down

0 comments on commit 2af448c

Please sign in to comment.