Navigation

Connect via Compass

The Connect dialog for a cluster provides the details to connect to a cluster via Compass.

Prerequisites

TLS/SSL

Clients must have support for TLS/SSL to connect to an Atlas cluster.

Clients must have support for the SNI TLS extension to connect to an Atlas M0 Free Tier cluster.

Whitelist
To access a cluster, you must connect from an IP address on the Atlas group’s IP whitelist. If you need to add an IP address to the whitelist, you can do so in the Connect dialog. You can also add the IP address from the Security tab.

Connect to Your Cluster

Important

This procedure requires Compass 1.8.0 or later. If you are using an earlier version of Compass and cannot update, use the Enter Connection Details Manually procedure instead.

1

Open the Connect dialog.

Go to the Clusters view. Click the Connect button for the cluster to which you wish to connect.

2

From the Connect dialog, review the IP Whitelist.

Atlas only allows client connections to the cluster from entries in the group’s whitelist.

Atlas displays any entries already on the group whitelist in the Connect modal under Check the IP Whitelist. If you do not see the IP address of the machine from which you will run Compass on the list, you can:

  • Click Add Entry to add a single IP address or a CIDR-notated range of addresses.

    For Atlas clusters deployed on Amazon Web Services and using VPC Peering, you can add a Security Group associated with the peer VPC.

  • Click Add Current IP Address to add your current IP address.

  • Click Allow Access From Anywhere to allow access from any IP address.

    Warning

    Using Allow Access From Anywhere results in all clusters in the Atlas group being publically accessible. Consider the security risks of having public-facing MongoDB clusters before using this option.

3

Select Connect Your Application.

  1. Click Copy under Copy the URI Connection String to copy the MongoDB URI connection string.

  2. Open the Compass application. Compass automatically detects the URI connection string in the system clipboard and prompts you to allow it to auto-fill the connection details. Click Yes.

  3. The URI connection string uses a MongoDB user set up for the group as the user to authenticate as. Compass autofills the Username field with that user. Fill in the Password field with the password for the user.

    To connect with a different MongoDB user, update the Username and Password fields with the username and password of a different MongoDB user.

  4. You can optionally fill in the Favorite Name field with a name for the connection. When you use Compass in the future, previous connections appear in the left pane of the Compass Connect window under Favorites.

  5. Click Connect to connect Compass to your cluster.

Alternatively, you can enter your cluster connection into compass manually.

Enter Connection Details Manually

As an alternative to automatically filling in the connection details using a MongoDB URI connection string, you can manually create a new connection in Compass.

To set up a New Connection from Compass to your Atlas cluster, enter the following information in Compass and click Connect:

Field Name Description
Hostname

The hostname of primary for a replica set or the hostname for the mongos for a sharded cluster.

For a replica set, you can locate the primary hostname in the Atlas UI by:

  1. Clicking Clusters,
  2. Clicking the cluster you want to connect to,
  3. Click on the replica set member marked as PRIMARY, and
  4. Copy the hostname of the replica set.

For a sharded cluster, from the Atlas UI click Connect for the cluster and click Connect Your Application. Extract the mongos hostname from the URI connection string.

Make note of the port number of the primary or mongos and use it to fill in the Port field in Compass.

Port The port of the primary for a replica set or the port for the mongos for a sharded cluster.
Authentication Select Username / Password.
Username MongoDB user. The Atlas connection details displays the MongoDB administration user set up for the cluster. You can connect with a different MongoDB user.
Password Password associated with the specified MongoDB user.
Authentication Database Specify "admin".
Replica Set Name The name of the Atlas cluster’s replica set. You can retrieve this by clicking the Connect button for the cluster and selecting Connect Your Application. Extract the replica set name from the URI connection string’s replicaSet value.
Read Preference Specify how Compass directs read operations. Options are Primary, Primary Preferred, Secondary, Secondary Preferred, and Nearest. See /core/read-preference.
SSL Select "Use System CA / Atlas Deployment"
SSH Tunnel Select "Off"
Favorite Name Enter a name for the connection if saving as a favorite.