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 or M2/M5 shared starter cluster. The SNI TLS extension is supported by Compass version 1.5 and up.

MongoDB Compass

To complete this procedure you must have MongoDB Compass installed. To install Compass either:

  • Follow the Installation Procedure in the Compass documentation, or
  • Download and install the latest version of Compass using the download links provided in the Atlas Connect dialog. To access these links, click Connect for the cluster you wish to connect to, then click Connect with MongoDB Compass.
Whitelist
To access a cluster, you must connect from an IP address on the Atlas project’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.
MongoDB User

To access a cluster, you must create a MongoDB User with access to the desired database(s) on your Atlas cluster. MongoDB users are separate from Atlas users. MongoDB users have access to MongoDB databases, while Atlas users have access to the Atlas application itself.

You can create a MongoDB user to access to your Atlas cluster in the Connect dialog. You can also add the MongoDB user from the Clusters view.

Connect to Your Cluster

Use the following procedure to connect Compass 1.8 or later versions to your Atlas cluster.

1

Open the Connect dialog.

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

2

Whitelist your connection IP address.

Atlas only allows client connections to the cluster from entries in the project’s whitelist. The project whitelist is distinct from the API whitelist, which restricts API access to specific IP or CIDR addresses.

Note

You can skip this step if Atlas indicates in the Setup Connection Security step that you have already configured a whitelist entry in your cluster. To manage the IP whitelist, see Add Entries to the Whitelist.

If the whitelist is empty, Atlas prompts you to add an IP address to the project’s whitelist. You can either:

  • Click Add Your Current IP Address to whitelist your current IP address.

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

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

You can provide an optional description for the newly added IP address or CIDR range. Click Add IP Address to add the address to the whitelist.

3

Create a MongoDB User.

To access the cluster, you must create a MongoDB user with access to the desired database(s) on the cluster.

Note

You can skip this step if Atlas indicates in the Setup Connection Security step that you have at least one MongoDB user configured in your project. To manage existing MongoDB users, see Add MongoDB Users.

If the project has no MongoDB users, Atlas prompts you to create a new user with the Atlas Admin privilege. Enter the new user’s Username and Password and click Create MongoDB User to save the user. Use this user to connect to your cluster in the following step.

Once you have whitelisted an IP address and added a MongoDB user, click Choose Your Connection Method.

4

Connect with MongoDB Compass.

  1. In the Choose a connection method step, select Connect with MongoDB Compass.

  2. If you have Compass installed, click I have Compass in the ensuing dialog page.

    If you do not have Compass installed, refer to the Prerequisites section.

  3. Choose your version of MongoDB Compass in the dropdown. To check your version of Compass, click About MongoDB Compass in the application.

  4. Copy the connection string presented in the Atlas Connect dialog.

  5. Open MongoDB Compass.

  6. Compass automatically detects the URI connection string in the system clipboard and asks for permission to auto-fill the connection form with the appropriate information. Click Yes.

  7. Fill in the Password field with the password for the user from the connection string. For security purposes, the connection string does not include the password.

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

  8. (Optional) To save this connection for future use, fill in the Favorite Name field with a name for this connection. Click Create Favorite.

    Saved favorite connections appear in the left pane of the Compass Connect window under Favorites.

  9. Click Connect.

See also

For more detailed instructions on connecting to a database using MongoDB Compass, refer to the Connect Page in the Compass documentation.

For Compass 1.7 or earlier versions, 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.

Troubleshooting

If you are experiencing issues connecting to your cluster, see Troubleshoot Connection Issues.