web.conf

as variable name in the config file

prometheus

webservices__prometheus__enable

Boolean

activation of prometheus interface, default false

S 39.5.34

prometheus_port

webservices__prometheus__port

Int

port number the web server listens on; required parameter (prometheus is implicitly deactivated when no port is configured)

S 39.5.34

prometheus_interface

webservices__prometheus__interface

host name/ip address

interface the web server is bound to; localhost by default

S 39.5.34

monitoring

webservices__monitoring__enable

Boolean

activation of monitoring interface, default false

monitoring_port

webservices__monitoring__port

Int

port number the web server listens on; required parameter (monitoring is implicitly deactivated when no port is configured)

monitoring_interface

webservices__monitoring__interface

host name/ip address

interface the web server is bound to; localhost by default

services

webservices__services__enable

Boolean

Deprecated, generic_service used instead.

services_port

webservices__services__port

Int

Deprecated, generic_service_port used instead.

services_interface

webservices__services__interface

host name/ip address

Deprecated, generic_service_interface used instead.

services_doc

webservices__services_doc__enable

Boolean

activation of web services documentation, false by default

services_doc_port

webservices__services_doc__port

Int

port number the web server listens on; required parameter (web services documentation is implicitly deactivated when no port is configured)

services_doc_interface

webservices__services_doc__interface

host name/ip address

interface the web server is bound to; localhost by default

generic_service

webservices__generic_service__enable

Boolean

activation of web service documentation, false by default

generic_service_port

webservices__generic_service__port

Int

port number of the PLANTA link web services listens on; required parameter (web services are implicitly deactivated when no port is configured)

generic_service_interface

webservices__generic_service__interface

host name/ip address

interface the web server is bound to; localhost by default

ssl_swagger_enable

webservices__ssl_swagger_enable

Boolean

Deprecated

ssl_generic_enable

webservices__ssl_generic_enable

Boolean

enable SSL for PLANTA link web services, false by default

ssl_services_docs_enable

webservices__ssl_services_docs_enable

Boolean

enable SSL for web services documentation, false by default

ssl_keystore_password

webservices__ssl_keystore_password

Int

password for the JavaKeystore

ssl_keystore

webservices__ssl_keystore

path

path to the Java Keystore

cross_origin_filter_all

webservices__cross_origin_filter_all

Boolean

Cross Site Scripting Filter which needs to be enabled, true by default

apikey_auth_filter_swagger

webservices__apikey_auth_filter_swagger

Boolean

Deprecated

apikey_auth_filter_generic

webservices__apikey_auth_filter_generic

Boolean

ApiKey authentication for PLANTA pulse web services, true by default

Needs to be set to false if the Authentication parameter on a specific web interface is to be used instead

saml_auth_filter_pulse

webservices__saml_auth_filter_pulse

Boolean

SAML authentication for all web services, true by default

server_status

webservices__server_status__enable

Boolean

Enables the Health Endpoint

S 39.5.37

server_status_connection

webservices__server_status__connection

String

Configures the connection for the Health Endpoint

S 39.5.37

server_status_entrypoint

webservices__server_status__entrypoint

String

Configures the entrypoint for the Health Endpoint

S 39.5.37