Skip to content

Commit 2c339c7

Browse files
jocelyn-mendez1Jocelyn Mendez
authored and
jeff-allen-mongo
committed
DOCSP-20678 General connection page (#379)
* DOCSP-20678 general connection tab * DOCSP-20678 general connection tab * DOCSP-20678 general connection tab * DOCSP-20678 general connection tab * DOCSP-20678 general connection tab * DOCSP-20678 general connection tab * DOCSP-20678 general connection tab * DOCSP-20678 general connection tab * DOCSP-20678 testing procedurerst * DOCSP-20678 testing procedurerst * DOCSP-20678 testing procedurerst * DOCSP-20678 testing procedurerst * DOCSP-20678 testing procedurerst * DOCSP-20678 testing procedurerst * DOCSP-20678 nit changes * DOCSP-20678 title renaming Co-authored-by: Jocelyn Mendez <jocelyn.mendez@Jocelyns-MacBook-Pro.local>
1 parent b5c549b commit 2c339c7

File tree

6 files changed

+95
-15
lines changed

6 files changed

+95
-15
lines changed

‎source/connect/advanced-connection.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _advanced-connection-tab:
22

3-
===================
4-
Advanced Connection
5-
===================
3+
=======================
4+
Advanced Connection Tab
5+
=======================
66

77
.. default-domain:: mongodb
88

@@ -11,3 +11,4 @@ Advanced Connection
1111
:backlinks: none
1212
:depth: 1
1313
:class: singlecol
14+

‎source/connect/authentication-connection.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _authentication-connection-tab:
22

3-
=========================
4-
Authentication Connection
5-
=========================
3+
=============================
4+
Authentication Connection Tab
5+
=============================
66

77
.. default-domain:: mongodb
88

@@ -11,3 +11,5 @@ Authentication Connection
1111
:backlinks: none
1212
:depth: 1
1313
:class: singlecol
14+
15+

‎source/connect/general-connection.txt

Lines changed: 80 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _general-connection-tab:
22

3-
==================
4-
General Connection
5-
==================
3+
======================
4+
General Connection Tab
5+
======================
66

77
.. default-domain:: mongodb
88

@@ -11,3 +11,80 @@ General Connection
1111
:backlinks: none
1212
:depth: 1
1313
:class: singlecol
14+
15+
The :guilabel:`General` connection tab allows you to select a
16+
:guilabel:`Connection String Scheme` and configure the hostname or hosts
17+
used to connect to your MongoDB deployment.
18+
19+
Procedure
20+
---------
21+
22+
.. procedure::
23+
:style: normal
24+
25+
.. step:: Click :guilabel:`Advanced Connection Options`.
26+
27+
.. figure:: /images/compass/advanced-connection-options.png
28+
:figwidth: 690px
29+
:alt: New Advanced Connection Options
30+
31+
.. step:: Click the :guilabel:`General` tab.
32+
33+
.. procedure::
34+
:style: connected
35+
36+
.. step:: Select a Connection String Scheme.
37+
38+
You can select one of the following options:
39+
40+
.. list-table::
41+
:header-rows: 1
42+
:class: border-table
43+
44+
* - Connection String Scheme
45+
- Definition
46+
47+
* - mongodb
48+
- :manual:`Standard Connection String Format </reference/connection-string/>`.
49+
The standard format of the MongoDB connection URI is used to
50+
connect to a MongoDB deployment by specifying its hosts directly.
51+
52+
* - mongodb+srv
53+
- :manual:`DNS Seed List Connection Format
54+
</reference/connection-string/#dns-seed-list-connection-format>`.
55+
The ``+srv`` indicates to |compass| that the hostname that follows
56+
corresponds to a DNS SRV record.
57+
58+
.. step:: Enter a Hostname.
59+
60+
In the :guilabel:`Host` field, enter the hosts or hostname of the server
61+
where the deployment is running.
62+
63+
If you are running your deployment locally, this value is ``localhost``.
64+
If you are connecting to an Atlas cluster, see
65+
:atlas:`Connect to Database Deployment </connect-to-database-deployment/>`
66+
for Atlas-specific guidance on how to connect with |compass-short|.
67+
68+
If you are not sure of your hostname, contact your Database
69+
Administrator for information.
70+
71+
.. step:: (Optional) Enable Direct Connection.
72+
73+
When you use the ``mongodb`` Connection String Scheme, you have the
74+
option to enable a :driver:`Direct Connection
75+
</node/current/fundamentals/connection/#direct-connection>`. When you
76+
enable this setting, |compass-short| runs all operations on the specified
77+
host.
78+
79+
.. important::
80+
When you specify ``directConnection`` and connect to a secondary member
81+
of a replica set, your write operations fail because it is not the
82+
primary member.
83+
84+
.. step:: (Optional) For advanced connection configuration options, click the :ref:`Advanced <advanced-connection-tab>` tab.
85+
86+
.. step:: Click Connect.
87+
88+
.. seealso::
89+
90+
To disconnect from your deployment, see :ref:`<disconnect-tab>`.

‎source/connect/ssh-connection.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _ssh-connection:
22

3-
=====================
4-
SSH Tunnel Connection
5-
=====================
3+
=========================
4+
SSH Tunnel Connection Tab
5+
=========================
66

77
.. default-domain:: mongodb
88

‎source/connect/tls-ssl-connection.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _tls-ssl-tab:
22

3-
==================
4-
TLS/SSL Connection
5-
==================
3+
======================
4+
TLS/SSL Connection Tab
5+
======================
66

77
.. default-domain:: mongodb
88

‎source/images/compass/advanced-connection-options.png

295 KB
Loading

0 commit comments

Comments
 (0)