Merge remote-tracking branch 'refs/remotes/origin/devel'

This commit is contained in:
z3APA3A 2016-01-15 03:07:59 +03:00
commit 999f9e856b

View File

@ -5,31 +5,33 @@
.SH DESCRIPTION .SH DESCRIPTION
Common structure: Common structure:
.br .br
Configuration file is a text file 3proxy reads configuration from. Each line Configuration file is a text file 3proxy reads configuration from. Each line
of the file is a command executed immediately, as it was given from of the file is a command executed immediately, as it was given from
console. Sequence of commands is important. Configuration file as actually a console. Sequence of commands is important. Configuration file as actually a
script for 3proxy executable. script for 3proxy executable.
Each line of the file is treated as a blank (space or tab) separated Each line of the file is treated as a blank (space or tab) separated
command line. Additional space characters are ignored. command line. Additional space characters are ignored.
Think about 3proxy as "application level router" with console interface. Think about 3proxy as "application level router" with console interface.
.br .br
Comments: Comments:
.br .br
Any string beginning with space character or \'#\' character is comment. It\'s Any string beginning with space character or \'#\' character is comment. It\'s
ignored. <LF>s are ignored. <CR> is end of command. ignored. <LF>s are ignored. <CR> is end of command.
.br .br
Quotation: Quotation:
.br .br
Quotation character is " (double quote). Quotation must be used to quote Quotation character is " (double quote). Quotation must be used to quote
spaces or another special characters. To use quotation character inside spaces or another special characters. To use quotation character inside
quotation character must be dubbed (BASIC convention). For example to use quotation character must be dubbed (BASIC convention). For example to use
HELLO "WORLD" as an argument you should use it as "HELLO ""WORLD"""\. HELLO "WORLD" as an argument you should use it as "HELLO ""WORLD"""\.
Good practice is to quote any argument you use. Good practice is to quote any argument you use.
.br .br
File inclusion: File inclusion:
.br .br
You can include file by using $FILENAME macro (replace FILENAME with a path You can include file by using $FILENAME macro (replace FILENAME with a path
to file, for example $/usr/local/etc/3proxy/conf.incl or to file, for example $/usr/local/etc/3proxy/conf.incl or
$"c:\\Program Files\\3proxy\\include.cfg" Quotation is $"c:\\Program Files\\3proxy\\include.cfg" Quotation is
required in last example because path contains space character. required in last example because path contains space character.
@ -39,9 +41,12 @@ Thus, include files are only useful to store long signle-line commands
(like userlist, network lists, etc). (like userlist, network lists, etc).
To use dollar sign somewhere in argument it must be quoted. To use dollar sign somewhere in argument it must be quoted.
Recursion is not allowed. Recursion is not allowed.
.br .br
Next commands start gateway services: Next commands start gateway services:
.br .br
.br
.B proxy .B proxy
[options] [options]
.br .br
@ -174,18 +179,18 @@ proxy on a client with FTP proxy support. Username format is one of
.B include .B include
<path> <path>
.br .br
Include config file Include config file
.br .br
.B config .B config
<path> <path>
.br .br
Path to configuration file to use on 3proxy restart or to save configuration. Path to configuration file to use on 3proxy restart or to save configuration.
.br .br
.B writable .B writable
.br .br
ReOpens configuration file for write access via Web interface, ReOpens configuration file for write access via Web interface,
and re-reads it. Usually should be first command on config file and re-reads it. Usually should be first command on config file
but in combination with "config" it can be used anywhere to open but in combination with "config" it can be used anywhere to open
alternate config file. Think twice before using it. alternate config file. Think twice before using it.
@ -193,13 +198,13 @@ alternate config file. Think twice before using it.
.br .br
.B end .B end
.br .br
End of configuration End of configuration
.br .br
.B log .B log
[[@|&]logfile] [<LOGTYPE>] [[@|&]logfile] [<LOGTYPE>]
.br .br
sets logfile for all gateways sets logfile for all gateways
.br .br
@ - (for Unix) use syslog, filename is used as ident name @ - (for Unix) use syslog, filename is used as ident name
.br .br
@ -215,10 +220,10 @@ sets logfile for all gateways
.br .br
H - Hourly H - Hourly
.br .br
if logfile is not specified logging goes to stdout. You can specify individual logging options for gateway by using if logfile is not specified logging goes to stdout. You can specify individual logging options for gateway by using
-l option in gateway configuration. -l option in gateway configuration.
.br .br
"log" command supports same format specifications for filename template "log" command supports same format specifications for filename template
as "logformat" (if filename contains '%' sign it's believed to be template). as "logformat" (if filename contains '%' sign it's believed to be template).
As with "logformat" filename must begin with 'L' or 'G' to specify Local or As with "logformat" filename must begin with 'L' or 'G' to specify Local or
Grinwitch time zone for all time-based format specificators. Grinwitch time zone for all time-based format specificators.
@ -226,13 +231,13 @@ Grinwitch time zone for all time-based format specificators.
.br .br
.B rotate .B rotate
<n> <n>
how many archived log files to keep how many archived log files to keep
.br .br
.B logformat .B logformat
<format> <format>
.br
Format for log record. First symbol in format must be L (local time) Format for log record. First symbol in format must be L (local time)
or G (absolute Grinwitch time). or G (absolute Grinwitch time).
It can be preceeded with -XXX+Y where XXX is list of characters to be It can be preceeded with -XXX+Y where XXX is list of characters to be
filtered in user input (any non-printable characters are filtered too filtered in user input (any non-printable characters are filtered too
@ -240,7 +245,7 @@ in this case) and Y is replacement character. For example, "-,%+ L" in
the beginning of logformat means comma and percent are replaced the beginning of logformat means comma and percent are replaced
with space and all time based elemnts are in local time zone. with space and all time based elemnts are in local time zone.
.br .br
You can use: You can use:
.br .br
%y - Year in 2 digit format %y - Year in 2 digit format
@ -305,7 +310,7 @@ You can use:
.br .br
%N1-N2T - (N1 and N2 are positive numbers) - log only fields from N1 thorugh N2 of service specific text %N1-N2T - (N1 and N2 are positive numbers) - log only fields from N1 thorugh N2 of service specific text
.br .br
in case of ODBC logging logformat specifies SQL statement, for exmample: in case of ODBC logging logformat specifies SQL statement, for exmample:
.br .br
logformat "-'+_Linsert into log (l_date, l_user, l_service, l_in, l_out, l_descr) values ('%d-%m-%Y %H:%M:%S', '%U', '%N', %I, %O, '%T')" logformat "-'+_Linsert into log (l_date, l_user, l_service, l_in, l_out, l_descr) values ('%d-%m-%Y %H:%M:%S', '%U', '%N', %I, %O, '%T')"
@ -313,7 +318,7 @@ in case of ODBC logging logformat specifies SQL statement, for exmample:
.B logdump .B logdump
<in_traffic_limit> <out_traffic_limit> <in_traffic_limit> <out_traffic_limit>
.br .br
Immediately creates additional log records if given amount of incoming/outgoing Immediately creates additional log records if given amount of incoming/outgoing
traffic is achieved for connection, without waiting for connection to finish. traffic is achieved for connection, without waiting for connection to finish.
It may be useful to prevent information about long-lasting downloads on server It may be useful to prevent information about long-lasting downloads on server
shutdown. shutdown.
@ -322,7 +327,7 @@ shutdown.
.B archiver .B archiver
<ext> <commandline> <ext> <commandline>
.br .br
Archiver to use for log files. <ext> is file extension produced by Archiver to use for log files. <ext> is file extension produced by
archiver. Filename will be last argument to archiver, optionally you archiver. Filename will be last argument to archiver, optionally you
can use %A as produced archive name and %F as filename. can use %A as produced archive name and %F as filename.
@ -330,7 +335,7 @@ can use %A as produced archive name and %F as filename.
.B timeouts .B timeouts
<BYTE_SHORT> <BYTE_LONG> <STRING_SHORT> <STRING_LONG> <CONNECTION_SHORT> <CONNECTION_LONG> <DNS> <CHAIN> <BYTE_SHORT> <BYTE_LONG> <STRING_SHORT> <STRING_LONG> <CONNECTION_SHORT> <CONNECTION_LONG> <DNS> <CHAIN>
.br .br
Sets timeout values Sets timeout values
.br .br
BYTE_SHORT - short timeout for single byte, is usually used for receiving single byte from stream. BYTE_SHORT - short timeout for single byte, is usually used for receiving single byte from stream.
.br .br
@ -366,16 +371,15 @@ performed over TCP.
.B nscache6 .B nscache6
<cachesize> <cachesize>
.br .br
Cache <cachesize> records for name resolution (nscache for IPv4,
Cache <cachesize> records for name resolution (nscache for IPv4,
nscache6 for IPv6). Cachesize usually should be large enougth nscache6 for IPv6). Cachesize usually should be large enougth
(for example 65536). (for example 65536).
.br .br
.B nsrecord .B nsrecord
<hostname> <hostaddr> <hostname> <hostaddr>
.BR .br
Adds static record to nscache. nscache must be enabled. If 0.0.0.0 Adds static record to nscache. nscache must be enabled. If 0.0.0.0
is used as a hostaddr host will never resolve, it can be used to is used as a hostaddr host will never resolve, it can be used to
blacklist something or together with blacklist something or together with
.B dialer .B dialer
@ -383,15 +387,15 @@ command to set up UDL for dialing.
.br .br
.B fakeresolve .B fakeresolve
.BR .br
All names are resolved to 127.0.0.2 address. Usefull if all requests are All names are resolved to 127.0.0.2 address. Usefull if all requests are
redirected to parent proxy with http, socks4+, connect+ or socks5+. redirected to parent proxy with http, socks4+, connect+ or socks5+.
.br .br
.B dialer .B dialer
<progname> <progname>
.br .br
Execute progname if external name can't be resolved. Execute progname if external name can't be resolved.
Hint: if you use nscache, dialer may not work, because names will Hint: if you use nscache, dialer may not work, because names will
be resolved through cache. In this case you can use something like be resolved through cache. In this case you can use something like
http://dial.right.now/ from browser to set up connection. http://dial.right.now/ from browser to set up connection.
@ -401,7 +405,7 @@ http://dial.right.now/ from browser to set up connection.
.B internal .B internal
<ipaddr> <ipaddr>
.br .br
sets ip address of internal interface. This IP address will be used sets ip address of internal interface. This IP address will be used
to bind gateways. Alternatively you can use -i option for individual to bind gateways. Alternatively you can use -i option for individual
gateways. Since 0.8 version, IPv6 address may be used. gateways. Since 0.8 version, IPv6 address may be used.
@ -409,7 +413,7 @@ gateways. Since 0.8 version, IPv6 address may be used.
.B external .B external
<ipaddr> <ipaddr>
.br .br
sets ip address of external interface. This IP address will be source sets ip address of external interface. This IP address will be source
address for all connections made by proxy. Alternatively you can use address for all connections made by proxy. Alternatively you can use
-e option to specify individual address for gateway. Since 0.8 version -e option to specify individual address for gateway. Since 0.8 version
External or -e can be given twice: once with IPv4 and once with IPv6 address. External or -e can be given twice: once with IPv4 and once with IPv6 address.
@ -418,13 +422,13 @@ External or -e can be given twice: once with IPv4 and once with IPv6 address.
.B maxconn .B maxconn
<number> <number>
.br .br
sets maximum number of simulationeous connections to each services sets maximum number of simulationeous connections to each services
started after this command. Default is 100. started after this command. Default is 100.
.br .br
.B service .B service
.br .br
(depricated). Indicates 3proxy to behave as Windows 95/98/NT/2000/XP (depricated). Indicates 3proxy to behave as Windows 95/98/NT/2000/XP
service, no effect for Unix. Not required for 3proxy 0.6 and above. If service, no effect for Unix. Not required for 3proxy 0.6 and above. If
you upgraded from previous version of 3proxy use --remove and --install you upgraded from previous version of 3proxy use --remove and --install
to reinstall service. to reinstall service.
@ -432,7 +436,7 @@ to reinstall service.
.br .br
.B daemon .B daemon
.br .br
Should be specified to close console. Do not use 'daemon' with 'service'. Should be specified to close console. Do not use 'daemon' with 'service'.
At least under FreeBSD 'daemon' should preceed any proxy service At least under FreeBSD 'daemon' should preceed any proxy service
and log commands to avoid sockets problem. Always place it in the beginning and log commands to avoid sockets problem. Always place it in the beginning
of the configuration file. of the configuration file.
@ -441,11 +445,12 @@ of the configuration file.
.B auth .B auth
<authtype> [...] <authtype> [...]
.br .br
Type of user authorization. Currently supported: Type of user authorization. Currently supported:
.br .br
none - no authentication or authorization required. none - no authentication or authorization required.
.br
Note: is auth is none any ip based limitation, redirection, etc will not work. Note: is auth is none any ip based limitation, redirection, etc will not work.
This is default authentication type This is default authentication type
.br .br
iponly - authentication by access control list with username ignored. iponly - authentication by access control list with username ignored.
Appropriate for most cases Appropriate for most cases
@ -465,14 +470,14 @@ SOCKSv5, FTP, POP3 and HTTP proxy.
.br .br
cache - cached authentication, may be used with 'authcache'. cache - cached authentication, may be used with 'authcache'.
.br .br
Plugins may add additional authentication types. Plugins may add additional authentication types.
.br .br
It's possible to use few authentication types in the same commands. E.g. It's possible to use few authentication types in the same commands. E.g.
.br .br
auth iponly strong auth iponly strong
.br .br
In this case 'strong' authentication will be used only in case resource In this case 'strong' authentication will be used only in case resource
access can not be performed with 'iponly' authentication, that is username is access can not be performed with 'iponly' authentication, that is username is
required in ACL. It's usefull to protect access to some resources with required in ACL. It's usefull to protect access to some resources with
password allowing passwordless access to another resources, or to use password allowing passwordless access to another resources, or to use
@ -483,7 +488,7 @@ shared ones.
.B authcache .B authcache
<cachtype> <cachtime> <cachtype> <cachtime>
.br .br
Cache authentication information to given amount of time (cachetime) in seconds. Cache authentication information to given amount of time (cachetime) in seconds.
Cahtype is one of: Cahtype is one of:
.br .br
ip - after successful authentication all connections during caching time ip - after successful authentication all connections during caching time
@ -507,7 +512,7 @@ Use auth type 'cache' for cached authentication
<userlist> <sourcelist> <targetlist> <targetportlist> <operationlist> <userlist> <sourcelist> <targetlist> <targetportlist> <operationlist>
<weekdayslist> <timeperiodslist> <weekdayslist> <timeperiodslist>
.br .br
Access control entries. All lists are comma-separated, no spaces are Access control entries. All lists are comma-separated, no spaces are
allowed. Usernames are case sensitive (if used with authtype nbname allowed. Usernames are case sensitive (if used with authtype nbname
username must be in uppercase). Source and target lists may contain username must be in uppercase). Source and target lists may contain
IP addresses (W.X.Y.Z), ranges A.B.C.D - W.X.Y.Z (since 0.8) or CIDRs IP addresses (W.X.Y.Z), ranges A.B.C.D - W.X.Y.Z (since 0.8) or CIDRs
@ -571,16 +576,14 @@ Operation is one of:
.br .br
ADMIN - access to administration interface ADMIN - access to administration interface
.br .br
Weeksdays are week days numbers or periods, 0 or 7 means Sunday, 1 is Monday, 1-5 means Monday through Friday. Timeperiodlists is a list of time
Weeksdays are week days numbers or periods (0 or 7 means Sunday, 1 is Monday, 1-5 means Monday through Friday). Timeperiodlists is a list of time periods in HH:MM:SS-HH:MM:SS format. For example, 00:00:00-08:00:00,17:00:00-24:00:00 lists non-working hours.
periods in HH:MM:SS-HH:MM:SS format. For example, 00:00:00-08:00:00,17:00:00-24:00:00
lists non-working hours.
.br .br
.B parent .B parent
<weight> <type> <ip> <port> <username> <password> <weight> <type> <ip> <port> <username> <password>
.br .br
this command must follow "allow" rule. It extends last allow rule to this command must follow "allow" rule. It extends last allow rule to
build proxy chain. Proxies may be grouped. Proxy inside the build proxy chain. Proxies may be grouped. Proxy inside the
group is selected randomly. If few groups are specified one proxy group is selected randomly. If few groups are specified one proxy
is randomly picked from each group and chain of proxies is created is randomly picked from each group and chain of proxies is created
@ -687,14 +690,14 @@ example:
.br .br
socks socks
.br .br
redirects all SOCKS requests with target port 80 to local HTTP proxy, redirects all SOCKS requests with target port 80 to local HTTP proxy,
local HTTP proxy parses requests and allows only GET and POST requests. local HTTP proxy parses requests and allows only GET and POST requests.
.br .br
parent 1000 http 1.2.3.4 0 parent 1000 http 1.2.3.4 0
.br .br
Changes external address for given connection to 1.2.3.4 Changes external address for given connection to 1.2.3.4
(an equivalent to -e1.2.3.4) (an equivalent to -e1.2.3.4)
.br
Optional username and password are used to authenticate on parent Optional username and password are used to authenticate on parent
proxy. Username of '*' means username must be supplied by user. proxy. Username of '*' means username must be supplied by user.
@ -702,7 +705,8 @@ proxy. Username of '*' means username must be supplied by user.
.br .br
.B nolog .B nolog
<n> <n>
extends last allow or deny command to prevent logging, e.g. .br
extends last allow or deny command to prevent logging, e.g.
.br .br
allow * * 192.168.1.1 allow * * 192.168.1.1
.br .br
@ -712,13 +716,14 @@ nolog
.br .br
.B weight .B weight
<n> <n>
extends last allow or deny command to set weight for this request
.br .br
allow * * 192.168.1.1 extends last allow or deny command to set weight for this request
.br .br
weight 100 allow * * 192.168.1.1
.br .br
Weight may be used for different purposes. weight 100
.br
Weight may be used for different purposes.
.br .br
.B bandlimin .B bandlimin
@ -810,7 +815,7 @@ format:
.B users .B users
username[:pwtype:password] ... username[:pwtype:password] ...
.br .br
pwtype is one of: pwtype is one of:
.br .br
none (empty) - use system authentication none (empty) - use system authentication
.br .br
@ -820,7 +825,7 @@ pwtype is one of:
.br .br
NT - password is NT password (in hex) NT - password is NT password (in hex)
.br .br
example: example:
.br .br
users test1:CL:password1 "test2:CR:$1$lFDGlder$pLRb4cU2D7GAT58YQvY49." users test1:CL:password1 "test2:CR:$1$lFDGlder$pLRb4cU2D7GAT58YQvY49."
.br .br
@ -831,7 +836,7 @@ example:
.br .br
.B flush .B flush
.br .br
empty active access list. Access list must be flushed avery time you creating empty active access list. Access list must be flushed avery time you creating
new access list for new service. For example: new access list for new service. For example:
.br .br
allow * allow *
@ -844,35 +849,36 @@ new access list for new service. For example:
.br .br
socks socks
.br .br
sets different ACLs for sets different ACLs for
.B pop3p .B pop3p
and and
.B socks .B socks
.br .br
.B system .B system
<command>
.br .br
execute system command execute system command
.br .br
.B pidfile .B pidfile
<filename> <filename>
.br .br
write pid of current process to file. It can be used to manipulate write pid of current process to file. It can be used to manipulate
3proxy with signals under Unix. Currently next signals are available: 3proxy with signals under Unix. Currently next signals are available:
.br .br
.B monitor .B monitor
<filename> <filename>
.br .br
If file monitored changes in modification time or size, 3proxy reloads If file monitored changes in modification time or size, 3proxy reloads
configuration within one minute. Any number of files may be monitored. configuration within one minute. Any number of files may be monitored.
.br .br
.B setuid .B setuid
<uid> <uid>
.br .br
calls setuid(uid), uid must be numeric. Unix only. Warning: under some Linux calls setuid(uid), uid must be numeric. Unix only. Warning: under some Linux
kernels setuid() works onle for current thread. It makes it impossible to suid kernels setuid() works onle for current thread. It makes it impossible to suid
for all threads. for all threads.
@ -880,31 +886,31 @@ for all threads.
.B setgid .B setgid
<gid> <gid>
.br .br
calls setgid(gid), gid must be numeric. Unix only. calls setgid(gid), gid must be numeric. Unix only.
.br .br
.B chroot .B chroot
<path> <path>
.br .br
calls chroot(path). Unix only. calls chroot(path). Unix only.
.SH PLUGINS .SH PLUGINS
.br .br
.B plugin .B plugin
<path_to_shared_library> <function_to_call> [<arg1> ...] <path_to_shared_library> <function_to_call> [<arg1> ...]
.br .br
Loads specified library and calls given export function with given arguments, Loads specified library and calls given export function with given arguments,
as as
.br .br
int functions_to_call(struct pluginlink * pl, int argc, char * argv[]); int functions_to_call(struct pluginlink * pl, int argc, char * argv[]);
.br .br
function_to_call must return 0 in case of success, value > 0 to indicate error. function_to_call must return 0 in case of success, value > 0 to indicate error.
.br .br
.B filtermaxsize .B filtermaxsize
<max_size_of_data_to_filter> <max_size_of_data_to_filter>
.br .br
If Content-length (or another data length) is greater than given value, no If Content-length (or another data length) is greater than given value, no
data filtering will be performed thorugh filtering plugins to avoid data data filtering will be performed thorugh filtering plugins to avoid data
corruption and/or Content-Length chaging. Default is 1MB (1048576). corruption and/or Content-Length chaging. Default is 1MB (1048576).