Skip to main content

[SYSTEM]

Describes the default parameters for the Web Gateway. The CSP.ini file contains only one [SYSTEM] section.

Available Parameters

RELOAD

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.

DPAPI

(For Web Gateways installed on a Windows machine only.) A flag that determines whether or not password fields within the CSP.ini file are automatically encrypted using Microsoft’s Data Protection API (DPAPI). Password encryption is enabled by default and 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.

MAX_CONNECTIONS

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

MAX_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.

SM_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.

SM_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_SM_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

A list of IP addresses corresponding to machines permitted to access the Web Gateway management pages. You can use the wildcard character (*) can be used 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.

Accept_X_Forwarded_For

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).

System_Manager_UNPW_Override

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).

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.

Timeout_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.

Env_Parameters
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. This parameter is not specified by default, which means 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).

SA_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.

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.

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.

WS_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

The path and filename for the custom page the Web Gateway should display when it encounters an internal error.

Server_Busy

The path and filename for the custom page the Web Gateway should display when all available connections are in use.

Server_Unavailable

The path and filename for the custom page the Web Gateway should display when the InterSystems IRIS application server (or application) has been deliberately disabled from within the configuration.

Server_Timeout

The path and filename for the custom page the Web Gateway should display when a request times out.

Connection_Closed

The path and filename for the custom page the Web Gateway should display when a user logs out of a state-aware session.

Default_Server

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.

FeedbackOpens in a new tab