Web Gateway Configuration File (CSP.ini) Parameter Reference

The InterSystems® Web Gateway maintains its configuration information in its CSP.ini file, which is located in the same directory as the Web Gateway binaries.

In most cases, InterSystems recommends using the Web Gateway management pages or Web Gateway Registry methods to modify the Web Gateway configuration, rather than editing the CSP.ini file directly. However, this is impractical for some use cases. For example, to initialize pre-configured webgateway containers automatically as part of a scalable Kubernetes cluster, it is necessary to leverage the CSP.ini merge feature to populate each Web Gateway’s CSP.ini file upon deployment. See Using the InterSystems Web Gateway Container for details regarding this use case.

After you make changes to CSP.ini parameters, you can reload the Web Gateway configuration procedurally using the Web Gateway Registry %CSP.Mgr.GatewayMgr.ActivateCSPIni()Opens in a new tab method or by adding the RELOAD flag to the [SYSTEM] section of the CSP.ini file.

The parameters in the CSP.ini file are organized into functional sections of several types. This reference documents the contents of the CSP.ini file for each section.

• [SYSTEM] – Describes the default parameters for the Web Gateway. The CSP.ini file contains only one [SYSTEM] section.
• [<server>] – Describes the server access profile with the name <server>. The CSP.ini file contains one [<server>] section for each server access profile defined within the Web Gateway configuration.
• [SYSTEM_INDEX] – Describes the status (Enabled or Disabled) for each server access profile defined within the Web Gateway configuration. The CSP.ini file contains only one [SYSTEM_INDEX] section.
• [APP_PATH:<appPath>] – Describes the application access profile for the application path <appPath>. The CSP.ini file contains one [APP_PATH:<appPath>] section for each application access profile defined within the Web Gateway configuration.
• [APP_PATH_INDEX] – Describes the status (Enabled or Disabled) for each application access profile defined within the Web Gateway configuration. The CSP.ini file contains only one [APP_PATH_INDEX] section.