Files
mosquitto/man/common/option-proxy.xml
2025-08-11 23:57:45 +01:00

33 lines
1.3 KiB
XML

<varlistentry xmlns:xlink="http://www.w3.org/1999/xlink">
<term><option>--proxy</option></term>
<listitem>
<para>
Specify a SOCKS5 proxy to connect through. "None" and "username"
authentication types are supported. The <option>socks-url</option>
must be of the form <option>socks5h://[username[:password]@]host[:port]</option>.
The protocol prefix <option>socks5h</option> means that hostnames
are resolved by the proxy. The symbols %25, %3A and %40 are URL
decoded into %, : and @ respectively, if present in the username or
password.
</para>
<para>
If username is not given, then no authentication is attempted.
If the port is not given, then the default of 1080 is used.
</para>
<para>
If the host is given as an IPv6 address, it must be enclosed in
square brackets, e.g. <option>socks5h://[::1]:1080</option>.
Note that square brackets have special meaning in some shells, so
the proxy url may need quoting in double or single quotes.
</para>
<para>
More SOCKS versions may be available in the future, depending on
demand, and will use different protocol prefixes as described in
<citerefentry><refentrytitle><link xlink:href="https://linux.die.net/man/1/curl">curl</link></refentrytitle><manvolnum>1</manvolnum> </citerefentry>.
</para>
</listitem>
</varlistentry>