ivy.webserver.yaml

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

#
# -------------------------------------------
# Axon.ivy Web Server Configuration
# -------------------------------------------
#
# This file shows all configurations of the internal Web Server of the Axon.ivy engine.
# https://developer.axonivy.com/doc/8.0/engine-guide/configuration/
# 
# Copy contents of this reference file to 'configuration/ivy.yaml' before adjusting them to your needs.
# https://developer.axonivy.com/doc/8.0/engine-guide/configuration/files/ivy-yaml.html
#
# By default this configuration enables all available features 
# of the Axon.ivy engine so that all capabilities that might are used
# by a workflow project are accessible.
#
# 
# OVERRIDING:
# Any configuration value of this file can be set in alternative sources. 
# * environment variables: of the operating system can set app config entries. 
#    Their key must be prefixed with 'IVY_'. 
#    E.g. use 'IVY_FRONTEND_PORT' to override the front-end webserver port.
#    https://developer.axonivy.com/doc/8.0/engine-guide/configuration/advanced-configuration.html#overriding-configuration
# 



# == Front-end Web Server (Reverse Proxy, IIS, Apache, Load balancer, ...) Settings ==
#
# Links generated by Axon.ivy often contain absolute links to the ivy server (e.g. for mails).
# If your Axon.ivy engine is only accessible for clients trough a front-end webserver, 
# at least its host and protocol must be specified.
Frontend:
  # Fully qualified domain name of the accessible web server
  HostName: ""

  # Port of the accessible web server. Specify if not the default of the protocol is used (e.g. http: 80, https: 443)
  Port: 0

  # Protocol of the accessible web server.
  # [Values: http, https]
  Protocol: http



# == REST Service Settings ==
#
# Configures the RESTful services provided.
# [Restart required]
REST.Servlet:
  # Controls the REST servlet interface. If disabled no REST resources will be accessible. 
  # Calls to remote REST services are still possible.
  Enabled: true

  # Provides the general CSRF protection via 'X-Requested-By' header for REST services.
  CSRF.Protection: true
      
  # Controls whether the REST resources for the mobile app under '/ivy/api/{application}/workflow'
  # is available or not
  MobileWorkflow.API: true
  
  # Controls whether the REST resource for remote deployment under '/ivy/api/system/apps' and 'api/system/apps/{application}' 
  # is available or not
  Deployment: true
      
  # Allows the service developer to get diagnostic information about request processing by Jersey. 
  # Those diagnostic/tracing information are returned in response headers (X-Jersey-Tracing-nnn). 
  # On productive environments this feature should not be turned on.
  # [Values: OFF, ON_DEMAND, ALL]
  Tracing: "OFF"



# == Miscellaneous Settings ==
#
# Session identifier will be renewed on login to prevent the 'Session Fixation' attack.
Session.RenewIdOnLogin: true
    
# Name of the Ivy servlet context. Use a simple name without any special characters (e.g. ivy).
# [Restart required]
WebServer.IvyContextName: ivy

# Disable it if you don't use the Mobile Offline Dialog feature.
# [Restart required]
OfflineDialog.Enabled: true



# == Web Server Connector Settings ==
Connector:
  # https://tomcat.apache.org/tomcat-9.0-doc/config/http.html
  # [Restart required]
  HTTP:
    Enabled: true
    Port: 8080
    AcceptCount: 100
    Address: ""
    AllowTrace: false
    CompressibleMimeType: "text/html,text/xml,text/plain,text/css,text/javascript,application/javascript,application/json,application/xml"
    Compression: "off"
    ConnectionLinger: -1
    ConnectionTimeout: 60000
    DisableUploadTimeout: true
    EnableLookups: false
    MaxHttpHeaderSize: 8192
    MaxKeepAliveRequests: 100
    MaxPostSize: 2097152
    MaxSavePostSize: 4096
    MaxThreads: 200
    MinSpareThreads: 10
    NoCompressionUserAgents: ""
    ProxyName: ""
    ProxyPort: 
    RedirectPort: 8443
    RestrictedUserAgents: ""
    Server: ""
    TcpNoDelay: true
    ThreadPriority: 5
    URIEncoding: UTF-8
    UseBodyEncodingForURI: false
    UseIPVHosts: false
    XpoweredBy: false
  
  # https://tomcat.apache.org/tomcat-9.0-doc/config/http.html
  # [Restart required]
  HTTPS:
    Enabled: true
    Port: 8443
    AcceptCount: 100
    Address: ""
    AllowTrace: false
    ClientAuth: NONE
    CompressibleMimeType: "text/html,text/xml,text/plain,text/css,text/javascript,application/javascript,application/json,application/xml"
    Compression: "off"
    ConnectionLinger: -1
    ConnectionTimeout: 60000
    DisableUploadTimeout: true
    EnableLookups: false
    KeyAlias: ""
    KeystoreFile: configuration/keystore.p12
    # [Format:PASSWORD]
    KeystorePass: changeit
    KeystoreType: "pkcs12"
    MaxHttpHeaderSize: 8192
    MaxKeepAliveRequests: 100
    MaxPostSize: 2097152
    MaxSavePostSize: 4096
    MaxThreads: 200
    MinSpareThreads: 10
    NoCompressionUserAgents: ""
    ProxyName: ""
    ProxyPort: 
    RedirectPort: 8443
    RestrictedUserAgents: ""
    Server: ""
    SslProtocol: TLS
    TcpNoDelay: true
    ThreadPriority: 5
    TruststoreFile: ""
    # [Format:PASSWORD]
    TruststorePass: ""
    TruststoreType: "JKS"
    URIEncoding: UTF-8
    UseBodyEncodingForURI: false
    UseIPVHosts: false
    XpoweredBy: false
    
  # https://tomcat.apache.org/tomcat-9.0-doc/config/ajp.html
  # [Restart required]
  AJP:
    Enabled: false
    Port: 8009
    Address: ""
    AllowTrace: false
    ConnectionTimeout: -1
    EnableLookups: false
    MaxPostSize: 2097152
    MaxSavePostSize: 4096
    MaxThreads: 200
    MinSpareThreads: 10
    PacketSize: 8192
    ProxyName: ""
    ProxyPort: 
    RedirectPort: 8443
    Secret: ""
    SecretRequired: false
    TcpNoDelay: true
    ThreadPriority: 5
    TomcatAuthentication: false
    TomcatAuthorization: false
    URIEncoding: UTF-8
    UseBodyEncodingForURI: false
    UseIPVHosts: false
    XpoweredBy: false