From e11299c375339ee5852c10dfba4a3abaad6937ec Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Fri, 28 Feb 2025 14:36:03 -0500 Subject: [PATCH 1/4] DOCSP-47271 Mention SOCKS5 Proxy Guide --- source/connection/connection-options.txt | 34 +++++++++++++++++++++++ source/connection/mongoclientsettings.txt | 7 +++++ 2 files changed, 41 insertions(+) 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..3bcca2d23 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 SOCK5 Proxy + + You can use the ``applyToProxySettings()`` method to connect to MongoDB by using + a SOCK5 Proxy. To learn how to use a SOCK5 Proxy and set proxy settings, + see the :ref:`Connect to MongoDB by Using a SOCKS5 Proxy ` + guide. + .. _java-socketsettings-example: Example From 4f95e4e9202a3ab3617415f4647d5bca765cf9fe Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Fri, 28 Feb 2025 14:52:53 -0500 Subject: [PATCH 2/4] edit to note --- source/connection/mongoclientsettings.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/connection/mongoclientsettings.txt b/source/connection/mongoclientsettings.txt index 3bcca2d23..25944c342 100644 --- a/source/connection/mongoclientsettings.txt +++ b/source/connection/mongoclientsettings.txt @@ -528,12 +528,12 @@ to modify the driver's behavior: | | **Default**: The operating system default -.. note:: Connect to MongoDB by using a SOCK5 Proxy +.. note:: Connect to MongoDB by using a SOCKS5 Proxy - You can use the ``applyToProxySettings()`` method to connect to MongoDB by using - a SOCK5 Proxy. To learn how to use a SOCK5 Proxy and set proxy settings, - see the :ref:`Connect to MongoDB by Using a SOCKS5 Proxy ` - guide. + 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: From b093c7b560b6194420de3e2bd3095dd959a42d7d Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Fri, 28 Feb 2025 16:16:26 -0500 Subject: [PATCH 3/4] MW edit --- source/connection/mongoclientsettings.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/connection/mongoclientsettings.txt b/source/connection/mongoclientsettings.txt index 25944c342..0fdae0006 100644 --- a/source/connection/mongoclientsettings.txt +++ b/source/connection/mongoclientsettings.txt @@ -531,7 +531,7 @@ to modify the driver's behavior: .. 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 + 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. From 877283ec22c265dfb39e2e68e6ec1b5cae684100 Mon Sep 17 00:00:00 2001 From: Lindsey Moore Date: Tue, 4 Mar 2025 10:00:01 -0500 Subject: [PATCH 4/4] tech edit --- source/connection/mongoclientsettings.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/connection/mongoclientsettings.txt b/source/connection/mongoclientsettings.txt index 0fdae0006..ea9f56d28 100644 --- a/source/connection/mongoclientsettings.txt +++ b/source/connection/mongoclientsettings.txt @@ -531,7 +531,7 @@ to modify the driver's behavior: .. 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 + 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.