-
Notifications
You must be signed in to change notification settings - Fork 81
DOCSP-24594-Compass-auth-examples #708
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.
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
Changes from 7 commits
8eb2bce
920f171
3ae93e3
901e4e8
c04f4e8
b5b58e4
7f29522
50e6844
48540de
3fbc615
de6caac
0b680bd
44087c3
4ae08c2
9359bf8
9238a00
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -273,3 +273,22 @@ Procedure | |
| .. seealso:: | ||
|
|
||
| To disconnect from your deployment, see :ref:`<disconnect-tab>`. | ||
|
|
||
| Example | ||
|
||
| ------- | ||
|
|
||
| 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 |
|---|---|---|
|
|
@@ -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 | ||
|
|
@@ -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 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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? There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
There was a problem hiding this comment.
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:
We could apply a similar wording to the other example lead-ins.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!