Skip to content

Commit 7710cb9

Browse files
DOCSP-45732-add-proxy-setting-compass-config (#716)
* DOCSP-45732-add-proxy-setting-compass-config * capitalization * wording * reviewer changes * update code ex * reviewer changes * standardize monospace * remove ref to irrelevant data type name * reviewer changes * change code format * reviewer changes
1 parent 44f2625 commit 7710cb9

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

source/settings/config-file.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,22 @@ Settings
126126
option but doesn't prevent users from manually enabling the
127127
option with the :guilabel:`Edit connection string` toggle.
128128

129+
* - proxy
130+
- Enables you to specify or enforce the use of a proxy to connect
131+
to your deployment. For more information on connecting to your
132+
deployment with a proxy, see :ref:`ssh-connection`.
133+
134+
You must pass either a URL or the following format:
135+
136+
.. code-block::
137+
138+
{
139+
"proxy": "string",
140+
"noProxyHosts": "string"
141+
}
142+
143+
If you set ``proxy`` to an empty string, Compass does not use a proxy.
144+
129145
* - :ref:`readOnly <compass-read-only>`
130146
- Prevent users from performing write operations to your MongoDB deployment
131147
through |compass-short|.

0 commit comments

Comments
 (0)