Skip to main content

WebServer

Allow the private web server to start.

Synopsis

[Startup]    WebServer=n

n is either 1 (true) or 0 (false). The default value is 1.

Description

When Webserver is enabled (n = 1), the private web server starts when InterSystems IRIS® data platform starts. The private web server is necessary to enable REST and SOAP APIs, as well as the Management Portal. For information on the private web server, see the section Private Web Server and the Management Portal in the Web Gateway Configuration Guide.

In a secure (locked down) InterSystems IRIS container (described in Locked Down InterSystems IRIS Container in Running InterSystems Products in Containers), the PWS is always disabled. The Webserver parameter can be included in a configuration merge file to deploy locked down InterSystems IRIS containers with the PWS (and thus the Management Portal) enabled.

Changing This Parameter

On the Startup page of the Management Portal (System Administration > Configuration > Additional Settings > Startup), in the WebServer row, select Edit. Select WebServer to enable the private web server.

Instead of using the Management Portal, you can change WebServer in the Config.Startup class (as described in the class reference) or by editing the CPF in a text editor (as described in the Editing the Active CPF section of the “Introduction to the Configuration Parameter File” chapter in this book).

Note:

A restart is required for this setting to take effect.

See Also

Feedback