Navigation

Connect via mongo Shell

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

For MongoDB 3.6 clusters, use the 3.6.0 or later version of the mongo shell with TLS support.

Clients must support TLS to connect to an Atlas cluster.

Clients must support the SNI TLS extension to connect to an Atlas M0 Free Tier or M2/M5 shared starter cluster. MongoDB 3.6 and later shell supports the SNI TLS extension.

To access a cluster, you must connect from an IP address on the Atlas project's IP access list. If you need to add an IP address to the IP access list, you can do so in the Connect dialog. You can also add the IP address from the Network Access tab.

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

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

1

In the Clusters view, click Connect for the cluster to which you want to connect.

2

Choose Connection Type from the set of available buttons.

Info With Circle IconCreated with Sketch.Note
Options Display if Feature Enabled

Atlas displays the connection type options after you enable Private IP for Peering, Private Endpoint, or both. If you haven't enabled either feature, no buttons display and Connection Type defaults to Standard.

Use this connection type for allowed public IP addresses.

3

Add a Connection IP Address

Important With Circle IconCreated with Sketch.Important

Skip this step if Atlas indicates in the Setup connection security step that you have already configured an IP access list entry in your cluster. To manage the IP access list, see Add Entries to the Access List.

Atlas allows standard client connections to the cluster from entries in the project's IP access list. The project IP access list differs from the API access list, which restricts API access to specific IP or CIDR addresses.

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

  • Click Add Your Current IP Address to allow access from your current IP address.
  • Click Add an IP Address to add a single IP address or a CIDR -notated range of addresses.

Provide an optional description for the newly added IP address or CIDR range. Click Add IP Address to add the address to the IP access list.

4
Important With Circle IconCreated with Sketch.Important

Skip this step if Atlas indicates in the Setup connection security step that you have at least one database user configured in your project. To manage existing database users, see Configure Database Users.

To access the cluster, you need a MongoDB user with access to the desired database or databases on the cluster in your project. If your project has no MongoDB users, Atlas prompts you to create a new user with the Atlas Admin role.

  1. Enter the new user's Username
  2. Enter a Password for this new user or click Autogenerate Secure Password.
  3. Click Create Database User to save the user.

Use this user to connect to your cluster in the following step.

Once you have added an IP address to your IP access list and added a database user, click Choose Your Connection Method.

5

Select Connect with the Mongo Shell.

The next screen offers you options to proceed based on whether or not you already have the mongo shell installed on your system.

Select your OS from the dropdown menu.

  1. Download using one of the following options:

    • Click Download Mongo Shell to begin the download.
    • Click Copy download URL to copy a download URL to your clipboard, then either:

      • Use curl to fetch the installer file, or
      • Paste the URL in a browser window.
  2. Double-click the .msi file in Windows Explorer and proceed through the installation wizard.
  3. Add the bin directory to your command path.

    1. Click and select Control Panel.
    2. Click System and Security, then System, then Advanced System Settings.
    3. Click Environment Variables.
    4. Select Path and click Edit.
    5. Add the bin directory where the installer placed your MongoDB executables and click OK.
    6. Step 3 of the Atlas modal displays a copyable connection string. This string includes the name of the MongoDB user that can authenticate with the cluster. Copy this string. To connect as a different MongoDB user, change the --username option.
    7. Paste the mongo command and connection string into your application.

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

Give Feedback