Skip to content

Commit c8799a9

Browse files
committed
5203
1 parent b7acf87 commit c8799a9

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/reference/configuration.txt

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,10 @@ Mongoid Configuration Options
116116
The following annotated example ``mongoid.yml`` demonstrates how Mongoid
117117
can be configured.
118118

119+
Mongoid delegates to the Ruby driver for client configuration. Please review
120+
`the driver documentation <https://docs.mongodb.com/ruby-driver/current/reference/create-client/>`_
121+
for details on driver options.
122+
119123
.. code-block:: yaml
120124

121125
development:
@@ -163,9 +167,11 @@ can be configured.
163167
roles:
164168
- 'dbOwner'
165169

166-
# Change the default authentication mechanism. Valid options are: :scram,
167-
# :mongodb_cr, :mongodb_x509, and :plain. (default on 3.0 is :scram, default
168-
# on 2.4 and 2.6 is :plain)
170+
# Change the default authentication mechanism. Please see the
171+
# driver documentation linked above for details on how to configure
172+
# authentication. Valid options are :aws, :gssapi, :mongodb_cr,
173+
# :mongodb_x509, :plain, :scram and :scram256 (default on 3.0
174+
# and higher servers is :scram, default on 2.6 servers is :plain)
169175
auth_mech: :scram
170176

171177
# Specify the auth source, i.e. the database or other source which
@@ -296,9 +302,6 @@ can be configured.
296302
# (default: false)
297303
use_utc: false
298304

299-
The Ruby driver options may be found in
300-
`the driver documentation <https://docs.mongodb.com/ruby-driver/current/reference/create-client/>`_.
301-
302305
ERb Preprocessing
303306
=================
304307

0 commit comments

Comments
 (0)