CSP Gateway Configuration Guide
[Home]  [Next]
InterSystems: The power behind what matters   
Class Reference   

Preface : 
Chapter 1: 
  1.1 Who Should Read this Document
1.2 CSP Documentation
1.3 Conventions Used in this Document
1.3.1 Gateway components and physical installation paths
1.4 Supported Web Servers
1.5 Configuring the Web Server and the CSP Gateway
1.5.1 Configuring the CSP Gateway for Ensemble
1.5.2 Gateway Management Module configuration
1.5.3 File Types Served by CSP
1.5.4 Serving Static Files from Caché
1.5.5 Hybrid Multi-Process/Multi-Threaded Web Server Architecture
1.5.6 Gateway Registry
1.5.7 Enable Sticky Sessions on Hardware Load Balancer on High Availability Solutions
1.5.8 Enable Script to Reactivate Gateway Configuration
1.6 Private Web Server and Management Portal
1.6.1 Building the Private Web Server
1.6.2 Managing the Private Web Server
1.6.3 Limitations of the Private Web Server
Chapter 2: 
  2.1 Microsoft IIS All Versions
2.1.1 Summary of Configuration
2.1.2 Setting Permissions for the Gateway Components
2.1.3 Configuring the CSP Application Path
2.1.4 Enabling URLs with /bin
2.1.5 Restarting IIS
2.1.6 Troubleshooting
2.2 Microsoft IIS 7 or Later
2.2.1 Install Locations for IIS 7
2.2.2 Recommended Option: Using Native Modules (CSPms*.dll)
2.2.3 Configuring IIS to Return SOAP Fault Details
2.3 Microsoft IIS 6 or Earlier
2.3.1 Install Locations for IIS 6
2.3.2 Recommended Option: IIS and ISAPI Modules (CSPms.dll)
2.4 Apache Servers
2.4.1 Install Locations with Apache Servers (All Options)
2.4.2 Recommended Option: Apache API Modules (CSPa24.dll)
2.5 Nginx Servers
2.5.1 Installation
2.5.2 Building the Nginx web server for CSP
2.5.3 Using the Universal CSP Gateway Modules (CSPx*.dll)
2.5.4 Building Nginx to Work with the CSP NSD Component
Chapter 3: 
  3.1 Apache Servers
3.1.1 Install Locations Apache UNIX®, Linux, Mac OS (Recommended Option)
3.1.2 Recommended Option: Apache API Module without NSD (CSPa24.so)
3.2 Sun Web Servers
3.2.1 Install Locations for Sun Web Servers (Recommended Option)
3.2.2 Recommended Option: NSAPI Modules (CSPn3.so)
3.3 Nginx Web Servers
3.3.1 Installation
3.3.2 Building the Nginx Web Server for CSP
3.3.3 Using the Universal CSP Gateway Modules (CSPx*.so)
3.3.4 Building Nginx to Work with the CSP NSD Component
Chapter 4: 
  4.1 Installation on OpenVMS (All Connectivity Options)
4.2 Recommended Option: OpenVMS and Apache API with NSD (MOD_CSP.EXE)
4.2.1 Registering Additional File Types with CSP
4.2.2 Operating and Managing the Gateway with OpenVMS API and NSD
4.3 Locked-down Apache Environments for OpenVMS
4.3.1 Configuration for the Recommended Option: Dynamic Apache API Module with NSD (mod_csp.exe)
4.3.2 Configuration for Alternative Option 1: CGI Modules with NSD (nph-CSPcgi.exe)
4.4 Operating the Network Service Daemon (NSD)
4.4.1 Starting the NSD on Alternative TCP port
Chapter 5: 
  5.1 CSP Web Gateway Management Page
5.1.1 Localization of the CSP Web Gateway Management Page
5.1.2 Security Considerations with CSP Web Gateway Management Page
5.1.3 Checking System Status
5.1.4 Closing Connections Manually
5.1.5 Testing Server Connections
5.1.6 Viewing the Event Log
5.1.7 Using the HTTP Trace Facility
5.1.8 Configuring Default Parameters
5.1.9 Configuring Server Access
5.1.10 Configuring Application Access
5.1.11 About CSP Gateway Page
5.2 CSP Gateway and Security
5.2.1 Gateway Security Parameters
5.2.2 Minimal Connection Security
5.2.3 Simple Username- and Password-based Authentication
5.2.4 Kerberos-based Authentication and Data Protection
5.2.5 SSL-based Authentication and Data Protection
5.3 CGI Environment Variables
5.4 HTTP Response Headers
5.5 Making a CSP Page the Home Page for the Web Server
5.5.1 Internet Information Services
5.5.2 Sun Web Servers
5.5.3 Apache Servers
5.6 Compressing the Response to Requests for CSP Forms (GZIP/ZLIB)
5.6.1 Installing the GZIP/ZLIB Library
5.6.2 Using the GZIP/ZLIB Library
5.6.3 Specifying Compression for Individual Pages
5.6.4 Specifying Compression for All Pages within an Application Path
5.6.5 Monitoring
5.7 CSP Page Output Caching
5.7.1 %response.Expires Property
5.7.2 %response.VaryByParam Property
5.7.3 Preserving the User’s Session ID for Cached Pages
5.8 CSP with Microsoft Active Server Pages (ASP) and VBScript
5.8.1 Client-side VBScript in CSP
5.8.2 Server-side VB-Script in CSP (Serving ASP Content through CSP)
5.9 Implementing HTTP authentication for CSP applications
5.9.1 Standard HTTP authentication in Apache (mod_auth)
5.9.2 Authenticating in CSP at the Same Time as the Request is Processed.
5.9.3 Authenticating in CSP before the Request is Processed.
5.10 Mirrored Configurations, Failover, and Load Balancing
5.10.1 Load Balancing and Failover Between Multiple Web Servers
5.10.2 Load Balancing and Failover Between Multiple Caché Server Instances
5.10.3 Mirrored Configurations
5.11 Process Affinity and State-Aware Mode (Preserve Mode 1)
5.11.1 Launching State-Aware Mode
5.11.2 Maintaining State-Aware Mode and Responding to Errors
5.11.3 Terminating State-Aware Mode
5.12 Gateway Registry in Caché
5.12.1 Forcing the Gateway to Reload Its Configuration
5.13 Using WebSockets (RFC 6455)
5.13.1 WebSockets Protocol
5.13.2 WebSockets Client Code (JavaScript)
5.13.3 WebSockets Server Code (CSP)
5.13.4 WebSockets Server Example
5.13.5 WebSockets Server Asynchronous Operation
5.14 Option for Automated Deployment Sites (Such As Cloud)
Appendix A: 
  A.1 Using the Network Service Daemon (NSD)
A.1.1 When to Use the NSD
A.1.2 NSD Module Install Locations
A.1.3 Operating the NSD
A.2 Alternative Options for IIS7 or Later
A.2.1 Installing the ISAPI and CGI Services
A.2.2 Alternative Option 1: Using the ISAPI Modules (CSPms*.dll)
A.2.3 Alternative Option 2: Using a Native Module with the NSD (CSPcms.dll)
A.2.4 Alternative Option 3: Using an ISAPI Module with the NSD (CSPcms.dll)
A.2.5 Alternative Option 4: Using the CGI Modules with the NSD (nph-CSPcgi*.exe)
A.3 Alternative Options for IIS6 or Earlier
A.3.1 Using the ISAPI Filter (CSPmsf1.dll)
A.3.2 Alternative Option 1: IIS and ISAPI Module with NSD (CSPcms.dll)
A.3.3 Alternative Option 2: IIS and CGI Modules with NSD (nph-CSPcgi.exe)
A.4 Alternative Options for Windows Apache
A.4.1 Install Locations
A.4.2 Alternative Option 1: Apache and CGI Modules with NSD (nph-CSPcgi.exe)
A.4.3 Alternative Option 2: Apache API Module with NSD (mod_csp.dll)
A.4.4 Alternative Option 3: Apache and ISAPI Modules (CSPms.dll)
A.4.5 Locked-down Apache Environments for Microsoft Windows
Appendix B: 
  B.1 Using the NSD on UNIX®, Linux, Mac OS X
B.1.1 When to Use the NSD
B.1.2 NSD Module Install Locations
B.1.3 Operating the NSD
B.2 Atypical Options for Apache for UNIX®, Linux, Mac OS
B.2.1 Install Locations Apache on UNIX®, Linux, Mac OS (All Alternative Options)
B.2.2 Atypical Option 1: Apache API Module with NSD (mod_csp24.so)
B.2.3 Alternative Option 2: CGI Modules with NSD (nph-CSPcgi)
B.2.4 Alternative Option 3: Built-in Apache API Module with NSD (mod_csp.c)
B.3 Locked-down Apache for UNIX®, Linux, and Mac OS X
B.3.1 Recommended Option: Apache API Modules (CSPa24.so)
B.3.2 Atypical Option 1: Apache API Module with NSD (mod_csp.so)
B.3.3 Atypical Option 2: CGI Modules with NSD (nph-CSPcgi)
B.3.4 Atypical Option 3: Built-in Apache API Module with NSD (mod_csp.c)
B.4 Alternative Option for Sun Web Servers
B.4.1 Install Locations for Sun (Alternative Option)
B.4.2 Alternative Option 1: NSAPI Module with NSD (CSPcn3.so)
B.5 Troubleshooting
Appendix C: 
  C.1 Alternative Option 1: OpenVMS and CGI Modules with NSD (CSPCGI.EXE)
C.1.1 Registering Additional File Types with CSP
C.1.2 Operating and Managing the Gateway with OpenVMS CGI and NSD
Appendix D: 
  D.1 Apache Process Management and Capacity Planning
D.1.1 Apache Prefork MPM
D.1.2 Apache Worker MPM
D.1.3 Apache MPMs and the Gateway DSOs
D.2 State-Aware Sessions (Preserve mode 1)
Appendix E: 
Appendix F: 
Appendix G: 
  G.1 IIS Application Pools and Web Gardens
G.1.1 Application Pools
G.1.2 Web Gardens
G.1.3 Application Pools, Web Gardens, and CSP
G.1.4 Idle Timeout for Worker Processes
G.1.5 Recycling Worker Processes
G.2 Bitness — 32-bit Apps on 64-bit Servers for Windows
Appendix H: 
  H.1 Configuring the Web Server and CSP Gateway
H.1.1 Install the CSP Gateway on the Web Server Machine
H.1.2 Configure the CSP Gateway
H.1.3 If Serving Static Files from the Web Server
H.1.4 Configure Web Server Paths
H.2 Accessing CSP on Multiple Caché Servers
H.3 Configuring Apache Virtual Hosts
H.3.1 Virtual Hosts Overview