Skip to content

Commit f2e3aaa

Browse files
authored
DOCSP-29045 reference page updates (#484)
* DOCSP-29045 Update Reference Page with Config File Settings * fix table margin * JA edits :
1 parent 8565df4 commit f2e3aaa

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

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

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,41 @@ You can configure the following settings in a configuration file:
5050

5151
.. list-table::
5252
:header-rows: 1
53-
:widths: 30 70
53+
:widths: 40 60
5454

5555
* - Setting
5656
- Definition
5757

58+
* - autoUpdates
59+
- Allow |compass-short| to periodically check for new updates.
60+
61+
* - :ref:`enableDevtools <compass-enable-dev-tools>`
62+
- Enable Chrome DevTools in |compass-short|.
63+
64+
* - enableMaps
65+
- Allow |compass-short| to make requests to third-party mapping services.
66+
67+
* - :ref:`enableShell <disable-shell>`
68+
- Enable or disable the embedded MongoDB Shell on |compass-short|.
69+
5870
* - :ref:`forceConnectionOptions <compass-force-connection-options>`
5971
- .. include:: /includes/fact-force-connection-options.rst
72+
73+
* - ignoreAdditionalCommandLineFlags
74+
- Allow or disallow additional command-line option flags.
75+
76+
* - installURLHandlers
77+
- Register |compass-short| as a handler for mongodb:// and mongodb+srv://
78+
URLs.
79+
80+
If :guilabel:`Install Compass as URL Protocol Handler` is enabled,
81+
you can open |compass-short| by navigating to a mongodb:// or
82+
mongodb+srv:// URL in your internet browser.
83+
84+
*Available on macOS and Windows.*
85+
86+
* - maxTimeMS
87+
- Specify an upper time limit for all |compass-short| database operations.
6088

6189
* - :ref:`networkTraffic <compass-configure-network-traffic>`
6290
- Configure |compass| to not perform outgoing network operations other
@@ -65,6 +93,21 @@ You can configure the following settings in a configuration file:
6593
* - :ref:`protectConnectionStrings <compass-protect-connection-strings>`
6694
- .. include:: /includes/fact-protect-connection-strings.rst
6795

96+
* - :ref:`readOnly <compass-read-only>`
97+
- Prevent users from performing write operations to your MongoDB deployment
98+
through |compass-short|.
99+
100+
* - :ref:`showKerberosPasswordField <compass-kerberos-password>`
101+
- Show or hide the Kerberos password field on the |compass-short|
102+
connection form.
103+
104+
* - theme
105+
- Specify the |compass| UI theme. The supported themes are ``DARK``,
106+
``LIGHT``, and ``OS_THEME``.
107+
108+
* - trackUsageStatistics
109+
- Allow |compass-short| to send anonymous usage statistics.
110+
68111
Example
69112
-------
70113
To view a sample |compass-short| configuration file, run the following command:

0 commit comments

Comments
 (0)