Web Gateway Guide The Web Gateway: Serve InterSystems Web Applications and REST APIs to a Web Client How the Web Gateway Routes InterSystems Web Application Requests Set Up a Web Gateway for Your System Manage a Web Gateway Connection Access the Management Portal and Other Built–in Web Applications Using Your Web Server The Management Portal URL For New Installations For Upgrades Connect Your Web Server Automatically Connect Your Web Server Manually For Upgrades from Versions Prior to 2023.2: Disable and Remove the Private Web Server Overview: Set Up a Web Gateway for Your System Install the Web Gateway Files Extend the Functionality of Your Web Server with the Web Gateway Direct Requests from the Web Gateway to Your InterSystems IRIS Instances Secure All Connections Decommission a Web Gateway Connection Extend Your Web Server Configuration with the Web Gateway Files to Consider Apache for UNIX®/Linux/macOS Microsoft Internet Information Services (IIS) for Windows Nginx for UNIX®/Linux/macOS Nginx for Windows Choose Which URL Paths Route Requests Through the Web Gateway From the Web Server Through the Web Gateway To an InterSystems IRIS Application Server Overview of the Web Gateway Management Pages Accessing the Web Gateway Management Pages Enabling Access from Additional Client Addresses Available Options Localization Define a Server Access Profile for Your InterSystems IRIS Instance Add a Server Access Profile Copy a Server Access Profile Disable Access to an InterSystems IRIS Server Delete a Server Access Profile Define an Application Access Profile for Your Web Application Path Add an Application Access Profile Copy an Application Access Profile Disable Access via an Application Path Delete an Application Access Profile Configure System–Wide Parameters for the Web Gateway Ways to Configure Web Gateway Parameters Web Gateway (General Settings) Security Connections to InterSystems IRIS ASP Redirect Internal HTTP Server Custom Error Pages Event Logging Parameters Protecting Web Gateway Connections to InterSystems IRIS Configuring Connection Security for the Web Gateway Minimal Connection Security (Not Recommended) Simple Username/Password Authentication Kerberos-based Authentication and Data Protection SSL/TLS-Based Authentication and Data Protection Managing and Monitoring the Web Gateway Checking System Status Testing Server Connections Viewing the Event Log Using the HTTP Trace Facility CGI Environment Variables Passed by the Web Gateway HTTP Response Headers Returned by the Web Gateway Compressing the Response to Requests for CSP Forms (GZIP/ZLIB) The GZIP/ZLIB Library Using the GZIP/ZLIB Library Specifying Compression for Individual Pages Specifying Compression for All Pages within an Application Path Monitoring Implementing HTTP Authentication for Web Applications Standard HTTP authentication in Apache (mod_auth) Authenticating in CSP at the Same Time as the Request is Processed. Authenticating in CSP before the Request is Processed. Load Balancing, Failover, and Mirrored Configurations Load Balancing and Failover Between Multiple Web Servers Load Balancing and Failover Between Multiple InterSystems IRIS Server Instances Mirrored Configurations Process Affinity and State-Aware Mode (Preserve Mode 1) Launching State-Aware Mode Maintaining State-Aware Mode and Responding to Errors Terminating State-Aware Mode Web Gateway Registry in InterSystems IRIS Forcing the Web Gateway to Reload Its Configuration Web Gateway Configuration File (CSP.ini) Parameter Reference [SYSTEM] [<server>] [SYSTEM_INDEX] [APP_PATH:<appPath>] [APP_PATH_INDEX] Using the NSD (Windows) When to Use the NSD NSD Module Install Locations Operating the NSD Using the NSD (UNIX®/Linux/macOS) When to Use the NSD NSD Module Install Locations Operating the NSD Alternative Options for Apache (UNIX®/Linux/macOS) Install Locations (All Atypical Options) Alternative Option 1: Apache API Module with NSD (mod_csp24.so) Alternative Option 2: CGI Modules with NSD (nph-CSPcgi) Alternative Option 3: Built-in Apache API Module with NSD (mod_csp.c) Add the Web Gateway to a Locked-Down Apache Installation (UNIX®/Linux/macOS) Modify the Security Context for the Web Gateway Files Move the Web Gateway Directory Alternative Options for IIS 7 or Later (Windows) Installing the ISAPI and CGI Services Alternative Option 1: Using the ISAPI Modules (CSPms*.dll) Alternative Option 2: Using a Native Module with the NSD (CSPcms.dll) Alternative Option 3: Using an ISAPI Module with the NSD (CSPcms.dll) Alternative Option 4: Using the CGI Modules with the NSD (nph-CSPcgi*.exe) Using WebSockets (RFC 6455) WebSockets Protocol WebSockets Client Code (JavaScript) WebSockets Server Code WebSockets Server Example WebSockets Server Asynchronous Operation
