ivy.webserver.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/9.2/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/9.2/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/9.2/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
 35  # Provides the general CSRF protection via 'X-Requested-By' header for REST services.
 36  CSRF.Protection: true
 37      
 38  # Controls whether the REST resources for the mobile app under '/{application}/api/workflow'
 39  # is available or not
 40  MobileWorkflow.API: false
 41  
 42  # Controls whether the REST resource for remote deployment under '/system/api/apps/{application}' 
 43  # is available or not
 44  Deployment: true
 45      
 46  # Allows the service developer to get diagnostic information about request processing by Jersey. 
 47  # Those diagnostic/tracing information are returned in response headers (X-Jersey-Tracing-nnn). 
 48  # On productive environments this feature should not be turned on.
 49  # [enum: OFF, ON_DEMAND, ALL]
 50  Tracing: "OFF"
 51
 52
 53
 54# == Miscellaneous Settings ==
 55#
 56# Session identifier will be renewed on login to prevent the 'Session Fixation' attack.
 57Session.RenewIdOnLogin: true
 58    
 59# Name of the Ivy servlet context. Use a simple name without any special characters (e.g. ivy).
 60# [restart required]
 61WebServer.IvyContextName: ""
 62
 63# Disable it if you don't use the Mobile Offline Dialog feature.
 64# [restart required]
 65OfflineDialog.Enabled: true
 66
 67
 68
 69# == Web Server Connector Settings ==
 70Connector:
 71  # https://tomcat.apache.org/tomcat-9.0-doc/config/http.html
 72  # [restart required]
 73  HTTP:
 74    Enabled: true
 75    Port: 8080
 76    AcceptCount: 100
 77    Address: ""
 78    AllowTrace: false
 79    CompressibleMimeType: "text/html,text/xml,text/plain,text/css,text/javascript,application/javascript,application/json,application/xml"
 80    Compression: "off"
 81    ConnectionLinger: -1
 82    ConnectionTimeout: 60000
 83    DisableUploadTimeout: true
 84    EnableLookups: false
 85    MaxHttpHeaderSize: 8192
 86    MaxKeepAliveRequests: 100
 87    MaxPostSize: 2097152
 88    MaxSavePostSize: 4096
 89    MaxThreads: 200
 90    MinSpareThreads: 10
 91    NoCompressionUserAgents: ""
 92    ProxyName: ""
 93    ProxyPort: 
 94    RedirectPort: 8443
 95    RestrictedUserAgents: ""
 96    Server: ""
 97    TcpNoDelay: true
 98    ThreadPriority: 5
 99    URIEncoding: UTF-8
100    UseBodyEncodingForURI: false
101    UseIPVHosts: false
102    XpoweredBy: false
103  
104  # https://tomcat.apache.org/tomcat-9.0-doc/config/http.html
105  # [restart required]
106  HTTPS:
107    Enabled: false
108    Port: 8443
109    AcceptCount: 100
110    Address: ""
111    AllowTrace: false
112    ClientAuth: NONE
113    CompressibleMimeType: "text/html,text/xml,text/plain,text/css,text/javascript,application/javascript,application/json,application/xml"
114    Compression: "off"
115    ConnectionLinger: -1
116    ConnectionTimeout: 60000
117    DisableUploadTimeout: true
118    EnableLookups: false
119    KeyAlias: ""
120    KeystoreFile: configuration/keystore.p12
121    # [password]
122    KeystorePass: changeit
123    KeystoreType: "pkcs12"
124    MaxHttpHeaderSize: 8192
125    MaxKeepAliveRequests: 100
126    MaxPostSize: 2097152
127    MaxSavePostSize: 4096
128    MaxThreads: 200
129    MinSpareThreads: 10
130    NoCompressionUserAgents: ""
131    ProxyName: ""
132    ProxyPort: 
133    RedirectPort: 8443
134    RestrictedUserAgents: ""
135    Server: ""
136    SslProtocol: TLS
137    TcpNoDelay: true
138    ThreadPriority: 5
139    TruststoreFile: ""
140    # [password]
141    TruststorePass: ""
142    TruststoreType: "JKS"
143    URIEncoding: UTF-8
144    UseBodyEncodingForURI: false
145    UseIPVHosts: false
146    XpoweredBy: false
147    
148  # https://tomcat.apache.org/tomcat-9.0-doc/config/ajp.html
149  # [restart required]
150  AJP:
151    Enabled: false
152    Port: 8009
153    Address: ""
154    AllowTrace: false
155    ConnectionTimeout: -1
156    EnableLookups: false
157    MaxPostSize: 2097152
158    MaxSavePostSize: 4096
159    MaxThreads: 200
160    MinSpareThreads: 10
161    PacketSize: 8192
162    ProxyName: ""
163    ProxyPort: 
164    RedirectPort: 8443
165    Secret: ""
166    SecretRequired: false
167    TcpNoDelay: true
168    ThreadPriority: 5
169    TomcatAuthentication: false
170    TomcatAuthorization: false
171    URIEncoding: UTF-8
172    UseBodyEncodingForURI: false
173    UseIPVHosts: false
174    XpoweredBy: false