Skip to content

MONGOID-5203 Add all available auth_mech options to Configuration documentation #5103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 17, 2021
Merged

MONGOID-5203 Add all available auth_mech options to Configuration documentation #5103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions docs/reference/configuration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,10 @@ Mongoid Configuration Options
The following annotated example ``mongoid.yml`` demonstrates how Mongoid
can be configured.

Mongoid delegates to the Ruby driver for client configuration. Please review
`the driver documentation <https://docs.mongodb.com/ruby-driver/current/reference/create-client/>`_
for details on driver options.

.. code-block:: yaml

development:
Expand Down Expand Up @@ -163,9 +167,11 @@ can be configured.
roles:
- 'dbOwner'

# Change the default authentication mechanism. Valid options are: :scram,
# :mongodb_cr, :mongodb_x509, and :plain. (default on 3.0 is :scram, default
# on 2.4 and 2.6 is :plain)
# Change the default authentication mechanism. Please see the
# driver documentation linked above for details on how to configure
# authentication. Valid options are :aws, :gssapi, :mongodb_cr,
# :mongodb_x509, :plain, :scram and :scram256 (default on 3.0
# and higher servers is :scram, default on 2.6 servers is :plain)
auth_mech: :scram

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

The Ruby driver options may be found in
`the driver documentation <https://docs.mongodb.com/ruby-driver/current/reference/create-client/>`_.

ERb Preprocessing
=================

Expand Down