DOCSP-26281 Add protectConnectionStrings option (#471)

* DOCSP-26281 Add protectConnectionStrings option

* add ref

* add to toc

* JA edits

* remove period

* JA nit edits

Author: ajhuh-mdb

source/config-file.txt

@@ -57,6 +57,8 @@ When you configure settings with a configuration file:
 Tasks
 -----
 
+- :ref:`compass-protect-connection-strings`
+
 - :ref:`compass-configure-network-traffic`
 
 - :ref:`specify-read-preference-tags`
@@ -69,5 +71,6 @@ Tasks
    :titlesonly:
 
    /config-file/config-file-options
+   /config-file/protect-connection-strings
    /config-file/restrict-outgoing-connections
    /config-file/specify-read-preference-tags

source/config-file/config-file-options.txt

@@ -61,6 +61,9 @@ You can configure the following settings in a configuration file:
    * - :ref:`networkTraffic <compass-configure-network-traffic>`
      - Configure |compass| to not perform outgoing network operations other 
        than those to the database.
+   
+   * - :ref:`protectConnectionStrings <compass-protect-connection-strings>`
+     - .. include:: /includes/fact-protect-connection-strings.rst 
 
 Example 
 -------

source/config-file/protect-connection-strings.txt

@@ -0,0 +1,86 @@
+.. _compass-protect-connection-strings:
+.. _hide-connection-string-credentials:
+
+==========================================
+Hide Credentials in Your Connection String 
+==========================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+When you paste a connection string into the |compass| connection form, 
+|compass-short| shows credentials in plaintext by default. To hide credentials in 
+the connection string, use the ``protectConnectionStrings`` option. 
+
+About This Task
+---------------
+
+When ``protectConnectionStrings`` is enabled, users cannot perform the following 
+actions: 
+
+- Edit the connection string in the |compass-short| connection form. 
+
+- Copy the connection string in the |compass-short| interface. 
+
+- See the credentials when :ref:`exporting a query <compass-export-query>`.
+
+Procedure
+---------
+
+To hide your your connection string credentials, enable the 
+``protectConnectionStrings`` option. 
+
+You can set the ``protectConnectionStrings`` option in either: 
+
+- The |compass-short| :guilabel:`Settings` panel
+
+- The :ref:`command line <cli-options>`
+
+- A :ref:`configuration file <config-file>`
+
+Command Line Example
+~~~~~~~~~~~~~~~~~~~~
+
+The following command starts |compass-short| from the command line and sets
+the ``--protectConnectionStrings`` option:
+
+.. code-block:: sh
+
+   <path-to-Compass-executable> --protectConnectionStrings
+
+.. note::
+
+  The name and filepath of the |compass-short| executable depend on your
+  operating system.
+
+Configuration File Example
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can specify the |compass-short| configuration file in either EJSON
+or YAML format. The following configurations set the 
+``protectConnectionStrings`` option to ``true``:
+
+EJSON
+`````
+
+.. code-block:: json
+
+   { "protectConnectionStrings": true }
+
+YAML
+````
+
+.. code-block:: yaml
+
+   protectConnectionStrings: true
+
+Learn More
+----------
+
+To learn more about the |compass| configuration file, see
+:ref:`config-file`.

source/connect/connect-from-the-command-line/command-line-options.txt

@@ -106,16 +106,21 @@ value in the :guilabel:`Settings` panel.
 .. option:: --forceConnectionOptions
 
    .. include:: /includes/fact-force-connection-options.rst
+      
+   To learn more, see :ref:`compass-force-connection-options`.
 
 .. option:: --networkTraffic
 
    Configure |compass| to only allow outgoing :ref:`network operations 
    <compass-configure-network-traffic>` to connect to the database. 
 
+   To learn more, see :ref:`compass-configure-network-traffic`.
+
 .. option:: --protectConnectionStrings
 
-   Hide credentials in connection strings. Passwords in connection 
-   strings are displayed as ``*****``. 
+   .. include:: /includes/fact-protect-connection-strings.rst  
+   
+   To learn more, see :ref:`compass-protect-connection-strings`.
 
 .. option:: --theme
 

source/includes/fact-protect-connection-strings.rst

@@ -0,0 +1,2 @@
+Hide credentials in your connection string. Passwords in connection 
+strings are displayed as ``*****``