socks

For the complete MongoDB documentation index, see www.mongodb.com/docs/llms.txt

<!-- Tab options on this page. Append to the .md URL to filter: ?tabs=<id,...> select specific tabs (e.g. ?tabs=nodejs,shell) ?allTabs=true include every tab (no param) default: one tab per tabset

Available tabs: other tabs: proxy-settings, connection-string -->

Connect to MongoDB by Using a SOCKS5 Proxy

Overview

In this guide, you can learn how to connect to MongoDB by using a SOCKS5 proxy. SOCKS5 is a standardized protocol for communicating with network services through a proxy server.

Tip:

To learn more about the SOCKS5 protocol, see the Wikipedia entry on SOCKS.

SOCKS5 Proxy Settings

The proxy settings specify the SOCKS5 proxy server address and your authentication credentials. You can specify these settings in the following ways:

• Include them in your connection URI as parameters.

• On your MongoClientSettings instance, set the Socks5ProxySettings property to an instance of the Socks5ProxySettings class.

The following table describes the SOCKS5 proxy settings:

Example

The following example shows how to connect to a MongoDB deployment by using a SOCKS5 proxy:

Socks5ProxySettings

var settings = new MongoClientSettings.FromConnectionString("<connection URI>");

var proxySettings = new Socks5ProxySettings(
    "<proxy host>", 1, Socks5AuthenticationSettings.UsernamePassword("<username>", "<password>"));
settings.Socks5ProxySettings = proxySettings;

var client = new MongoClient(settings);

API Documentation

To learn more about the methods and types discussed in this guide, see the following API documentation:

• MongoClientSettings

• Socks5ProxySettings

• Socks5AuthenticationSettings