CSP Gateway Configuration Guide - InterSystems Documentation

Configuring the Web Server and the CSP Gateway
Both the CSP module and the CGI executables are small functional blocks designed to communicate exclusively with the
NSD. In this context, the NSD is responsible for providing the CSP Gateway’s core functionality and persistent connections
to Caché. The CSP module offers better performance than the CGI-based equivalent. The CSP module is attached directly
to the hosting Apache processes whereas the CGI module must be started in its own process. For small systems, the performance
difference between the CSP module and CGI executable may not be that noticeable. However, the difference becomes
more marked as the load on the system increases and the overhead of starting and managing the extra number of processes
that are required by the CGI-based connectivity model becomes apparent.
1.4 Configuring the Web Server and the CSP Gateway
The Caché installation performs web server and CSP Gateway configuration for common web servers and operating systems.
After installing Caché and the CSP Gateway, consult the sections in this book relevant to your system to map file extensions
for your system. This book also has configuration information for atypical CSP Gateway configurations.
To install the CSP Gateway on a remote server (that is, a system that is not running an instance of Caché), you can use one
of two methods. On the remote server, you can
• Run the Caché installation script and select to install Web Server only or
• Run the standalone CSPGateway installation script. The script asks for information about the remote Caché server:
name, adddress, port, and optional password. The script automatically configures csp.ini based on this information.
After installing the CSP Gateway, consult the sections in this book to map file extensions for your system.
Note:
To prevent runtime errors, for High Availability configurations running over CSP, InterSystems recommends that
you use a hardware load balancer with sticky session support enabled. For more information, see the section “CSP
Gateway Considerations” in the Caché High Availability Guide.
1.5 Gateway Management Module configuration
Gateway architectures that work directly to a hosting web server’s API typically consist of two modules: A Management
Module (for example, CSPmsSys.dll) and a runtime module (for example, CSPms.dll). The runtime Module is responsible
for processing requests for CSP files and the Management Module provides the Gateway’s Management interface. In the
CSP Gateway, the runtime Module assumes responsibility for loading and routing management requests to the management
module. All requests for the CSP Gateway (CSP and management) are processed by the runtime Module. The Management
Module must be installed in the same location as the runtime Module
1.6 File Types Served by CSP
Files of type .csp, .cls and .zen are processed in Caché by CSP. All other files (static files) can be served by the web server
or CSP. CSP can serve any type of file that is placed in the CSP applications path (including static files). Setting up CSP
to serve static files simplifies the web server configuration for CSP applications because you, thus, do not need to create
aliases in the web server configuration to represent the locations where an application’s static files are held. Setting up CSP
to serve static files resolves issues of contention when a single (that is, common) web server serves two different versions
of Caché, each requiring different versions of certain static files (for example, hyperevent broker components).
CSP Gateway Configuration Guide 5