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/8.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/8.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_FRONTEND_PORT' to override the front-end webserver port.
 22#    https://developer.axonivy.com/doc/8.0/engine-guide/configuration/advanced-configuration.html#overriding-configuration
 23# 
 24
 25
 26
 27# == Front-end Web Server (Reverse Proxy, IIS, Apache, Load balancer, ...) Settings ==
 28#
 29# Links generated by Axon.ivy often contain absolute links to the ivy server (e.g. for mails).
 30# If your Axon.ivy engine is only accessible for clients trough a front-end webserver, 
 31# at least its host and protocol must be specified.
 32Frontend:
 33  # Fully qualified domain name of the accessible web server
 34  HostName: ""
 35
 36  # Port of the accessible web server. Specify if not the default of the protocol is used (e.g. http: 80, https: 443)
 37  Port: 0
 38
 39  # Protocol of the accessible web server.
 40  # [Values: http, https]
 41  Protocol: http
 42
 43
 44
 45# == REST Service Settings ==
 46#
 47# Configures the RESTful services provided.
 48# [Restart required]
 49REST.Servlet:
 50  # Controls the REST servlet interface. If disabled no REST resources will be accessible. 
 51  # Calls to remote REST services are still possible.
 52  Enabled: true
 53
 54  # Provides the general CSRF protection via 'X-Requested-By' header for REST services.
 55  CSRF.Protection: true
 56      
 57  # Controls whether the REST resources for the mobile app under '/ivy/api/{application}/workflow'
 58  # is available or not
 59  MobileWorkflow.API: true
 60  
 61  # Controls whether the REST resource for remote deployment under '/ivy/api/system/apps' and 'api/system/apps/{application}' 
 62  # is available or not
 63  Deployment: true
 64      
 65  # Allows the service developer to get diagnostic information about request processing by Jersey. 
 66  # Those diagnostic/tracing information are returned in response headers (X-Jersey-Tracing-nnn). 
 67  # On productive environments this feature should not be turned on.
 68  # [Values: OFF, ON_DEMAND, ALL]
 69  Tracing: "OFF"
 70
 71
 72
 73# == Miscellaneous Settings ==
 74#
 75# Session identifier will be renewed on login to prevent the 'Session Fixation' attack.
 76Session.RenewIdOnLogin: true
 77    
 78# Name of the Ivy servlet context. Use a simple name without any special characters (e.g. ivy).
 79# [Restart required]
 80WebServer.IvyContextName: ivy
 81
 82# Disable it if you don't use the Mobile Offline Dialog feature.
 83# [Restart required]
 84OfflineDialog.Enabled: true
 85
 86
 87
 88# == Web Server Connector Settings ==
 89Connector:
 90  # https://tomcat.apache.org/tomcat-9.0-doc/config/http.html
 91  # [Restart required]
 92  HTTP:
 93    Enabled: true
 94    Port: 8080
 95    AcceptCount: 100
 96    Address: ""
 97    AllowTrace: false
 98    CompressibleMimeType: "text/html,text/xml,text/plain,text/css,text/javascript,application/javascript,application/json,application/xml"
 99    Compression: "off"
100    ConnectionLinger: -1
101    ConnectionTimeout: 60000
102    DisableUploadTimeout: true
103    EnableLookups: false
104    MaxHttpHeaderSize: 8192
105    MaxKeepAliveRequests: 100
106    MaxPostSize: 2097152
107    MaxSavePostSize: 4096
108    MaxThreads: 200
109    MinSpareThreads: 10
110    NoCompressionUserAgents: ""
111    ProxyName: ""
112    ProxyPort: 
113    RedirectPort: 8443
114    RestrictedUserAgents: ""
115    Server: ""
116    TcpNoDelay: true
117    ThreadPriority: 5
118    URIEncoding: UTF-8
119    UseBodyEncodingForURI: false
120    UseIPVHosts: false
121    XpoweredBy: false
122  
123  # https://tomcat.apache.org/tomcat-9.0-doc/config/http.html
124  # [Restart required]
125  HTTPS:
126    Enabled: true
127    Port: 8443
128    AcceptCount: 100
129    Address: ""
130    AllowTrace: false
131    ClientAuth: NONE
132    CompressibleMimeType: "text/html,text/xml,text/plain,text/css,text/javascript,application/javascript,application/json,application/xml"
133    Compression: "off"
134    ConnectionLinger: -1
135    ConnectionTimeout: 60000
136    DisableUploadTimeout: true
137    EnableLookups: false
138    KeyAlias: ""
139    KeystoreFile: configuration/keystore.p12
140    # [Format:PASSWORD]
141    KeystorePass: changeit
142    KeystoreType: "pkcs12"
143    MaxHttpHeaderSize: 8192
144    MaxKeepAliveRequests: 100
145    MaxPostSize: 2097152
146    MaxSavePostSize: 4096
147    MaxThreads: 200
148    MinSpareThreads: 10
149    NoCompressionUserAgents: ""
150    ProxyName: ""
151    ProxyPort: 
152    RedirectPort: 8443
153    RestrictedUserAgents: ""
154    Server: ""
155    SslProtocol: TLS
156    TcpNoDelay: true
157    ThreadPriority: 5
158    TruststoreFile: ""
159    # [Format:PASSWORD]
160    TruststorePass: ""
161    TruststoreType: "JKS"
162    URIEncoding: UTF-8
163    UseBodyEncodingForURI: false
164    UseIPVHosts: false
165    XpoweredBy: false
166    
167  # https://tomcat.apache.org/tomcat-9.0-doc/config/ajp.html
168  # [Restart required]
169  AJP:
170    Enabled: false
171    Port: 8009
172    Address: ""
173    AllowTrace: false
174    ConnectionTimeout: -1
175    EnableLookups: false
176    MaxPostSize: 2097152
177    MaxSavePostSize: 4096
178    MaxThreads: 200
179    MinSpareThreads: 10
180    PacketSize: 8192
181    ProxyName: ""
182    ProxyPort: 
183    RedirectPort: 8443
184    Secret: ""
185    SecretRequired: false
186    TcpNoDelay: true
187    ThreadPriority: 5
188    TomcatAuthentication: false
189    TomcatAuthorization: false
190    URIEncoding: UTF-8
191    UseBodyEncodingForURI: false
192    UseIPVHosts: false
193    XpoweredBy: false