Skip to content

Commit 5c54986

Browse files
committed
reviewer changes
1 parent d2cf6d7 commit 5c54986

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

source/settings/config-file.txt

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,24 @@ Settings
131131
with. For more information on connecting to your deployment with a
132132
proxy, see :ref:`ssh-connection`.
133133

134-
You must pass either a URL or a DevtoolsProxyOptions object as JSON
135-
for the Proxy setting. You can also set the Proxy setting to an empty
136-
string.
134+
You must pass either a URL or a ``DevtoolsProxyOptions`` object as JSON
135+
for the Proxy setting. A ``DevtoolsProxyOptions`` object takes the following
136+
format:
137+
138+
.. code-block::
139+
140+
{
141+
proxy?: string;
142+
noProxyHosts?: string;
143+
useEnvironmentVariableProxies?: boolean;
144+
sshOptions?: {
145+
identityKeyFile?: string;
146+
identityKeyPassphrase?: string;
147+
};
148+
}
149+
150+
If you set ``proxy`` to an empty string, no
151+
proxy will be used.
137152

138153
* - :ref:`readOnly <compass-read-only>`
139154
- Prevent users from performing write operations to your MongoDB deployment

0 commit comments

Comments
 (0)