Documentation
Current Version: 04.02.00
Released: 11/08/07
The following options are valid for OneGate's configuration files:
When OneGate is activated, it performs a check to make sure that no more than a configurable number of instances of itself are running at the time. If it detects that number are already running, it will retry the condition a configurable amount of times. This option sets the granularity for these retries. The argument is an integer expression denoting seconds. The default for this option is 1 second. This option may be defined at the global and application levels.
The companion to wait_interval, this option denotes the number of retries to attempt before giving up and sending the lock count error message file to the remote client. The formula for total time spent retrying is wait_interval * wait_attempts. The default for this option is 30 attempts. This option may be defined at the global and application levels.
This option dictates whether HTTP File Uploads are accepted. The option takes the words yes or no. The default is no. This option may be defined at the global and application levels.
This option sets the maximum size in bytes to accept in a single uploaded file. This option takes an integer value or the word unlimited. The default setting is 102400, which is 100K. This option may be defined at the global and application levels. Be careful about using the unlimited option needlessly, as someone could fill up your disk quite quickly. It is included for such purposes as doing web-based remote disk space hosting. This option may be set at both the global and application levels.
This option sets the maximum number of concurrent instances of OneGate that may run at once. It is intended to provide a "throttle" mechanism which may be used to guarantee that you do not exceed an application's user license count, to limit the amount of "seats" of a license count that are eaten up by web application use, or to reduce load on the system for intensive applications. This option takes an integer argument. The default for this option is 128. This option may only be set at the global level.
This option specifies whether OneGate should reveal the exact value of which fields are missing, extra, or misconfigured, and/or which commands fail on execution. This functionality is to be considerd insecure for normal operation, and should only be used during development. When not actively being used for debugging, this functionality should be disabled to enhance security. When enabled, this option disables any custom error pages you have defined (global or application). This option takes the words yes or no. The default is no. This option may be defined at the global and application levels.
This option controls how OneGate logs access to program sets. If set to unlimited or omitted altogether, OneGate will log all access information. If set to 0 (zero), logging will be disabled. If set to any positive integer, logging will be constrained to that number of lines per logfile, and will roll the oldest entries off to make room for newer entries. The default is unlimited. This option may be defined at the global and application levels.
This option sets the MIME type of a successful response from the program set. This option may be set at the global and application levels. In addition, please note that if the %t or ONEGATE_MIMEFILE are written to, this option is overridden by the value placed in that file, in order to preserve legacy functionality from configurations deployed before this option existed.
This option sets the MIME type of the error message delivered when a session could not obtain a session due to system use exceeding the combined effects of max_session_count, wait_attempts, and wait_interval. The default is text/html in regular testbeds, and applicatiion/xml in _ajax testbeds. This option may only be set at the global level.
This option sets the MIME type of an error response from the program set. This option may be defined at both the global and application levels.
This option sets the MIME type of the response given when a host is denied by the host.access file. This option may be defined at both the global and application levels.
This option sets the MIME type of the response given when a connection is denied by the allowed.users file. This option may be defined at both the global and application levels.
This option sets the MIME type of the response given when a connection is denied by the nologin file. This option may be defined at both the global and application levels.
This option determines whether the special token values will be substituted into the response in event of an error response. The option takes the words yes or no. The default is no. This option may be defined at the global and application levels.
This option determines whether the special token values will be substituted into the response in event of a successful program set run. The option takes the words yes or no. The default is no. This option may be defined at the global and application levels.
This option determines whether fields may be wildcarded in the fields file for a program set. This facility allows you to specify one pattern a single time to allow many similar fields in one fell swoop. If turned on, this facility allows arbitrary portions of field names to be included only in optional fields. Wildcarding is done in the form of an asterisk. At the position of an asterisk, any valid field name characters may appear, but to not have to appear. Thus, the definition of an optional field "myfield*" would match "myfield", "myfield_23", etc. The option takes the words yes or no. The default is no. This option may be defined at the global and application levels.
This option determines whether the header Cache-Control: no-cache is utilised. If set to yes, the header is not given to clients. If st to no, the header is delivered. The option takes the words yes or no. The default is yes to maintain backwards compatability with 3.x. This should be set to no for AJAX applications. This option may be defined at the global and application levels.
This option determines whether the temporary working files usually removed from the spool directory for the program set are removed at the end of the run. The option takes the words yes or no. The default is no. This option may be defined at the global and application levels.
This option determines whether the original filename for file uploads is stripped to the basename or not. A setting of yes will strip the filename to its basename.. The option takes the words yes or no. The default is no. This option may be defined at the global and application levels.