.. _compatibility: ******************** Driver Compatibility ******************** .. default-domain:: mongodb .. contents:: On this page :local: :backlinks: none :depth: 1 :class: singlecol .. _mongodb-compatibility: MongoDB Compatibility ===================== The following compatibility table specifies the recommended version(s) of the MongoDB Ruby driver for use with a specific version of MongoDB. Except when indicated, the specified driver versions expose or take advantage of the features added in the corresponding server versions. MongoDB server releases are generally backwards compatible, meaning a particular version of the driver will generally work with newer versions of the server but may not take advantage of the functionality released in the newer version of the server. The first column lists the driver versions.“D” in other columns means support for that MongoDB version is deprecated and will be removed in a future driver version. .. list-table:: :header-rows: 1 :stub-columns: 1 :class: compatibility-large no-padding * - Ruby Driver - MongoDB 6.0 - MongoDB 5.2 - MongoDB 5.1 - MongoDB 5.0 - MongoDB 4.4 - MongoDB 4.2 - MongoDB 4.0 - MongoDB 3.6 - MongoDB 3.4 - MongoDB 3.2 - MongoDB 3.0 - MongoDB 2.6 * - 2.18 - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - - - - * - 2.17 - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - - - - * - 2.16 - - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - D - D - D - D * - 2.15 - - - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| * - 2.14 - - - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| * - 2.13 - - - - - |checkmark| [#ocsp]_ - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| * - 2.12 - - - - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| * - 2.11 - - - - - - |checkmark| [#client-side-encryption]_ - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| * - 2.10 - - - - - - |checkmark| [#srv-polling]_ [#client-side-encryption]_ - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| * - 2.9 - - - - - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| * - 2.8 - - - - - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| * - 2.7 - - - - - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| * - 2.6 - - - - - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| * - 2.5 - - - - - - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| * - 2.4 - - - - - - - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| * - 2.3 - - - - - - - - - - |checkmark| - |checkmark| - |checkmark| * - 2.2 - - - - - - - - - - |checkmark| - |checkmark| - |checkmark| * - 2.0 - - - - - - - - - - - |checkmark| - |checkmark| .. [#ocsp] OCSP verification is implemented as of driver version 2.14. .. [#srv-polling] Polling of SRV records in sharded topologies is implemented as of driver version 2.11. .. [#client-side-encryption] Client-side encryption is implemented as of driver version 2.12. The driver does not support older versions of MongoDB. .. _ruby-compatibility: Ruby Compatibility ================== The following compatibility table specifies the versions of Ruby supported by the various versions of the MongoDB Ruby driver. The first column lists the driver versions. "D" in a column means support for that Ruby version is deprecated. .. list-table:: :header-rows: 1 :stub-columns: 1 :class: compatibility-large no-padding * - Ruby Driver - Ruby 3.0 - Ruby 2.7 - Ruby 2.6 - Ruby 2.5 - Ruby 2.4 - Ruby 2.3 - Ruby 2.2 - Ruby 2.1 - Ruby 2.0 - Ruby 1.9 - JRuby 9.3 - JRuby 9.2 - JRuby 9.1 * - 2.18 - |checkmark| - |checkmark| - |checkmark| - |checkmark| - - - - - - - |checkmark| - |checkmark| - * - 2.17 - |checkmark| - |checkmark| - |checkmark| - |checkmark| - - - - - - - - |checkmark| - * - 2.16 - |checkmark| - |checkmark| - |checkmark| - |checkmark| - D - - - - - - - |checkmark| - * - 2.15 - |checkmark| - |checkmark| - |checkmark| - |checkmark| - D - D - - - - - - |checkmark| - * - 2.14 - - |checkmark| - |checkmark| - |checkmark| - D - D - - - - - - |checkmark| - * - 2.13 - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - - - - - - |checkmark| - * - 2.12 - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - - - - - - |checkmark| - * - 2.11 - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - - - - - - |checkmark| - * - 2.10 - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - D - D - D - D - - |checkmark| - |checkmark| * - 2.9 - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - D - D - D - D - - |checkmark| - |checkmark| * - 2.8 - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - - |checkmark| - |checkmark| * - 2.7 - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - - |checkmark| - |checkmark| * - 2.6 - - - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - |checkmark| - - |checkmark| - |checkmark| The driver does not support older versions of Ruby. Rails/ActiveSupport Compatibility ================================= The Ruby driver does not depend on ActiveSupport. However, when an application uses ActiveSupport or Ruby on Rails, it must load the driver's ActiveSupport compatibility code for behavior like time serialization to be correct: .. code-block:: ruby require 'mongo' require 'mongo/active_support' Applications using Mongoid 7.0.6 or newer do not need to explicitly load the driver's ActiveSupport code, since Mongoid automatically does so. .. _tls-compatibility: TLS/SSL Compatibility ===================== The driver will utilize the protocols supported by the underlying Ruby ``openssl`` extension. In turn, the ``openssl`` extension generally exposes the functionality that exists in the operating system's OpenSSL library. Industry best practices, and some regulations, require the use of TLS 1.1 or newer. Some operating systems or versions may not provide an OpenSSL version new enough to support these TLS versions. Users of macOS older than 10.13 (High Sierra) will need to install Ruby from `rvm`_, `homebrew`_, `macports`_, or another similar source. See `installation information on ruby-lang.org`_ for more options. Users of Linux or other non-macOS Unix can check their OpenSSL version as follows: .. code-block:: sh openssl version If the version number is less than 1.0.1 support for TLS 1.1 or newer is not available. Contact your operating system vendor for a solution or upgrade to a newer distribution. You can check your Ruby interpreter by executing the following command: .. code-block:: sh ruby -e "require 'net/http'; require 'json'; puts JSON.parse(Net::HTTP.get(URI('https://www.howsmyssl.com/a/check')))['tls_version']" You should see "TLS 1.X" where X is >= 1. You can read more about TLS versions and their security implications `here `_. .. _rvm: https://rvm.io/ .. _homebrew: https://brew.sh/ .. _macports: https://www.macports.org/ .. _installation information on ruby-lang.org: https://www.ruby-lang.org/en/documentation/installation Atlas Compatibility =================== `Driver version 2.6.1 `_ or higher is recommended when using MongoDB Atlas, as this version has significant performance improvements when TLS connections are used, and all Atlas connections use TLS. When running on JRuby and connecting to Atlas Free Tier, `driver version 2.6.4 `_ or higher and Java 8 or higher are required. ``mongo_kerberos`` Compatibility ================================ The following compatibility table specifies the version(s) of the :ref:`mongo_kerberos library ` to use with a specific version of the driver. .. list-table:: :header-rows: 1 :stub-columns: 1 :class: compatibility-large no-padding * - Ruby Driver - mongo_kerberos |nbsp| 2.1 * - 2.7 - 2.16 - |checkmark| JRuby and Kerberos Authentication ================================= If the ``mongo_kerberos`` gem is used for Kerberos authentication with JRuby, the the JVM system property "sun.security.jgss.native" to will be set to "true" in order to facilitate the use of the system cache of TGTs (e.g. TGTs obtained with ``kinit``). Any other use of the JGSS library will also be affected by this setting, meaning any TGTs in the system cache will be available for obtaining Kerberos credentials as well. .. include:: /includes/unicode-checkmark.rst .. include:: /includes/unicode-nbsp.rst JRuby and TLS Connections ========================= Due to JRuby limitations: - ECDSA server certificates are not supported. - OCSP endpoint checking is not performed.