Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
12 changes: 12 additions & 0 deletions source/connect/advanced-connection-options/advanced-connection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,15 @@ Procedure
.. seealso::

To disconnect from your deployment, see :ref:`<disconnect-tab>`.

Example
-------

The following screenshot shows the :guilabel:`Advanced` tab configured
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Suggestion]

Maybe to tighten up the wording slightly:

The following example specifies a connection with a read preference of :guilabel:Secondary Preferred.

We could apply a similar wording to the other example lead-ins.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

with the read preference of :guilabel:`Secondary Preferred`. The
:guilabel:`Secondary Preferred` read preference prevents queries from
overloading the primary node.

.. figure:: /images/authentication/secondary-preferred.png
:figwidth: 662px
:alt: Screenshot of Compass configured to connect with read preference of secondary preferred
Original file line number Diff line number Diff line change
Expand Up @@ -273,3 +273,22 @@ Procedure
.. seealso::

To disconnect from your deployment, see :ref:`<disconnect-tab>`.

Example
Copy link
Collaborator

@jeff-allen-mongo jeff-allen-mongo Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Suggestion]

Maybe we can make this "Examples" and have subheadings for each example? As in:

Examples
------------

Username and Password Authentication
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

(example 1)

LDAP Authentication
~~~~~~~~~~~~~~~~~~~~

(example 2)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

-------

The following screenshot shows the :guilabel:`Authentication` tab
configured for username and password authentication with
:manual:`SCRAM-SHA-256 </core/security-scram/>`.

.. figure:: /images/authentication/authentication-configuration.png
:figwidth: 662px
:alt: Screenshot of Compass configured to authenticate with username and password

Alternatively, the following screenshot shows the
:guilabel:`Authentication` tab configured for :manual:`LDAP
</core/security-ldap-external/>` authentication.

.. figure:: /images/authentication/ldap-configuration.png
:figwidth: 662px
:alt: Screenshot of Compass configured to authenticate with LDAP
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,20 @@ Procedure
* - mongodb
- :manual:`Standard Connection String Format </reference/connection-string/>`.
The standard format of the MongoDB connection URI is used to
connect to a MongoDB deployment by specifying its hosts directly.
connect to a MongoDB deployment by specifying its hosts
directly.

Use this option to connect to standalone, replica set,
or a sharded cluster

.. note::

If you use the standard connection string format to
connect to an `Atlas
<https://www.mongodb.com/cloud/atlas>`__ deployment,
you must turn on TLS/SSL in the
:guilabel:`TLS/SSL` tab of the :guilabel:`New
Connection` modal.

* - mongodb+srv
- :manual:`DNS Seed List Connection Format
Expand Down Expand Up @@ -93,3 +106,14 @@ Procedure
.. seealso::

To disconnect from your deployment, see :ref:`<disconnect-tab>`.

Example
-------

The following screenshot shows the :guilabel:`General` tab configured
for an Atlas cluster with :manual:`SCRAM-SHA-256
</core/security-scram/>`. Since the connection uses the ``mongodb+srv``
connection string scheme, the connection automatically enables TLS/SSL.

.. figure:: /images/authentication/new-atlas-connection.png
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed the other figures specified a figwidth of 662px. Should we add that here as well?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this! Done!

:alt: Screenshot of Compass configured to connect to an example Atlas cluster
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ Procedure
.. warning::

Enabling ``tlsInsecure``, ``tlsAllowInvalidHostnames``, and
``tlsAllowInvalidCertificates`` may cause a security vulnerabilty.
``tlsAllowInvalidCertificates`` may cause a security
vulnerabilty.

.. step:: (Optional) For advanced connection configuration options, click the :ref:`Advanced <advanced-connection-tab>` tab.

Expand All @@ -114,3 +115,13 @@ Procedure
.. seealso::

To disconnect from your deployment, see :ref:`<disconnect-tab>`.

Example
-------

The following screenshot shows the :guilabel:`TLS / SSL` tab configured
for a cluster with TLS/SSL enabled.

.. figure:: /images/authentication/tls-ssl-configuration.png
:figwidth: 662px
:alt: Screenshot of Compass configured to connect to an example cluster with TLS/SSL
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading