diff --git a/source/connection/connection-options.txt b/source/connection/connection-options.txt index 517b9b842..e2855d376 100644 --- a/source/connection/connection-options.txt +++ b/source/connection/connection-options.txt @@ -306,6 +306,40 @@ parameters of the connection URI to specify the behavior of the client. | **Default**: ``mongodb`` + * - **proxyHost** + - string + - Specifies the SOCKS5 proxy IPv4 address, IPv6 address, or hostname. + You must provide this value to connect to a SOCKS5 proxy. + + | To learn how to connect to a SOCKS5 proxy, see the :ref:`Connect to + MongoDB by Using a SOCKS5 Proxy ` guide. + + | **Default**: ``null`` + + * - **proxyPort** + - non-negative integer + - Specifies the TCP port number of the SOCKS5 proxy server. + + | **Default**: ``1080`` when you set ``proxyHost`` + + * - **proxyUsername** + - string + - Specifies the username for authentication to the SOCKS5 proxy server. + The driver ignores ``null`` and empty string values for this setting. + The driver requires that you pass values for both ``proxyUsername`` + and ``proxyPassword`` or that you omit both values. + + | **Default**: ``null`` + + * - **proxyPassword** + - string + - Specifies the password for authentication to the SOCKS5 proxy server. + The driver ignores ``null`` and empty string values for this setting. + The driver requires that you pass values for both ``proxyUsername`` + and ``proxyPassword`` or that you omit both values. + + | **Default**: ``null`` + For a complete list of options, see the `ConnectionString <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ConnectionString.html>`__ API documentation. diff --git a/source/connection/mongoclientsettings.txt b/source/connection/mongoclientsettings.txt index 6aa860b71..ea9f56d28 100644 --- a/source/connection/mongoclientsettings.txt +++ b/source/connection/mongoclientsettings.txt @@ -528,6 +528,13 @@ to modify the driver's behavior: | | **Default**: The operating system default +.. note:: Connect to MongoDB by using a SOCKS5 Proxy + + You can chain the ``applyToProxySettings()`` method to your socket settings to + connect to MongoDB by using a SOCKS5 proxy. To learn how to use a SOCKS5 proxy + and set proxy settings, see the :ref:`Connect to MongoDB by Using a SOCKS5 Proxy + ` guide. + .. _java-socketsettings-example: Example