ivy.webserver.yaml (a part of ivy.yaml)

[engineDir]/configuration/reference/ivy.webserver.yaml

  1#
  2# -------------------------------------------
  3# Axon Ivy Web Server Configuration
  4# -------------------------------------------
  5#
  6# This file shows all configurations of the internal Web Server of the Axon Ivy Engine.
  7# https://developer.axonivy.com/doc/10.0/engine-guide/configuration/
  8# 
  9# Copy contents of this reference file to 'configuration/ivy.yaml' before adjusting them to your needs.
 10# https://developer.axonivy.com/doc/10.0/engine-guide/configuration/files/ivy-yaml.html
 11#
 12# By default this configuration enables all available features 
 13# of the Axon Ivy Engine so that all capabilities that might are used
 14# by a workflow project are accessible.
 15#
 16# 
 17# OVERRIDING:
 18# Any configuration value of this file can be set in alternative sources. 
 19# * environment variables: of the operating system can set app config entries. 
 20#    Their key must be prefixed with 'IVY_'. 
 21#    E.g. use 'IVY_CONNECTOR_HTTP_PORT' to override the port of the http connector.
 22#    https://developer.axonivy.com/doc/10.0/engine-guide/configuration/advanced-configuration.html#overriding-configuration
 23# 
 24
 25
 26# == REST Service Settings ==
 27#
 28# Configures the RESTful services provided.
 29# [restart required]
 30REST.Servlet:
 31  # Controls the REST servlet interface. If disabled no REST resources will be accessible. 
 32  # Calls to remote REST services are still possible.
 33  Enabled: true
 34  # Provides the general CSRF protection via 'X-Requested-By' header for REST services.
 35  CSRF.Protection: true
 36  # Controls whether the REST resources for the mobile app under '/{application}/api/workflow'
 37  # is available or not
 38  MobileWorkflow.API: false
 39  # Controls whether the REST resource for remote deployment under '/system/api/apps/{application}' 
 40  # is available or not
 41  Deployment: true
 42  # Allows the service developer to get diagnostic information about request processing by Jersey. 
 43  # Those diagnostic/tracing information are returned in response headers (X-Jersey-Tracing-nnn). 
 44  # On productive environments this feature should not be turned on.
 45  # [enum: OFF, ON_DEMAND, ALL]
 46  Tracing: "OFF"
 47
 48
 49
 50# == Miscellaneous Settings ==
 51#
 52# Session identifier will be renewed on login to prevent the 'Session Fixation' attack.
 53Session.RenewIdOnLogin: true
 54
 55# Name of the Ivy servlet context. Use a simple name without any special characters (e.g. ivy).
 56# [restart required]
 57WebServer.IvyContextName: ""
 58
 59# Disable it if you don't use the Mobile Offline Dialog feature.
 60# [restart required]
 61OfflineDialog.Enabled: true
 62
 63
 64
 65# == Web Server Connector Settings ==
 66Connector:
 67  # https://tomcat.apache.org/tomcat-9.0-doc/config/http.html
 68  # [restart required]
 69  HTTP:
 70    Enabled: true
 71    Port: 8080
 72    AcceptCount: 100
 73    Address: ""
 74    AllowTrace: false
 75    CompressibleMimeType: "text/html,text/xml,text/plain,text/css,text/javascript,application/javascript,application/json,application/xml"
 76    Compression: "off"
 77    ConnectionLinger: -1
 78    ConnectionTimeout: 60000
 79    DisableUploadTimeout: true
 80    EnableLookups: false
 81    MaxHttpHeaderSize: 8192
 82    MaxParameterCount: 10000
 83    MaxPartCount: -1
 84    MaxKeepAliveRequests: 100
 85    MaxPostSize: 2097152
 86    MaxSavePostSize: 4096
 87    MaxThreads: 200
 88    MinSpareThreads: 10
 89    NoCompressionUserAgents: ""
 90    ProxyName: ""
 91    ProxyPort:
 92    RedirectPort: 8443
 93    RestrictedUserAgents: ""
 94    Server: ""
 95    TcpNoDelay: true
 96    ThreadPriority: 5
 97    URIEncoding: UTF-8
 98    UseBodyEncodingForURI: false
 99    UseIPVHosts: false
100    XpoweredBy: false
101  # https://tomcat.apache.org/tomcat-9.0-doc/config/http.html
102  # [restart required]
103  HTTPS:
104    Enabled: false
105    Port: 8443
106    AcceptCount: 100
107    Address: ""
108    AllowTrace: false
109    ClientAuth: NONE
110    CompressibleMimeType: "text/html,text/xml,text/plain,text/css,text/javascript,application/javascript,application/json,application/xml"
111    Compression: "off"
112    ConnectionLinger: -1
113    ConnectionTimeout: 60000
114    DisableUploadTimeout: true
115    EnableLookups: false
116    KeyAlias: ""
117    KeystoreFile: configuration/keystore.p12
118    # [password]
119    KeystorePass: changeit
120    KeystoreType: "pkcs12"
121    MaxHttpHeaderSize: 8192
122    MaxParameterCount: 10000
123    MaxPartCount: -1
124    MaxKeepAliveRequests: 100
125    MaxPostSize: 2097152
126    MaxSavePostSize: 4096
127    MaxThreads: 200
128    MinSpareThreads: 10
129    NoCompressionUserAgents: ""
130    ProxyName: ""
131    ProxyPort:
132    RedirectPort: 8443
133    RestrictedUserAgents: ""
134    Server: ""
135    SslProtocol: TLS
136    SslHostConfig:
137      # The names of the protocols to support when communicating with clients.
138      # Multiple protocols can be enabled by separating them with a comma.
139      # [restart required]
140      # [examples: SSLv2Hello, SSLv3, TLSv1, TLSv1.1, TLSv1.2, TLSv1.3, all]
141      Protocols: all
142    TcpNoDelay: true
143    ThreadPriority: 5
144    TruststoreFile: ""
145    # [password]
146    TruststorePass: ""
147    TruststoreType: "JKS"
148    URIEncoding: UTF-8
149    UseBodyEncodingForURI: false
150    UseIPVHosts: false
151    XpoweredBy: false
152  # https://tomcat.apache.org/tomcat-9.0-doc/config/ajp.html
153  # [restart required]
154  AJP:
155    Enabled: false
156    Port: 8009
157    Address: ""
158    AllowTrace: false
159    ConnectionTimeout: -1
160    EnableLookups: false
161    MaxPostSize: 2097152
162    MaxSavePostSize: 4096
163    MaxThreads: 200
164    MinSpareThreads: 10
165    PacketSize: 8192
166    ProxyName: ""
167    ProxyPort:
168    RedirectPort: 8443
169    Secret: ""
170    SecretRequired: false
171    TcpNoDelay: true
172    ThreadPriority: 5
173    TomcatAuthentication: false
174    TomcatAuthorization: false
175    URIEncoding: UTF-8
176    UseBodyEncodingForURI: false
177    UseIPVHosts: false
178    XpoweredBy: false