[CTX] [ALL] Parameters Category

---

PARAMETERS

In the following list, parameters marked with "*" are repeatable like name=value1 name=value2 ... name=valueN. If the same parameter is defined both in environment and command line, the one in command line precedes to the one in environment. If other non-repeatable names are repeated, the lastly given value is taken.

Parameters marked with "+" can NOT be given in "+=parameters" scripts. Those parameters (including DGROOT, CHROOT, LDPATH, and DYLIB) need to be specified in command-line arguments or "implanted" into the executable file of DeleGate with the -Fimp option.

General

Parameters in this category are used to control common attributes of DeleGate independently of the purpose of usage or target application protocol.

	name	value format	functionality
--	----------	------------------	----------------------------------
	SERVER	proto://host:port	client-side protocol and default server
	ADMIN	user@host.domain	E-mail addr. of the admin. of this DeleGate
+	OWNER	user[/group]	with who's access right this DeleGate runs
*	CRON	crontab-spec	cron compatible scheduler of actions
*	INETD	inetd-conf	inetd like server configuration notation
*	HOSTLIST	name:hostList	define a named HostList
*	CLUSTER	protocol:hostList	define a cluster of servers
*	CMAP	map-spec	mapping table about the current connection
+	DYLIB	patternList	file-name patterns of dynamic libraries
+	LDPATH	dir;dir;...	search path for DYLIB
	LIBPATH	dir:dir:...	search path for library files
	DATAPATH	dir:dir:...	search path for data files
	DGPATH	dir:dir:...	search path for SUBSTITUTION resources
*	DYCONF	conditions:path	dynamic configuration based on request
	DGCONF	dir/file	the file of configuration parameters
	DGOPTS	option;option;...	list of command line options
	PORT	portList	reserve entrance ports like -P option

Routing

These parameters control the indirect routing toward the target server exploiting upstream proxies or Socks servers on the way to servers. If any target hosts are directly reachable on IP level from your DeleGate's host, these parameters may not necessary. Besides these parameters, ICP and MOUNT have something to do with routing based on application protocols.

--	----------	------------------	----------------------------------
*	FORWARD	proxy-_-proto:dst:src	forward to proxy when from src to dst in proto
*	ROUTE	proxy-_-dst:src	forward to proxy when from src to dst
*	MASTER	host:port	connect via the upstream DeleGate
	MASTERP	[host:port]	invoke a MASTER private to this DeleGate
*	PROXY	host:port	connect via the upstream proxy
*	YYMUX	host[:port]	connect via the YYMUX server
*	SOCKS	host[:port]	connect via the socks server
	SSLTUNNEL	host:port	connect via the SSL tunnel for HTTPS
	VSAP	host:port	accept/connect via a remote host
*	CONNECT	ca,ma,di,so,...	the order of trials of connection types
*	SRCIF	host[:port]	source address of connection to server
	TUNNEL	type:scriptPath	connect via the tunnel on serial line
	RPORT	{tcp|udp}[:host]	return port from the MASTER-DeleGate

Access control

These parameters control who (client) can access to what (server) and how (protocol). The basic policy of default access control is designed so that clients on networks local to the host of DeleGate are permitted to access to any server. Note that the default value of REMITTABLE depends on SERVER, and IP-level reachability to DeleGate on a multi-homed host may be restricted by -Phost:port option.
You must most carefully configure these parameters so that this DeleGate does not introduce a security hole, especially when it is running on a host which is directly accessible to/from the internet.

--	----------	------------------	----------------------------------
*	PERMIT	proto:dst:src	protocols/servers/clients to be permitted
*	REJECT	proto:dst:src	protocols/servers/clients to be rejected
	REMITTABLE	ProtoList	protocols remittable to the server
*	REACHABLE	dstHostList	only specified server hosts are reachable
*	RELIABLE	srcHostList	accept only from the specified client hosts
*	SCREEN	{reject|accept}	screen client host
*	RELAY	proxy|delegate|no	restrict proxying modes
*	AUTH	what:aproto:users	authorized users for remote administration
*	AUTHORIZER	serv:proto:dst:src	authentication server
*	MYAUTH	user:pass:proto:dst:src	authentication client
	RIDENT	client|server	forward socket addr. to upstream DeleGate

Resource usage restriction

These parameters can be useful where available resources are in severe condition; when the host of DeleGate is heavy loaded, network bandwidth is narrow, or response from server can be slow.

--	----------	------------------	----------------------------------
*	MAXIMA	what:number	maxima of parallel sessions and etc.
*	TIMEOUT	what:seconds	timeout of connection and etc.
*	DELAY	what:seconds	delay for penalty
*	CHOKE	Delay:Clnt:UA:Ref	choking robots

Cache control

Enable or disable cache and specify validity of cached data. Usage of cache is controlled in context of routing by CONNECT too. Removing stale cache file can be done periodically using CRON.

--	----------	------------------	----------------------------------
	CACHE	do|no|ro	control to do cache or not
*	EXPIRE	days|hours|secs	expiration of the cached data
	CACHEFILE	fileNameSpec	in which file cache data are stored
*	ICP	icpClientConfig	configuration as an ICP client

Mount

Provide virtual view for other server(s) by URL mapping, filtering and aliasing resource names, to merge multiple servers, to translate between different protocols, to export internal servers, and so on. Also MOUNT can be used to customize or replace built-in icons and messages.

--	----------	------------------	----------------------------------
*	MOUNT	"vURL rURL opt"	map virtual URL to/from real URL
*	URICONV	convList:attrList	control URI rewriting with MOUNT
	BASEURL	URL	the base of (virtual) URL of this server
	DELEGATE	host:port	limited form of BASEURL

Data conversion

Parameters to control built-in converter for text type data.

--	----------	------------------	----------------------------------
*	CHARCODE	JIS|EUC|SJIS|UTF8	character conversion for Japanese text
*	CHARMAP	[jis|ucs]:a-z/A-Z	map character to character in text data
	HTMLCONV	deent|enent|pre	decode/encode between HTML & plain text
	MIMECONV	thru|charcode	control MIME encoder/decoder

Filter control

Insert a filter program on the way to/from client or server to convert data transmitted between them.

--	----------	------------------	----------------------------------
	FCL	filterCommand	filter between client and DeleGate
	FTOCL	filterCommand	filter from DeleGate to client
	FFROMCL	filterCommand	filter from client to DeleGate
	FSV	filterCommand	filter between server and DeleGate
	FTOSV	filterCommand	filter from DeleGate to server
	FFROMSV	filterCommand	filter from server to DeleGate
	FMD	filterCommand	filter between MASTER and this DeleGate
	FTOMD	filterCommand	filter from this DeleGate to MASTER
	FFROMMD	filterCommand	filter from MASTER to this DeleGate
	XCOM	filterCommand	execute a command as a server
	XFIL	filterCommand	execute a filter as a server

Local file usage

All of local files are integrated under DGROOT by default. You should not change nor specify these parameters if not necessary.

--	----------	------------------	----------------------------------
+	CHROOT	dirPath	change the root of file system at start
+	DGROOT	dirPath	root directory of all of DeleGate files
*+	SHARE	dirPatternList	files to be shared among users
+	UMASK	mask	umask value in octal
	VARDIR	dirPath	default base of log and cache
	CACHEDIR	dirPath	where cache files are placed
	ADMDIR	dirPath	where dynamic administration files are
	ETCDIR	dirPath	where persistent management files are
	LOGDIR	dirPath	where DeleGate logs are
	LOGFILE	LogFilename	where DeleGate makes logging
	PROTOLOG	LogFilename	httpd or wu-ftp compatible log file
	ERRORLOG	LogFilename	where DeleGate make error logging
	TRACELOG	LogFilename	where signal trace (by -T) is put
	EXPIRELOG	LogFilename	file which records expire log
	WORKDIR	dirPath	where DeleGate should dump core (-_-;
	ACTDIR	dirPath	where temporary files are placed
	TMPDIR	dirPath	where invisible temporary files are placed
	PIDFILE	fileName	where the DeleGate's PID is recorded
	COUNTERDIR	dirPath	base directory of counters
	COUNTER	CounterOptions	access counters

Host name resolution

Resolve host name to/from IP address using DNS, NIS or local file.

--	----------	------------------	----------------------------------
*	HOSTS	host/addr,...	private host/address mapping
	RESOLV	file,nis,dns,sys	the order of resolvers to be used
	RES_WAIT	sec:host	wait for resolver to be ready
	RES_CONF	URL	where resolv.conf is
	RES_NS	host[:port]	DNS server to be used
	RES_AF	46 | 64 | 4 | 6	Address families (IPv4/v6) to be retrieved
	RES_RR	HostList	enable Round Robin of IP-addresses
	RES_VRFY	""	enable double check of reverse resolution
	RES_DEBUG	number	debugging level of name resolution

Protocol specific

--	----------	------------------	----------------------------------
*	HTTPCONF	what:conf	HTTP specific configuration
	FILETYPE	suffix:fileType	mapping from filename to data type & etc.
	CGIENV	name,name,...	environment variables to be passed to CGI
*	ICPCONF	icpServerConfig	configuration as an ICP server
*	FTPCONF	what[:conf]	FTP specific configuration
*	NNTPCONF	what:conf	NNTP specific configuration
*	SMTPCONF	what:conf	SMTP specific configuration
	SMTPGATE	dirPath	SMTP to SMTP/NNTP g.w. configuration
*	DNSCONF	what:conf	configuration as a DNS server
*	SOCKSTAP	proto[:[dst][:src]]	interpret the protocol over SOCKS

---