File tree Expand file tree Collapse file tree 2 files changed +41
-0
lines changed Expand file tree Collapse file tree 2 files changed +41
-0
lines changed Original file line number Diff line number Diff line change @@ -306,6 +306,40 @@ parameters of the connection URI to specify the behavior of the client.
306306
307307 | **Default**: ``mongodb``
308308
309+ * - **proxyHost**
310+ - string
311+ - Specifies the SOCKS5 proxy IPv4 address, IPv6 address, or hostname.
312+ You must provide this value to connect to a SOCKS5 proxy.
313+
314+ | To learn how to connect to a SOCKS5 proxy, see the :ref:`Connect to
315+ MongoDB by Using a SOCKS5 Proxy <java-connect-socks>` guide.
316+
317+ | **Default**: ``null``
318+
319+ * - **proxyPort**
320+ - non-negative integer
321+ - Specifies the TCP port number of the SOCKS5 proxy server.
322+
323+ | **Default**: ``1080`` when you set ``proxyHost``
324+
325+ * - **proxyUsername**
326+ - string
327+ - Specifies the username for authentication to the SOCKS5 proxy server.
328+ The driver ignores ``null`` and empty string values for this setting.
329+ The driver requires that you pass values for both ``proxyUsername``
330+ and ``proxyPassword`` or that you omit both values.
331+
332+ | **Default**: ``null``
333+
334+ * - **proxyPassword**
335+ - string
336+ - Specifies the password for authentication to the SOCKS5 proxy server.
337+ The driver ignores ``null`` and empty string values for this setting.
338+ The driver requires that you pass values for both ``proxyUsername``
339+ and ``proxyPassword`` or that you omit both values.
340+
341+ | **Default**: ``null``
342+
309343For a complete list of options, see the
310344`ConnectionString <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ConnectionString.html>`__
311345API documentation.
Original file line number Diff line number Diff line change @@ -528,6 +528,13 @@ to modify the driver's behavior:
528528 |
529529 | **Default**: The operating system default
530530
531+ .. note:: Connect to MongoDB by using a SOCKS5 Proxy
532+
533+ You can chain the ``applyToProxySettings()`` method to your socket settings to
534+ connect to MongoDB by using a SOCKS5 proxy. To learn how to use a SOCKS5 proxy
535+ and set proxy settings, see the :ref:`Connect to MongoDB by Using a SOCKS5 Proxy
536+ <java-connect-socks>` guide.
537+
531538.. _java-socketsettings-example:
532539
533540Example
You can’t perform that action at this time.
0 commit comments