mirror of
https://github.com/3proxy/3proxy.git
synced 2026-11-22 23:59:41 +08:00
Update HTML documentation from man pages
This commit is contained in:
1 parent
22c7dfe0e1
commit
984366ce3e
13 files changed
+719
-742
No files matched your search
@@ -1,4 +1,4 @@
|
||||
<!-- Creator : groff version 1.24.1 -->
|
||||
<!-- Creator : groff version 1.23.0 -->
|
||||
<html>
|
||||
<head>
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>3proxy.cfg</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>3proxy.cfg</b>
|
||||
3proxy configuration file</p>
|
||||
|
||||
<h2>DESCRIPTION
|
||||
@@ -39,7 +39,7 @@
|
||||
</h2>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">Common
|
||||
<p style="margin-left:9%; margin-top: 1em">Common
|
||||
structure: <br>
|
||||
Configuration file is a text file 3proxy reads configuration
|
||||
from. Each line of the file is a command executed
|
||||
@@ -51,12 +51,12 @@ command line. Additional space characters are ignored. Think
|
||||
about 3proxy as "application level router" with
|
||||
console interface.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">Comments: <br>
|
||||
<p style="margin-left:9%; margin-top: 1em">Comments: <br>
|
||||
Any line beginning with a space character or ´#´
|
||||
character is a comment. It´s ignored. <LF>s are
|
||||
ignored. <CR> is the end of a command.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">Quotation: <br>
|
||||
<p style="margin-left:9%; margin-top: 1em">Quotation: <br>
|
||||
The quotation character is " (double quote). Quotation
|
||||
must be used to quote spaces or other special characters. To
|
||||
use a quotation character inside a quoted string, the
|
||||
@@ -65,7 +65,7 @@ to use HELLO "WORLD" as an argument, you should
|
||||
write it as "HELLO ""WORLD""".
|
||||
Good practice is to quote any argument you use.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">File inclusion:
|
||||
<p style="margin-left:9%; margin-top: 1em">File inclusion:
|
||||
<br>
|
||||
You can include file by using $FILENAME macro (replace
|
||||
FILENAME with a path to file, for example
|
||||
@@ -80,10 +80,10 @@ commands (like userlist, network lists, etc). To use dollar
|
||||
sign somewhere in argument it must be quoted. Recursion is
|
||||
not allowed.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">Next commands
|
||||
<p style="margin-left:9%; margin-top: 1em">Next commands
|
||||
start gateway services:</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>proxy</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>proxy</b>
|
||||
[options] <b><br>
|
||||
socks</b> [options] <b><br>
|
||||
pop3p</b> [options] <b><br>
|
||||
@@ -119,7 +119,7 @@ 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>
|
||||
<p style="margin-left:9%; margin-top: 1em">Options: <b><br>
|
||||
-p</b><i>NUMBER</i> change default server port to NUMBER
|
||||
<b><br>
|
||||
-6</b> Only resolve IPv6 addresses. IPv4 addresses are
|
||||
@@ -286,16 +286,16 @@ FTP client does it for you. That is, if you use 3proxy with
|
||||
authentication use proxyuser:proxypassword:FTPuser as FTP
|
||||
username, otherwise do not change original FTP user name</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>include</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>include</b>
|
||||
<i><path></i> <br>
|
||||
Include config file</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>config</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>config</b>
|
||||
<i><path></i> <br>
|
||||
Path to configuration file to use on 3proxy restart or to
|
||||
save configuration.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>writable</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>writable</b>
|
||||
<br>
|
||||
ReOpens configuration file for write access via Web
|
||||
interface, and rereads it. Usually should be first command
|
||||
@@ -303,10 +303,10 @@ on config file but in combination with config it can be used
|
||||
anywhere to open alternate config file. Think twice before
|
||||
using it.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>end</b> <br>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>end</b> <br>
|
||||
End of configuration</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>log</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>log</b>
|
||||
[[@|&]<i>logfile</i>] [<i><LOGTYPE></i>] <br>
|
||||
sets logfile for all gateways <br>
|
||||
@ (for Unix) use syslog, filename is used as ident name <br>
|
||||
@@ -332,12 +332,12 @@ with "logformat" filename must begin with
|
||||
Grinwitch time zone for all time-based format
|
||||
specificators.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>rotate</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>rotate</b>
|
||||
<i><n></i> <br>
|
||||
how many archived log files to keep</p>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>logformat</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>logformat</b>
|
||||
<i><format></i> <br>
|
||||
Format for log record. First symbol in format must be L
|
||||
(local time) or G (absolute Grinwitch time). It can be
|
||||
@@ -349,7 +349,7 @@ logformat means comma and percent are replaced with space
|
||||
and all time based elemnts are in local time zone. <br>
|
||||
You can use:</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">%y Year in 2
|
||||
<p style="margin-left:9%; margin-top: 1em">%y Year in 2
|
||||
digit format <br>
|
||||
%Y Year in 4 digit format <br>
|
||||
%m Month number <br>
|
||||
@@ -394,7 +394,7 @@ l_service, l_in, l_out, l_descr) values (´%d-%m-%Y
|
||||
%H:%M:%S´, ´%U´, ´%N´, %I, %O,
|
||||
´%T´)"</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>logdump</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>logdump</b>
|
||||
<i><in_traffic_limit> <out_traffic_limit></i>
|
||||
<br>
|
||||
Immediately creates additional log records if given amount
|
||||
@@ -404,7 +404,7 @@ to prevent information about long-lasting downloads on
|
||||
server shutdown.</p>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>delimchar</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>delimchar</b>
|
||||
<i><char></i> <br>
|
||||
Sets the delimiter character used to separate username from
|
||||
hostname in proxy authentication strings (e.g. for FTP, POP3
|
||||
@@ -412,14 +412,14 @@ proxies). Default is ´@´. For example, to use
|
||||
´#´ instead: delimchar #. This allows usernames
|
||||
to contain the ´@´ character.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>archiver</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>archiver</b>
|
||||
<i><ext> <commandline></i> <br>
|
||||
Archiver to use for log files. <ext> is file extension
|
||||
produced by archiver. Filename will be last argument to
|
||||
archiver, optionally you can use %A as produced archive name
|
||||
and %F as filename.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>timeouts</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>timeouts</b>
|
||||
<i><BYTE_SHORT> <BYTE_LONG> <STRING_SHORT>
|
||||
<STRING_LONG> <CONNECTION_SHORT>
|
||||
<CONNECTION_LONG> <DNS> <CHAIN>
|
||||
@@ -450,14 +450,14 @@ tail of the data to be lost on slow connections, too large
|
||||
one delays release of the sockets. <br>
|
||||
default timeouts 1 5 30 60 180 1800 15 60 15 5 5</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>maxseg</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>maxseg</b>
|
||||
<i><value></i> <br>
|
||||
Sets TCP maximum segment size (MSS) for outgoing
|
||||
connections. This can be used to work around path MTU
|
||||
discovery issues or to optimize traffic for specific network
|
||||
conditions.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>radius</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>radius</b>
|
||||
<i><NAS_SECRET>
|
||||
<radius_server_1</i>[:<i>port</i>][/<i>local_address_1</i>]
|
||||
<i><radius_server_2</i>[:<i>port</i>][/<i>local_address_2</i>]
|
||||
@@ -484,7 +484,7 @@ user), Reply-Message. Use <b>authcache</b> to speedup
|
||||
authentication. RADIUS feature is currently
|
||||
experimental.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>nserver</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>nserver</b>
|
||||
<i><ipaddr></i>[:<i>port</i>][/<i>tcp</i>] <br>
|
||||
Nameserver to use for name resolutions. If none specified
|
||||
system routines for name resolution is used. Optional port
|
||||
@@ -492,13 +492,13 @@ number may be specified. If optional /tcp is added to IP
|
||||
address, name resolution is performed over TCP.</p>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>authnserver</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>authnserver</b>
|
||||
<i><ipaddr></i>[:<i>port</i>][/<i>tcp</i>] <br>
|
||||
Nameserver to use for DNS-based authentication (e.g. dnsname
|
||||
auth type). If not specified, nserver is used. The syntax is
|
||||
the same as for nserver.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>nscache</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>nscache</b>
|
||||
<i><cachesize></i> <b>nscache6</b>
|
||||
<i><cachesize></i> <br>
|
||||
Cache <i><cachesize></i> records for name resolution
|
||||
@@ -506,7 +506,7 @@ Cache <i><cachesize></i> records for name resolution
|
||||
cache size should usually be large enough (for example,
|
||||
65536).</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>nsrecord</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>nsrecord</b>
|
||||
<i><hostname> <hostaddr></i> <br>
|
||||
Adds static record to nscache. <b>nscache</b> must be
|
||||
enabled. If 0.0.0.0 is used as a hostaddr host will never
|
||||
@@ -514,14 +514,14 @@ resolve, it can be used to blacklist something or together
|
||||
with <b>dialer</b> command to set up UDL for dialing.</p>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>fakeresolve</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>fakeresolve</b>
|
||||
<br>
|
||||
All names are resolved to the 127.0.0.2 address. Useful if
|
||||
all requests are redirected to a parent proxy with
|
||||
<b>http</b>, <b>socks4+</b>, <b>connect+</b> or
|
||||
<b>socks5+</b>.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>dialer</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>dialer</b>
|
||||
<i><progname></i> <br>
|
||||
Execute progname if external name can´t be resolved.
|
||||
Hint: if you use nscache, dialer may not work, because names
|
||||
@@ -529,7 +529,7 @@ will be resolved through cache. In this case you can use
|
||||
something like http://dial.right.now/ from browser to set up
|
||||
connection.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>internal</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>internal</b>
|
||||
<i><ipaddr></i> <br>
|
||||
sets ip address of internal interface. This IP address will
|
||||
be used to bind gateways. Alternatively you can use -i
|
||||
@@ -543,7 +543,7 @@ Unix sockets are supported with the syntax
|
||||
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>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>external</b>
|
||||
<i><ipaddr></i> <br>
|
||||
sets ip address of external interface. This IP address will
|
||||
be source address for all connections made by proxy.
|
||||
@@ -552,7 +552,7 @@ address for gateway. Since 0.8 version External or <b>-e</b>
|
||||
can be given twice: once with IPv4 and once with IPv6
|
||||
address.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>maxconn</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>maxconn</b>
|
||||
<i><number></i> <br>
|
||||
sets the maximum number of simultaneous connections to each
|
||||
service started after this command at the network level.
|
||||
@@ -562,13 +562,13 @@ will silently ignore new connections, while <b>connlim</b>
|
||||
will report back to the client that the connection limit has
|
||||
been reached.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>backlog</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>backlog</b>
|
||||
<br>
|
||||
sets the listening socket backlog of new connections.
|
||||
Default is 1 + <b>maxconn</b>/8. Maximum value is capped by
|
||||
kernel tunable somaxconn.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>service</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>service</b>
|
||||
<br>
|
||||
(deprecated). Indicates that 3proxy should behave as a
|
||||
Windows 95/98/NT/2000/XP service; has no effect under Unix.
|
||||
@@ -576,7 +576,7 @@ Not required for 3proxy 0.6 and above. If you upgraded from
|
||||
a previous version of 3proxy, use --remove and --install to
|
||||
reinstall the service.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>daemon</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>daemon</b>
|
||||
<br>
|
||||
Should be specified to close the console. Do not use
|
||||
´daemon´ with ´service´. At least
|
||||
@@ -584,7 +584,7 @@ under FreeBSD, <b>daemon</b> should precede any proxy
|
||||
service and log commands to avoid socket problems. Always
|
||||
place it in the beginning of the configuration file.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>auth</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>auth</b>
|
||||
<i><authtype></i> [...] <br>
|
||||
Type of user authorization. Currently supported: <b><br>
|
||||
none</b> - no authentication or authorization required. <br>
|
||||
@@ -624,7 +624,7 @@ address is then restored from the cache entry. <b><br>
|
||||
radius</b> - authentication with RADIUS. <br>
|
||||
Plugins may add additional authentication types.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">It´s
|
||||
<p style="margin-left:9%; margin-top: 1em">It´s
|
||||
possible to use multiple authentication types in the same
|
||||
command. E.g. <br>
|
||||
auth iponly strong <br>
|
||||
@@ -638,7 +638,7 @@ for dedicated laptops and request a username/password for
|
||||
shared ones.</p>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>authcache</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>authcache</b>
|
||||
<i><cachtype> <cachtime> <cachesize></i>
|
||||
<br>
|
||||
Cache authentication information for a given amount of time
|
||||
@@ -683,7 +683,7 @@ see <b>allow</b>. <br>
|
||||
Use auth type <b>cache</b> (or <b>cacheacl</b>) for cached
|
||||
authentication</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>allow</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>allow</b>
|
||||
<i><userlist> <sourcelist> <targetlist>
|
||||
<targetportlist> <operationlist>
|
||||
<weekdayslist> <timeperiodslist></i> <b><br>
|
||||
@@ -719,7 +719,7 @@ specific addresses immediately without any conditions you
|
||||
should either bind proxy to appropriate interface only or to
|
||||
use ip filters.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">Operation is one
|
||||
<p style="margin-left:9%; margin-top: 1em">Operation is one
|
||||
of: <b><br>
|
||||
CONNECT</b> establish outgoing TCP connection <b><br>
|
||||
BIND</b> bind TCP port for listening <b><br>
|
||||
@@ -743,7 +743,7 @@ remote side. <b><br>
|
||||
FTP</b> matches any FTP/FTP Data request <b><br>
|
||||
ADMIN</b> access to administration interface</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">Weekdays are
|
||||
<p style="margin-left:9%; margin-top: 1em">Weekdays are
|
||||
week day numbers or periods, 0 or 7 means Sunday, 1 is
|
||||
Monday, 1-5 means Monday through Friday. <br>
|
||||
Timeperiodlists is a list of time periods in
|
||||
@@ -788,7 +788,7 @@ RADIUS or plugin authentication: <b>cacheacl</b> with the
|
||||
destination in the cache key if no parent proxy is used,
|
||||
<b>cache</b> otherwise, see <b>cacheacl</b>.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>parent</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>parent</b>
|
||||
<i><weight> <type> <ip> <port>
|
||||
<username> <password></i> <br>
|
||||
this command must follow "allow" rule. It extends
|
||||
@@ -818,7 +818,7 @@ connections. Chains are only applied to new connections,
|
||||
pipelined (keep-alive) requests in the same connection use
|
||||
the same chain.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">type is one of:
|
||||
<p style="margin-left:9%; margin-top: 1em">type is one of:
|
||||
<b><br>
|
||||
extip</b> does not actually redirect the request; it sets
|
||||
the external address for this request to <i><ip></i>.
|
||||
@@ -877,7 +877,7 @@ Requires SSL/TLS support (WITH_SSL) and is used with
|
||||
<b>ssl_client_mode 3</b>, which only handshakes TLS for
|
||||
<b>s</b>-suffixed parents.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">IP and port are
|
||||
<p style="margin-left:9%; margin-top: 1em">IP and port are
|
||||
ip addres and port of parent proxy server. If IP is zero, ip
|
||||
is taken from original request, only port is changed. If
|
||||
port is zero, it´s taken from original request, only
|
||||
@@ -898,7 +898,7 @@ 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
|
||||
<p style="margin-left:9%; margin-top: 1em">Main purpose of
|
||||
local redirections is to have the requested resource (URL or
|
||||
POP3 username) logged and protocol-specific filters applied.
|
||||
In case of local redirection, ACLs are reviewed twice:
|
||||
@@ -923,19 +923,19 @@ parent proxy. Username of ´*´ means username
|
||||
must be supplied by user.</p>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>parentretries</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>parentretries</b>
|
||||
<i><number></i> <br>
|
||||
Number of retries to connect to parent proxy. Default is
|
||||
1.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>nolog</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>nolog</b>
|
||||
<i><n></i> <br>
|
||||
extends last allow or deny command to prevent logging, e.g.
|
||||
<br>
|
||||
allow * * 192.168.1.1 <br>
|
||||
nolog</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>weight</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>weight</b>
|
||||
<i><n></i> <br>
|
||||
extends last allow or deny command to set weight for this
|
||||
request <br>
|
||||
@@ -943,7 +943,7 @@ allow * * 192.168.1.1 <br>
|
||||
weight 100 <br>
|
||||
Weight may be used for different purposes.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>force <br>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>force <br>
|
||||
noforce</b> <br>
|
||||
If force is specified for service, configuration reload will
|
||||
require all current sessions of this service to be
|
||||
@@ -953,7 +953,7 @@ closed. noforce allows to keep previously authenticated
|
||||
connections.</p>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>bandlimin</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>bandlimin</b>
|
||||
<i><rate> <userlist> <sourcelist>
|
||||
<targetlist> <targetportlist>
|
||||
<operationlist> <weekdayslist>
|
||||
@@ -995,7 +995,7 @@ POP3, you can use <br>
|
||||
nobandlimin * * * 110 <br>
|
||||
before the rest of bandlim rules.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>connlim</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>connlim</b>
|
||||
<i><rate> <period> <userlist>
|
||||
<sourcelist> <targetlist> <targetportlist>
|
||||
<operationlist> <weekdayslist>
|
||||
@@ -1017,7 +1017,7 @@ required per client, a separate rule must be added for every
|
||||
client. Like with nobandlimin, noconnlim adds an
|
||||
exception.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>counter</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>counter</b>
|
||||
<i><filename> <reporttype>
|
||||
<reportname></i> <b><br>
|
||||
countin</b> <i><number> <type> <limit>
|
||||
@@ -1045,7 +1045,7 @@ nocountall</b> <i><userlist> <sourcelist>
|
||||
<operationlist> <weekdayslist>
|
||||
<timeperiodslist></i></p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">counter,
|
||||
<p style="margin-left:9%; margin-top: 1em">counter,
|
||||
countin, nocountin, countout, nocountout, countall,
|
||||
nocountall commands are used to set a traffic limit in MB
|
||||
for a period of time (day, week or month). Filename is a
|
||||
@@ -1070,7 +1070,7 @@ report is a text file with counter values in the format:
|
||||
The rest of parameters is identical to
|
||||
<b>bandlim</b>/<b>nobandlim</b>.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>users</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>users</b>
|
||||
<i>username</i>[:<i>pwtype</i>:<i>password</i>] ... <br>
|
||||
pwtype is one of: <br>
|
||||
none (empty) - use system authentication <b><br>
|
||||
@@ -1088,7 +1088,7 @@ users "test4:CR:$3$salt$G47yV9w...." <br>
|
||||
Note: double quotes are required because the password
|
||||
contains a $ sign.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>flush</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>flush</b>
|
||||
<br>
|
||||
empty the active access list. The access list must be
|
||||
flushed every time you create a new access list for a new
|
||||
@@ -1100,35 +1100,35 @@ allow * 192.168.1.0/24 <br>
|
||||
socks <br>
|
||||
sets different ACLs for <b>pop3p</b> and <b>socks</b></p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>system</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>system</b>
|
||||
<i><command></i> <br>
|
||||
execute system command</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>pidfile</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>pidfile</b>
|
||||
<i><filename></i> <br>
|
||||
write pid of current process to file. It can be used to
|
||||
manipulate 3proxy with signals under Unix. Currently next
|
||||
signals are available:</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>monitor</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>monitor</b>
|
||||
<i><filename></i> <br>
|
||||
If file monitored changes in modification time or size,
|
||||
3proxy reloads configuration within one minute. Any number
|
||||
of files may be monitored.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>setuid</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>setuid</b>
|
||||
<i><uid></i> <br>
|
||||
calls setuid(uid), uid can be numeric or since 0.9 username.
|
||||
Unix only. Warning: under some Linux kernels setuid() works
|
||||
for current thread only. It makes it impossible to suid for
|
||||
all threads.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>setgid</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>setgid</b>
|
||||
<i><gid></i> <br>
|
||||
calls setgid(gid), gid can be numeric or since 0.9
|
||||
groupname. Unix only.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>chroot</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>chroot</b>
|
||||
<i><path></i> [<i><uid></i>]
|
||||
[<i><gid></i>] <br>
|
||||
calls chroot(path) and sets gid/uid. Unix only. uid/gid
|
||||
@@ -1136,7 +1136,7 @@ supported since 0.9, can be numeric or
|
||||
username/groupname</p>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>stacksize</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>stacksize</b>
|
||||
<i><value_to_add_to_default_stack_size></i> <br>
|
||||
Change the default size for thread stacks. May be required
|
||||
in some situations, e.g. with non-default plugins, or on
|
||||
@@ -1165,7 +1165,7 @@ disable the thread stack.</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>plugin</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>plugin</b>
|
||||
<i><path_to_shared_library>
|
||||
<function_to_call></i> [<i><arg1></i> ...] <br>
|
||||
Loads specified library and calls given export function with
|
||||
@@ -1176,7 +1176,7 @@ function_to_call must return 0 in case of success, value
|
||||
> 0 to indicate error.</p>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>filtermaxsize</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>filtermaxsize</b>
|
||||
<i><max_size_of_data_to_filter></i> <br>
|
||||
If Content-length (or another data length) is greater than
|
||||
the given value, no data filtering will be performed through
|
||||
@@ -1188,13 +1188,13 @@ Content-Length changing. Default is 1MB (1048576).</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">SSL/TLS support
|
||||
<p style="margin-left:9%; margin-top: 1em">SSL/TLS support
|
||||
is built into 3proxy (since 0.9.7) when compiled with
|
||||
OpenSSL (WITH_SSL). Previously available as SSLPlugin, the
|
||||
functionality is now integrated into the main binary. The
|
||||
plugin line is no longer required.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">SSL/TLS can be
|
||||
<p style="margin-left:9%; margin-top: 1em">SSL/TLS can be
|
||||
used for: - transparent MITM (Man-in-the-Middle) for TLS
|
||||
traffic inspection - https:// proxy (TLS-encrypted
|
||||
connection between client and proxy) - TLS client
|
||||
@@ -1207,7 +1207,7 @@ certificates</p>
|
||||
</h3>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>ssl_mitm</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>ssl_mitm</b>
|
||||
- spoof certificates for services started below. Usage
|
||||
without ssl_client_verify is insecure. <b><br>
|
||||
ssl_nomitm</b> - do not spoof certificates for services
|
||||
@@ -1218,7 +1218,7 @@ started below</p>
|
||||
</h3>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>ssl_serv</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>ssl_serv</b>
|
||||
(or ssl_server) - require TLS connection from clients for
|
||||
services below <b><br>
|
||||
ssl_noserv</b> (or ssl_noserver) - do not require TLS
|
||||
@@ -1229,7 +1229,7 @@ connection from clients for services below</p>
|
||||
</h3>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>ssl_cli</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>ssl_cli</b>
|
||||
(or ssl_client) - establish TLS connection to upstream
|
||||
server for services below <b><br>
|
||||
ssl_nocli</b> (or ssl_noclient) - do not establish TLS
|
||||
@@ -1241,7 +1241,7 @@ connection to upstream server for services below</p>
|
||||
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>ssl_server_cert</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>ssl_server_cert</b>
|
||||
<i>/path/to/cert</i> - Server certificate (should not be
|
||||
self-signed, must contain SAN) for ssl_serv <b><br>
|
||||
ssl_server_key</b> <i>/path/to/key</i> - Server certificate
|
||||
@@ -1306,14 +1306,14 @@ generated MITM certificates cache</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">PCRE (Perl
|
||||
<p style="margin-left:9%; margin-top: 1em">PCRE (Perl
|
||||
Compatible Regular Expressions) filtering is built into
|
||||
3proxy (since 0.9.7) when compiled with PCRE2 support
|
||||
(WITH_PCRE). Previously available as PCREPlugin, the
|
||||
functionality is now integrated into the main binary. The
|
||||
plugin line is no longer required.</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">PCRE filtering
|
||||
<p style="margin-left:9%; margin-top: 1em">PCRE filtering
|
||||
allows creating matching and replacement rules with regular
|
||||
expressions for client requests, headers, and data.</p>
|
||||
|
||||
@@ -1322,7 +1322,7 @@ expressions for client requests, headers, and data.</p>
|
||||
</h3>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em"><b>pcre</b>
|
||||
<p style="margin-left:9%; margin-top: 1em"><b>pcre</b>
|
||||
<i>TYPE FILTER_ACTION REGEXP [ACE]</i> <br>
|
||||
Apply a rule for matching regular expression. <b><br>
|
||||
pcre_rewrite</b> <i>TYPE FILTER_ACTION REGEXP
|
||||
@@ -1358,7 +1358,7 @@ PCRE_BSR_UNICODE.</p>
|
||||
</h3>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">TYPE - type of
|
||||
<p style="margin-left:9%; margin-top: 1em">TYPE - type of
|
||||
filtered data (comma-delimited list): <br>
|
||||
request - content of the client’s request (e.g., HTTP
|
||||
GET request string) <br>
|
||||
@@ -1369,7 +1369,7 @@ data) <br>
|
||||
srvdata - data received from the server (e.g., HTML
|
||||
page)</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">FILTER_ACTION -
|
||||
<p style="margin-left:9%; margin-top: 1em">FILTER_ACTION -
|
||||
action on match: <br>
|
||||
allow - allow this request without checking the rest of the
|
||||
rules <br>
|
||||
@@ -1378,18 +1378,18 @@ rules <br>
|
||||
dunno - continue with the rest of the rules (useful with
|
||||
pcre_rewrite)</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">REGEXP - PCRE
|
||||
<p style="margin-left:9%; margin-top: 1em">REGEXP - PCRE
|
||||
(Perl) regular expression. Use * if no regexp matching is
|
||||
required.</p>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">REWRITE_EXPRESSION
|
||||
<p style="margin-left:9%; margin-top: 1em">REWRITE_EXPRESSION
|
||||
- substitution string. May contain Perl-style substrings $1,
|
||||
$2, etc. $0 means the whole matched string. \r and \n may be
|
||||
used to insert new lines; the string may be empty
|
||||
("").</p>
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">ACE - access
|
||||
<p style="margin-left:9%; margin-top: 1em">ACE - access
|
||||
control entry (user names, source IPs, destination IPs,
|
||||
ports, etc.), identical to allow/deny/bandlimin commands.
|
||||
The regular expression is only matched if the ACL matches
|
||||
@@ -1402,7 +1402,7 @@ authentication and/or allow/deny ACLs.</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">Report all bugs
|
||||
<p style="margin-left:9%; margin-top: 1em">Report all bugs
|
||||
to <b>3proxy@3proxy.org</b></p>
|
||||
|
||||
<h2>SEE ALSO
|
||||
@@ -1410,7 +1410,7 @@ to <b>3proxy@3proxy.org</b></p>
|
||||
</h2>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">3proxy(8),
|
||||
<p style="margin-left:9%; margin-top: 1em">3proxy(8),
|
||||
3proxy_crypt(8), proxy(8), ftppr(8), socks(8), pop3p(8),
|
||||
imapp(8), smtpp(8), tlspr(8), tcppm(8), udppm(8),
|
||||
syslogd(8), <br>
|
||||
@@ -1421,7 +1421,7 @@ https://3proxy.org/</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<p style="margin-left:6%; margin-top: 1em">3proxy is
|
||||
<p style="margin-left:9%; margin-top: 1em">3proxy is
|
||||
designed by Vladimir Dubrovin <vlad@3proxy.org></p>
|
||||
<hr>
|
||||
</body>
|
||||
|
||||
Reference in new issue
Block a user