bughz/3proxy
1
0
Fork 0
mirror of https://github.com/3proxy/3proxy.git synced 2025-02-23 18:45:40 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

minor documentations updates

Browse Source
This commit is contained in:
z3APA3A 2016-01-15 03:06:06 +03:00
parent 0be4ee932b
commit 08be6b9f98
1 changed files with 154 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
man/3proxy.cfg.3
View File

@ -12,6 +12,7 @@ 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
@ -26,6 +27,7 @@ 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
@ -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
@ -231,7 +236,7 @@ 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
@ -366,7 +371,6 @@ 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).
@ -374,7 +378,7 @@ nscache6 for IPv6). Cachesize usually should be large enougth
.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
@ -383,7 +387,7 @@ 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+.
@ -444,6 +448,7 @@ of the configuration file.
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
@ -571,10 +576,8 @@ 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
@ -694,7 +697,7 @@ local HTTP proxy parses requests and allows only GET and POST requests.
.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,6 +705,7 @@ proxy. Username of '*' means username must be supplied by user.
.br .br
.B nolog .B nolog
<n> <n>
.br
extends last allow or deny command to prevent logging, e.g. extends last allow or deny command to prevent logging, e.g.
.br .br
allow * * 192.168.1.1 allow * * 192.168.1.1
@ -712,6 +716,7 @@ nolog
.br .br
.B weight .B weight
<n> <n>
.br
extends last allow or deny command to set weight for this request extends last allow or deny command to set weight for this request
.br .br
allow * * 192.168.1.1 allow * * 192.168.1.1
@ -851,6 +856,7 @@ and
.br .br
.B system .B system
<command>
.br .br
execute system command execute system command