[SYSTEM]

A flag that instructs the Web Gateway caretaker daemon to reload and reactivate the Web Gateway configuration. The caretaker daemon then removes the flag. To procedurally trigger a reload using this flag, specify RELOAD=1.

A flag that determines whether the Web Gateway writes updates to its configuration file, and how. By default (READONLY=0), it is possible to update the CSP.ini file using the Web Gateway management page. The Web Gateway updates the corresponding file parameters when it loads these configuration changes; it also updates parameters which record the version number and time of the update. When you specify READONLY=1, the Web Gateway maintains these version and time parameters in the runtime parameters file (CSPRT.ini) instead. When you specify READONLY=2, the CSP.ini file is strictly read-only; updates using the Web Gateway management pages are disabled.

It may be necessary to set the READONLY flag when you are deploying the Web Gateway in a locked-down container environment, where it is common to restrict access to configuration files such as CSP.ini at the operating system level. To take effect, the READONLY flag must be set before you start (or restart) the web server and initialize the Web Gateway.

A flag that determines whether or not a connected InterSystems server instance can manage the Web Gateway using Web Gateway Registry methods. By default, this is Enabled; specify Disabled to disable access to the Web Gateway using the Web Gateway Registry. Because server instances manage shared WebSocket connections using Web Gateway Registry methods, the Web Gateway only allows non-shared WebSocket connections when REGISTRY_METHODS=Disabled.

(For Web Gateways installed on a Windows machine only.) A flag that allows you to disable the encryption of password fields within the CSP.ini file using Microsoft’s Data Protection API (DPAPI). By default, the flag is not set and DPAPI password encryption is enabled. InterSystems recommends that users leave it enabled. Where no alternative solution exists, you can disable DPAPI password encryption by specifying DPAPI=Disable.

(Instance Host Name) The network host name for this Web Gateway (server_name:port), if different from the default. This parameter is transmitted to InterSystems IRIS along with the request data as system variable CSPIHN.

(Maximum Connections) The maximum number of connections that this Web Gateway can establish to InterSystems IRIS application server processes. The default value is 1024.

(Maximum Cache Size) The maximum amount of shared memory allocated for caching application response data, defined in kilobyes (128K) or megabytes (16M). The default value is 256K.

(Web Server ID Cookie) Whether the Web Server ID Cookie (CSPWSERVERID) is Enabled or Disabled for load balancers to implement passive cookie affinity. The default value is Enabled.

(Access to these forms) Whether access to the Web Gateway management pages is Enabled or Disabled. The default value is Enabled.

(Username) The username required to access the Web Gateway management pages, if specified.

(Password) The password required to access the Web Gateway management pages, if specified. In most cases, the Web Gateway encodes a password which is supplied to this field as plain text when it starts (or restarts). However, if the password begins with 1 or PBKDF2|, you must encode it manually using the CSPpwd utility and then supply the encoded password to this field.

(Session Timeout) When you have configured authentication for the Web Gateway management pages, the allowable idle time before the expiration of an authenticated session, in seconds. The default value is 28800.

(Custom Login Form) Full file path or relative URL path to a custom login form that controls access to the Web Gateway management pages

(System Manager Machine/s) A list of IP addresses corresponding to machines permitted to access the Web Gateway management pages. You can use the wildcard character (*) to specify a range of addresses—for example, 190.8.7.* or *.*.*.*. By default, access is only granted to the host machine. See Enabling Access from Additional Client Addresses for further guidance in configuring this parameter. By default, only the local machine is permitted.

When specified, whether to allow access to the Web Gateway management pages in response to requests forwarded by a proxy server from an origin IP address specified by the System_Manager parameter. Allowed values are Enabled (to accept) and Disabled (to deny).

When specified, determines whether the Web Gateway management pages require a username and password for machines specified by the System_Manager parameter. Allowed values are 1 (override enabled) or 0 (override disabled). By default, override is disabled—that is, a username and password are required.

(Server Response Timeout) The maximum amount of time allowed for a target InterSystems IRIS application server to respond to a request from the web server, in seconds. The minimum allowable value is 5. The default value is 60.

(Queued Request Timeout) The maximum amount of time allowed for a request to remain in a queue waiting for an appropriate InterSystems IRIS server, in seconds. The minimum allowed value is 5. The default value is 60.

(No Activity Timeout) For stateless connections, the maximum amount of time before the Web Gateway closes an idle connection to an InterSystems IRIS application server, in seconds. The default value is 86400.

(Apply timeout to all Connections) When specified, determines whether to terminate any connection which remains idle for the length of time specified by the No_Activity_Timeout parameter, including connections in the minimal connection pool. By default, the Web Gateway does not apply this timeout policy.

(Event Log Level) The log level for the Web Gateway Event Log. (See Event Logging Parameters for details.)

(Event Log File) When specified, determines an alternative filesystem location and file name for storing the Web Gateway Event Log. If not specified, the Web Gateway saves the log as CSP.log within the same directory as the Web Gateway binary files.

(Event Log Rotation Size) When specified, determines the maximum size the Event Log file can reach before Event Log rotation takes place. This quantity can be defined in bytes (128000, with no suffix), kilobytes (256K), or megabytes (8M). The minimum allowed value is 100K. By default, this parameter is not specified; this means that you must clear the Event Log file manually.

(Maximum Logged Request Size) Maximum volume of data to log for any given HTTP request. The minimum allowed value is 40K. The default value is 256K.

(Retain All Log Files) When specified, determines whether to save all old log files which Event Log rotation generates, instead of only the most recent. Allowed values are Enabled (to retain all) or Disabled (to retain only one). By default, the Web Gateway retains old log files.

(Preserve Mode Exclude File Types) When specified, preserves asynchronous processing for static files of the specified types for state-aware applications (as well as stateless applications). This parameter accepts a space-separated list of file type extensions.

(Web Document Root) When specified, provides the full physical path to the web server’s web document root directory. This parameter is only required for web applications which render content using the Microsoft ASP engine.

(Temp ASP Directory) When specified, provides the full physical path to a directory where the Web Gateway can temporarily store Microsoft ASP content. This parameter is only required for web applications which render content using the Microsoft ASP engine.

(Service Status) For Web Gateway implementations which use the Network Service Daemon (NSD), determines whether the internal HTTP server for the NSD is enabled to respond to raw HTTP requests. Allowed values are Enabled or Disabled. The default value is Enabled.

For security reasons, InterSystems recommends disabling this facility.

(NSD Document Root) In rare cases where the NSD serves as a stand-alone server, provides the full physical path to the web document root directory for the NSD.

(Server Error) When specified, provides a path and filename for the custom page that the Web Gateway should display when it encounters an internal error.

(Server Busy) When specified, provides a path and filename for the custom page that the Web Gateway should display when all available connections are in use.

(Server Unavailable) When specified, provides a path and filename for the custom page that the Web Gateway should display when the InterSystems IRIS application server (or application) has been deliberately disabled from within the configuration.

(Server Timeout) When specified, provides a path and filename for the custom page that the Web Gateway should display when a request times out.

(Connection Closed) When specified, provides the path and filename for the custom page that the Web Gateway should display when a user logs out of a state-aware session.

Specifies the server to which the Web Gateway directs requests when the application access profile for an application path specifies no destination server. By default, this parameter specifies the automatically-generated LOCAL server access profile.