Skip to content

Commit 0ad5116

Browse files
DOCSP-2575 - Adding note about firewall reqs
1 parent 9787f63 commit 0ad5116

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

source/faq.txt

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,27 @@ or 60 seconds), but the schema analysis of the documents takes longer
119119
than expected (due to complex, large documents), Compass gives you the
120120
option to abort the analysis step and show the partial results.
121121

122+
Why are some features of |compass| not working?
123+
-----------------------------------------------
124+
125+
If you can connect to your MongoDB instance using |compass| but
126+
some features do not work as expected, your system firewall may be
127+
blocking network requests required by |compass|. |compass| features
128+
which require incoming connections from external sources include:
129+
130+
- Third party mapping services such as Mapbox
131+
132+
- Intercom
133+
134+
- Bugsnag for error reporting
135+
136+
To fix this issue, configure your system firewall to allow incoming
137+
connections for |compass|. Ensure ports ``80`` and ``443`` are open
138+
between |compass| and the host for the MongoDB Instance to which
139+
Compass connects.
140+
141+
.. include:: /includes/fact-isolated-edition-firewall.rst
142+
122143
.. _faq-privacy-settings:
123144

124145
How do I view and modify my Privacy Settings?
@@ -148,3 +169,4 @@ selected, |compass| is allowed to make requests to a third-party
148169
mapping service.
149170

150171
.. include:: /includes/fact-isolated-ver-third-party-mapping.rst
172+
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. note::
2+
3+
:ref:`Compass Isolated Edition <compass-isolated>` restricts network
4+
requests to :abbr:`TLS (Transport Layer Security)`-encrypted
5+
:abbr:`TCP (Transmission Control Protocol)` connections to the server
6+
chosen on the :ref:`Connect <connect-run-compass>` screen. All other
7+
outbound connections are not permitted in this edition, meaning no
8+
additional firewall configuration is required when running Compass
9+
Isolated Edition.

source/install.txt

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,3 +120,20 @@ To download and install on Red Hat Enterprise Linux:
120120
.. code-block:: sh
121121

122122
sudo DEBUG=* mongodb-compass;
123+
124+
Compass Firewall Requirements
125+
-----------------------------
126+
127+
Certain features of |compass|, such as third-party mapping services and
128+
Intercom, require inbound connections from external sources to
129+
function. In some instances, users have reported issues with their
130+
system firewall blocking these network requests and thereby limiting
131+
|compass| functionalities. To fix this issue, configure your system
132+
firewall to allow incoming connections for |compass|.
133+
134+
.. important::
135+
136+
Ensure ports ``80`` and ``443`` are open between |compass| and the
137+
host for the MongoDB Instance to which Compass connects.
138+
139+
.. include:: /includes/fact-isolated-edition-firewall.rst

0 commit comments

Comments
 (0)