Skip to content

Commit c7ce798

Browse files
authored
DOCSP-29924 Hide Connection String Password (#501)
* DOCSP-29924 Hide Connection String Password * build errors * fix list styling * wording
1 parent a90aeda commit c7ce798

File tree

4 files changed

+51
-47
lines changed

4 files changed

+51
-47
lines changed

source/connect.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ For a complete list of the connection string options that
7676
<https://github.com/mongodb-js/connection-model/blob/master/README.md#properties>`__
7777
on GitHub.
7878

79-
.. include:: /includes/steps/starting-compass-paste-string.rst
79+
.. include:: /includes/starting-compass-paste-string.rst
8080

8181
Connect to Compass from the Command Line
8282
----------------------------------------
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. warning::
2+
3+
If you click into the |compass| connection form to edit your connection
4+
string, |compass-short| shows credentials in plaintext by default.
5+
6+
To edit your connection string credentials without exposing your password,
7+
use the :guilabel:`Advanced Connection Options > Authentication` tab on the
8+
|compass-short| connection form.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
.. procedure::
2+
:style: normal
3+
4+
.. step:: Paste your connection string.
5+
6+
If you have the connection string for your deployment available, you can
7+
paste the string directly into the dialog box. You can use either the
8+
:manual:`Standard Connection String Format
9+
</reference/connection-string/#connections-standard-connection-string-format>`
10+
or the :manual:`DNS Seedlist Connection Format
11+
</reference/connection-string/#connections-dns-seedlist>`.
12+
13+
To obtain the connection string for an |service| cluster:
14+
15+
a. Navigate to your |service| :guilabel:`Clusters` view.
16+
17+
#. Click :guilabel:`Connect` for your desired cluster.
18+
19+
#. Click :guilabel:`Connect with MongoDB Compass`.
20+
21+
#. Copy the provided connection string.
22+
23+
.. include:: /includes/fact-hide-connection-string-password.rst
24+
25+
To learn how to format the connection string for a deployment that is not
26+
hosted on |service|, see :manual:`Connection String URI Format </reference/connection-string>`.
27+
28+
.. step:: Connect to your cluster.
29+
30+
Click :guilabel:`Connect` or :guilabel:`Save & Connect` to navigate to the
31+
|compass-short| :doc:`Home Page </instance>`.
32+
33+
The :guilabel:`Save & Connect` button prompts you to save your connection
34+
string as a :ref:`Favorite Connection <favorite-connections>` and then
35+
navigates to the home page.
36+
37+
.. important:: Required Access
38+
39+
Once you are connected to your MongoDB deployment, you may require
40+
specific :manual:`user roles <reference/built-in-roles/>` to access
41+
various |compass-short| features. For more information on the required
42+
roles for |compass-short| features, see :ref:`required-access`.

source/includes/steps-starting-compass-paste-string.yaml

Lines changed: 0 additions & 46 deletions
This file was deleted.

0 commit comments

Comments
 (0)