This is an automated email from the ASF dual-hosted git repository.
jbertram pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/activemq-artemis.git
The following commit(s) were added to refs/heads/master by this push:
new 8727467 NO-JIRA document SOCKS proxy support
8727467 is described below
commit 87274675d6172235805210278896d2138f2bb6ec
Author: Justin Bertram <[email protected]>
AuthorDate: Tue Aug 4 11:42:55 2020 -0500
NO-JIRA document SOCKS proxy support
---
docs/user-manual/en/configuring-transports.md | 27 +++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
diff --git a/docs/user-manual/en/configuring-transports.md
b/docs/user-manual/en/configuring-transports.md
index 40f844a..d12bb60 100644
--- a/docs/user-manual/en/configuring-transports.md
+++ b/docs/user-manual/en/configuring-transports.md
@@ -543,3 +543,30 @@ additional properties:
- `httpRequiresSessionId`. If `true` the client will wait after the first call
to receive a session id. Used the http connector is connecting to servlet
acceptor (not recommended)
+
+
+### Configuring Netty SOCKS Proxy
+
+All these parameters are only applicable to a `connector` and/or client URL.
+
+**Note:** Using a loop-back address (e.g. `localhost` or `127.0.0.1`) as the
+target of the `connector` or URL will circumvent the application of these
+configuration properties. In other words, no SOCKS proxy support will be
+configured even if these properties are set.
+
+- `socksEnabled`. Whether or not to enable SOCKS support on the `connector`.
+
+- `socksHost`. The name of the SOCKS server to use.
+
+- `socksPort`. The port of the SOCKS server to use.
+
+- `socksVersion`. The version of SOCKS to use. Must be an integer. Default is
+ `5`.
+
+- `socksUsername`. The username to use when connecting to the `socksHost`.
+
+- `socksPassword`. The password to use when connecting to the `socksHost`. Only
+ applicable if the `socksVersion` is `5`.
+
+- `socksRemoteDNS`. Whether or not to create remote destination socket
+ unresolved and disable DNS resolution. Default is `false`.
