mirror of
https://github.com/3proxy/3proxy.git
synced 2026-04-19 18:50:12 +08:00
Add unix sockets to man
This commit is contained in:
parent
878a432481
commit
2fd536781f
@ -101,7 +101,13 @@ smtpp</b> SMTP proxy (default port 25) <b><br>
|
||||
ftppr</b> FTP proxy (default port 21) <b><br>
|
||||
admin</b> Web interface (default port 80) <b><br>
|
||||
dnspr</b> caching DNS proxy (default port 53) <b><br>
|
||||
tcppm</b> TCP portmapper <b><br>
|
||||
tcppm</b> TCP portmapper. Destination address (DSTADDR) can
|
||||
be a Unix domain socket using the syntax
|
||||
<i>unix:/path/to/socket</i> (e.g., tcppm 8080
|
||||
unix:/var/run/app.sock 0). On Linux, abstract sockets use
|
||||
<i>unix:@socketname</i> syntax. When using Unix socket
|
||||
destination, the port number is ignored but must be
|
||||
specified for syntax compatibility. <b><br>
|
||||
udppm</b> UDP portmapper</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">Options: <b><br>
|
||||
@ -172,7 +178,9 @@ system will decide which address to use in accordance with
|
||||
the routing table. <b><br>
|
||||
-i</b> Internal address. IP address the proxy accepts
|
||||
connections to. By default, connections to any interface are
|
||||
accepted. <b><br>
|
||||
accepted. Unix domain sockets can be specified with
|
||||
<i>-iunix:/path/to/socket</i> syntax. On Linux, abstract
|
||||
sockets use <i>-iunix:@socketname</i> syntax. <b><br>
|
||||
-N</b> (for socks) External NAT address 3proxy reports to
|
||||
client for BIND and UDPASSOC By default external address is
|
||||
reported. It’s only useful in the case of IP-IP NAT
|
||||
@ -447,7 +455,14 @@ connection.</p>
|
||||
sets ip address of internal interface. This IP address will
|
||||
be used to bind gateways. Alternatively you can use -i
|
||||
option for individual gateways. Since 0.8 version, IPv6
|
||||
address may be used.</p>
|
||||
address may be used. <br>
|
||||
Unix domain sockets are supported with the syntax
|
||||
<i>unix:/path/to/socket</i> (e.g., internal
|
||||
unix:/var/run/3proxy.sock). On Linux, abstract (fileless)
|
||||
Unix sockets are supported with the syntax
|
||||
<i>unix:@socketname</i> (e.g., internal unix:@3proxy). When
|
||||
using Unix sockets, the socket file is automatically created
|
||||
and removed on service start/stop.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>external</b>
|
||||
<ipaddr> <br>
|
||||
@ -699,7 +714,15 @@ special case of local redirection, it works only with
|
||||
redirected to different service, <b>ftp</b> locally
|
||||
redirects to <b>ftppr pop3</b> locally redirects to <b>pop3p
|
||||
http</b> locally redirects to <b>proxy admin</b> locally
|
||||
redirects to the admin -s service.</p>
|
||||
redirects to the admin -s service. <br>
|
||||
Unix domain sockets can be used instead of IP address with
|
||||
the syntax <i>unix:/path/to/socket</i> (e.g., parent 1000
|
||||
socks5 unix:/var/run/parent.sock 1080). On Linux, abstract
|
||||
(fileless) Unix sockets are supported with
|
||||
<i>unix:@socketname</i> syntax (e.g., parent 1000 http
|
||||
unix:@parent.proxy 3128). When using Unix sockets, the port
|
||||
number is ignored but must be specified for syntax
|
||||
compatibility.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">Main purpose of
|
||||
local redirections is to have the requested resource (URL or
|
||||
|
||||
@ -128,7 +128,11 @@ accordance with the routing table.</p></td></tr>
|
||||
|
||||
<p style="margin-top: 1em">Internal address. IP address the
|
||||
proxy accepts connections to. By default, connections to any
|
||||
interface are accepted. It´s usually unsafe.</p></td></tr>
|
||||
interface are accepted. It´s usually unsafe. Unix
|
||||
domain sockets can be specified with
|
||||
<i>-iunix:/path/to/socket</i> syntax (e.g.,
|
||||
-iunix:/var/run/ftppr.sock). On Linux, abstract sockets use
|
||||
<i>-iunix:@socketname</i> syntax.</p></td></tr>
|
||||
<tr valign="top" align="left">
|
||||
<td width="6%"></td>
|
||||
<td width="3%">
|
||||
|
||||
@ -128,7 +128,11 @@ accordance with the routing table.</p></td></tr>
|
||||
|
||||
<p style="margin-top: 1em">Internal address. IP address the
|
||||
proxy accepts connections to. By default, connections to any
|
||||
interface are accepted. It´s usually unsafe.</p></td></tr>
|
||||
interface are accepted. It´s usually unsafe. Unix
|
||||
domain sockets can be specified with
|
||||
<i>-iunix:/path/to/socket</i> syntax (e.g.,
|
||||
-iunix:/var/run/pop3p.sock). On Linux, abstract sockets use
|
||||
<i>-iunix:@socketname</i> syntax.</p></td></tr>
|
||||
<tr valign="top" align="left">
|
||||
<td width="6%"></td>
|
||||
<td width="3%">
|
||||
|
||||
@ -127,7 +127,11 @@ accordance with the routing table.</p></td></tr>
|
||||
|
||||
<p style="margin-top: 1em">Internal address. IP address the
|
||||
proxy accepts connections to. By default, connections to any
|
||||
interface are accepted. It´s usually unsafe.</p></td></tr>
|
||||
interface are accepted. It´s usually unsafe. Unix
|
||||
domain sockets can be specified with
|
||||
<i>-iunix:/path/to/socket</i> syntax (e.g.,
|
||||
-iunix:/var/run/proxy.sock). On Linux, abstract sockets use
|
||||
<i>-iunix:@socketname</i> syntax.</p></td></tr>
|
||||
<tr valign="top" align="left">
|
||||
<td width="6%"></td>
|
||||
<td width="4%">
|
||||
|
||||
@ -128,7 +128,11 @@ accordance with the routing table.</p></td></tr>
|
||||
|
||||
<p style="margin-top: 1em">Internal address. IP address the
|
||||
proxy accepts connections to. By default, connections to any
|
||||
interface are accepted. It´s usually unsafe.</p></td></tr>
|
||||
interface are accepted. It´s usually unsafe. Unix
|
||||
domain sockets can be specified with
|
||||
<i>-iunix:/path/to/socket</i> syntax (e.g.,
|
||||
-iunix:/var/run/smtpp.sock). On Linux, abstract sockets use
|
||||
<i>-iunix:@socketname</i> syntax.</p></td></tr>
|
||||
<tr valign="top" align="left">
|
||||
<td width="6%"></td>
|
||||
<td width="3%">
|
||||
|
||||
@ -162,7 +162,11 @@ and does not work with port translation.</p></td></tr>
|
||||
|
||||
<p style="margin-top: 1em">Internal address. IP address the
|
||||
proxy accepts connections to. By default, connections to any
|
||||
interface are accepted. It´s usually unsafe.</p></td></tr>
|
||||
interface are accepted. It´s usually unsafe. Unix
|
||||
domain sockets can be specified with
|
||||
<i>-iunix:/path/to/socket</i> syntax (e.g.,
|
||||
-iunix:/var/run/socks.sock). On Linux, abstract sockets use
|
||||
<i>-iunix:@socketname</i> syntax.</p></td></tr>
|
||||
<tr valign="top" align="left">
|
||||
<td width="6%"></td>
|
||||
<td width="4%">
|
||||
|
||||
@ -116,7 +116,11 @@ accordance with the routing table.</p></td></tr>
|
||||
|
||||
<p style="margin-top: 1em">Internal address. IP address the
|
||||
proxy accepts connections to. By default, connections to any
|
||||
interface are accepted. It´s usually unsafe.</p></td></tr>
|
||||
interface are accepted. It´s usually unsafe. Unix
|
||||
domain sockets can be specified with
|
||||
<i>-iunix:/path/to/socket</i> syntax (e.g.,
|
||||
-iunix:/var/run/tcppm.sock). On Linux, abstract sockets use
|
||||
<i>-iunix:@socketname</i> syntax.</p></td></tr>
|
||||
<tr valign="top" align="left">
|
||||
<td width="6%"></td>
|
||||
<td width="3%">
|
||||
@ -160,12 +164,18 @@ connections on</p>
|
||||
<p style="margin-left:6%;"><i>remote_host</i></p>
|
||||
|
||||
<p style="margin-left:15%;">- IP address of the host the
|
||||
connection is forwarded to</p>
|
||||
connection is forwarded to. Unix domain sockets can be
|
||||
specified with the syntax <i>unix:/path/to/socket</i> (e.g.,
|
||||
unix:/var/run/app.sock). On Linux, abstract (fileless) Unix
|
||||
sockets use the syntax <i>unix:@socketname</i> (e.g.,
|
||||
unix:@app.socket).</p>
|
||||
|
||||
<p style="margin-left:6%;"><i>remote_port</i></p>
|
||||
|
||||
<p style="margin-left:15%;">- remote port the connection is
|
||||
forwarded to</p>
|
||||
forwarded to. Ignored when using Unix socket destination,
|
||||
but must be specified (use any positive value) for syntax
|
||||
compatibility.</p>
|
||||
|
||||
<h2>CLIENTS
|
||||
<a name="CLIENTS"></a>
|
||||
|
||||
@ -132,7 +132,11 @@ accordance with the routing table.</p></td></tr>
|
||||
|
||||
<p style="margin-top: 1em">Internal address. IP address the
|
||||
proxy accepts connections to. By default, connections to any
|
||||
interface are accepted. It´s usually unsafe.</p></td></tr>
|
||||
interface are accepted. It´s usually unsafe. Unix
|
||||
domain sockets can be specified with
|
||||
<i>-iunix:/path/to/socket</i> syntax (e.g.,
|
||||
-iunix:/var/run/tlspr.sock). On Linux, abstract sockets use
|
||||
<i>-iunix:@socketname</i> syntax.</p></td></tr>
|
||||
<tr valign="top" align="left">
|
||||
<td width="6%"></td>
|
||||
<td width="4%">
|
||||
|
||||
@ -87,7 +87,7 @@ SOCKS 4/4.5/5 proxy (default port 1080)
|
||||
SNI proxy (destination address is taken from TLS handshake), may be used to redirect any TLS-based traffic
|
||||
.br
|
||||
.B auto
|
||||
Proxy with protocol autoselection between proxy / socks / tlspr
|
||||
Proxy with protocol autoselection between proxy / socks / tlspr
|
||||
.br
|
||||
.B pop3p
|
||||
POP3 proxy (default port 110)
|
||||
@ -105,7 +105,13 @@ Web interface (default port 80)
|
||||
caching DNS proxy (default port 53)
|
||||
.br
|
||||
.B tcppm
|
||||
TCP portmapper
|
||||
TCP portmapper. Destination address (DSTADDR) can be a Unix domain socket
|
||||
using the syntax
|
||||
.I unix:/path/to/socket
|
||||
(e.g., tcppm 8080 unix:/var/run/app.sock 0). On Linux, abstract sockets use
|
||||
.I unix:@socketname
|
||||
syntax. When using Unix socket destination, the port number is ignored
|
||||
but must be specified for syntax compatibility.
|
||||
.br
|
||||
.B udppm
|
||||
UDP portmapper
|
||||
@ -180,7 +186,12 @@ with the routing table.
|
||||
.br
|
||||
.B -i
|
||||
Internal address. IP address the proxy accepts connections to.
|
||||
By default, connections to any interface are accepted.
|
||||
By default, connections to any interface are accepted.
|
||||
Unix domain sockets can be specified with
|
||||
.I -iunix:/path/to/socket
|
||||
syntax. On Linux, abstract sockets use
|
||||
.I -iunix:@socketname
|
||||
syntax.
|
||||
.br
|
||||
.B -N
|
||||
(for socks) External NAT address 3proxy reports to client for BIND and UDPASSOC
|
||||
@ -513,6 +524,14 @@ http://dial.right.now/ from browser to set up connection.
|
||||
sets ip address of internal interface. This IP address will be used
|
||||
to bind gateways. Alternatively you can use -i option for individual
|
||||
gateways. Since 0.8 version, IPv6 address may be used.
|
||||
.br
|
||||
Unix domain sockets are supported with the syntax
|
||||
.I unix:/path/to/socket
|
||||
(e.g., internal unix:/var/run/3proxy.sock). On Linux, abstract (fileless)
|
||||
Unix sockets are supported with the syntax
|
||||
.I unix:@socketname
|
||||
(e.g., internal unix:@3proxy). When using Unix sockets, the socket file
|
||||
is automatically created and removed on service start/stop.
|
||||
|
||||
.br
|
||||
.B external
|
||||
@ -795,7 +814,7 @@ If port is zero, it\'s taken from original request, only IP is changed.
|
||||
If both IP and port are zero - it\'s a special case of local redirection,
|
||||
it works only with
|
||||
.B socks
|
||||
proxy. In case of local redirection request is redirected to different service,
|
||||
proxy. In case of local redirection request is redirected to different service,
|
||||
.B ftp
|
||||
locally redirects to
|
||||
.B ftppr
|
||||
@ -807,6 +826,14 @@ locally redirects to
|
||||
.B proxy
|
||||
.B admin
|
||||
locally redirects to the admin -s service.
|
||||
.br
|
||||
Unix domain sockets can be used instead of IP address with the syntax
|
||||
.I unix:/path/to/socket
|
||||
(e.g., parent 1000 socks5 unix:/var/run/parent.sock 1080). On Linux,
|
||||
abstract (fileless) Unix sockets are supported with
|
||||
.I unix:@socketname
|
||||
syntax (e.g., parent 1000 http unix:@parent.proxy 3128). When using Unix
|
||||
sockets, the port number is ignored but must be specified for syntax compatibility.
|
||||
|
||||
.br
|
||||
Main purpose of local redirections is to have the requested resource
|
||||
|
||||
@ -36,6 +36,11 @@ with the routing table.
|
||||
.B -i
|
||||
Internal address. IP address the proxy accepts connections to.
|
||||
By default, connections to any interface are accepted. It\'s usually unsafe.
|
||||
Unix domain sockets can be specified with
|
||||
.I -iunix:/path/to/socket
|
||||
syntax (e.g., -iunix:/var/run/ftppr.sock). On Linux, abstract sockets use
|
||||
.I -iunix:@socketname
|
||||
syntax.
|
||||
.TP
|
||||
.B -h
|
||||
Default destination. It's used if the target address is not specified by the user.
|
||||
|
||||
@ -36,6 +36,11 @@ with the routing table.
|
||||
.B -i
|
||||
Internal address. IP address the proxy accepts connections to.
|
||||
By default, connections to any interface are accepted. It\'s usually unsafe.
|
||||
Unix domain sockets can be specified with
|
||||
.I -iunix:/path/to/socket
|
||||
syntax (e.g., -iunix:/var/run/pop3p.sock). On Linux, abstract sockets use
|
||||
.I -iunix:@socketname
|
||||
syntax.
|
||||
.TP
|
||||
.B -p
|
||||
Port. Port proxy listens for incoming connections. Default is 110.
|
||||
|
||||
@ -34,6 +34,11 @@ with the routing table.
|
||||
.B -i
|
||||
Internal address. IP address the proxy accepts connections to.
|
||||
By default, connections to any interface are accepted. It\'s usually unsafe.
|
||||
Unix domain sockets can be specified with
|
||||
.I -iunix:/path/to/socket
|
||||
syntax (e.g., -iunix:/var/run/proxy.sock). On Linux, abstract sockets use
|
||||
.I -iunix:@socketname
|
||||
syntax.
|
||||
.TP
|
||||
.B -a
|
||||
Anonymous. Hide information about client.
|
||||
|
||||
@ -36,6 +36,11 @@ with the routing table.
|
||||
.B -i
|
||||
Internal address. IP address the proxy accepts connections to.
|
||||
By default, connections to any interface are accepted. It\'s usually unsafe.
|
||||
Unix domain sockets can be specified with
|
||||
.I -iunix:/path/to/socket
|
||||
syntax (e.g., -iunix:/var/run/smtpp.sock). On Linux, abstract sockets use
|
||||
.I -iunix:@socketname
|
||||
syntax.
|
||||
.TP
|
||||
.B -p
|
||||
Port. Port proxy listens for incoming connections. Default is 25.
|
||||
|
||||
@ -49,6 +49,11 @@ of IP-IP NAT and does not work with port translation.
|
||||
.B -i
|
||||
Internal address. IP address the proxy accepts connections to.
|
||||
By default, connections to any interface are accepted. It\'s usually unsafe.
|
||||
Unix domain sockets can be specified with
|
||||
.I -iunix:/path/to/socket
|
||||
syntax (e.g., -iunix:/var/run/socks.sock). On Linux, abstract sockets use
|
||||
.I -iunix:@socketname
|
||||
syntax.
|
||||
.TP
|
||||
.B -p
|
||||
Port. Port proxy listens for incoming connections. Default is 1080.
|
||||
|
||||
17
man/tcppm.8
17
man/tcppm.8
@ -31,6 +31,11 @@ with the routing table.
|
||||
.B -i
|
||||
Internal address. IP address the proxy accepts connections to.
|
||||
By default, connections to any interface are accepted. It\'s usually unsafe.
|
||||
Unix domain sockets can be specified with
|
||||
.I -iunix:/path/to/socket
|
||||
syntax (e.g., -iunix:/var/run/tcppm.sock). On Linux, abstract sockets use
|
||||
.I -iunix:@socketname
|
||||
syntax.
|
||||
.TP
|
||||
.B -l
|
||||
Log. By default logging is to stdout. If
|
||||
@ -50,10 +55,18 @@ crashes.
|
||||
- port tcppm accepts connections on
|
||||
.TP
|
||||
.I remote_host
|
||||
- IP address of the host the connection is forwarded to
|
||||
- IP address of the host the connection is forwarded to. Unix domain sockets
|
||||
can be specified with the syntax
|
||||
.I unix:/path/to/socket
|
||||
(e.g., unix:/var/run/app.sock). On Linux, abstract (fileless) Unix sockets
|
||||
use the syntax
|
||||
.I unix:@socketname
|
||||
(e.g., unix:@app.socket).
|
||||
.TP
|
||||
.I remote_port
|
||||
- remote port the connection is forwarded to
|
||||
- remote port the connection is forwarded to. Ignored when using Unix socket
|
||||
destination, but must be specified (use any positive value) for syntax
|
||||
compatibility.
|
||||
.SH CLIENTS
|
||||
Any TCP-based application can be used as a client. Use
|
||||
.I internal_ip
|
||||
|
||||
@ -36,6 +36,11 @@ with the routing table.
|
||||
.B -i
|
||||
Internal address. IP address the proxy accepts connections to.
|
||||
By default, connections to any interface are accepted. It\'s usually unsafe.
|
||||
Unix domain sockets can be specified with
|
||||
.I -iunix:/path/to/socket
|
||||
syntax (e.g., -iunix:/var/run/tlspr.sock). On Linux, abstract sockets use
|
||||
.I -iunix:@socketname
|
||||
syntax.
|
||||
.TP
|
||||
.B -a
|
||||
Anonymous. Hide information about client.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user