Skip to content

Commit 8f8ffd9

Browse files
(DOCSP-25415): networkTraffic config option (#443)
* (DOCSP-25415): networkTraffic config option * edits * learn more * fix toc * restore config file page * review edits * remove extra config file page * fix folder structure * reorder TOC
1 parent 6e3c9c0 commit 8f8ffd9

File tree

4 files changed

+79
-1
lines changed

4 files changed

+79
-1
lines changed

source/config-file.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,5 @@ To see how to configure specific settings, see :ref:`Compass Configuration File
6363
.. toctree::
6464
:titlesonly:
6565

66-
/config-settings/config-file-options
66+
/config-file/restrict-outgoing-connections
67+
/config-file/config-file-options
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
.. _compass-configure-network-traffic:
2+
3+
==================================
4+
Block Outgoing Network Connections
5+
==================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
You can configure |compass| to not perform outgoing network operations
16+
other than those to the database. This lets you configure any
17+
:ref:`edition <compass-feature-table>` of |compass-short| to restrict
18+
outgoing connections in the same way :ref:`Compass Isolated Edition
19+
<compass-faq-isolated>` restricts connections.
20+
21+
Consideration
22+
-------------
23+
24+
When you block outgoing network connections, |compass-short| can't use
25+
third-party mapping services in :ref:`schema visualizations
26+
<schema-tab>`.
27+
28+
Procedure
29+
---------
30+
31+
To block outgoing network operations, disable the ``networkTraffic``
32+
configuration option. You can set configuration options in either a
33+
command line option or :ref:`configuration file <config-file>` option.
34+
35+
Command Line Example
36+
~~~~~~~~~~~~~~~~~~~~
37+
38+
The following command starts |compass| from the command line and sets
39+
the ``--no-networkTraffic`` option:
40+
41+
.. code-block:: sh
42+
43+
<path-to-Compass-executable> --no-networkTraffic
44+
45+
.. note::
46+
47+
The name and filepath of the |compass-short| executable depend on your
48+
operating system.
49+
50+
Configuration File Example
51+
~~~~~~~~~~~~~~~~~~~~~~~~~~
52+
53+
You can specify the |compass-short| configuration file in either EJSON
54+
or YAML format. The following configurations set the ``networkTraffic``
55+
option to ``false``:
56+
57+
EJSON
58+
`````
59+
60+
.. code-block:: json
61+
62+
{ "networkTraffic": false }
63+
64+
YAML
65+
````
66+
67+
.. code-block:: yaml
68+
69+
networkTraffic: false
70+
71+
Learn More
72+
----------
73+
74+
To learn more about the |compass| configuration file, see
75+
:ref:`config-file`.

source/faq.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ FAQ
1212
:depth: 1
1313
:class: singlecol
1414

15+
.. _compass-faq-isolated:
16+
1517
What is the Compass Isolated Edition?
1618
-------------------------------------
1719

0 commit comments

Comments
 (0)