ivy.webserver.yamlΒΆ

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

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
#
# -------------------------------------------
# Axon.ivy Web Server Configuration
# -------------------------------------------
#
# This file shows all configurations of the internal Web Server of the Axon.ivy engine.
# @engine.guide.url@/configuration/
# 
# Copy contents of this reference file to 'configuration/ivy.yaml' before adjusting them to your needs.
# @engine.guide.url@/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.
#    @engine.guide.url@/configuration/index.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 ==
# https://tomcat.apache.org/tomcat-9.0-doc/config/http.html
Connector:
  # [Restart required]
  HTTP:
    Enabled: true
    Port: 8080
    AcceptCount: 100
    Address: ""
    AllowTrace: false
    BufferSize: 2048
    CompressableMimeType: text/html,text/xml,text/plain
    Compression: off
    ConnectionLinger: -1
    ConnectionTimeout: 60000
    DisableUploadTimeout: true
    EnableLookups: false
    MaxHttpHeaderSize: 8192
    MaxKeepAliveRequests: 100
    MaxPostSize: 2097152
    MaxSavePostSize: 4096
    MaxSpareThreads: 50
    MaxThreads: 200
    MinSpareThreads: 4
    NoCompressionUserAgents: ""
    ProxyName: ""
    ProxyPort: 
    RedirectPort: 8443
    RestrictedUserAgents: ""
    Server: ""
    SocketBuffer: 9000
    Strategy: lf
    TcpNoDelay: true
    ThreadPriority: 5
    URIEncoding: UTF-8
    UseBodyEncodingForURI: false
    UseIPVHosts: false
    XpoweredBy: false
  
  # [Restart required]
  HTTPS:
    Enabled: true
    Port: 8443
    AcceptCount: 1000
    Address: ""
    Algorithm: ""
    AllowTrace: false
    BufferSize: 2048
    Ciphers: ""
    ClientAuth: false
    CompressableMimeType: text/html,text/xml,text/plain
    Compression: off
    ConnectionLinger: -1
    ConnectionTimeout: 60000
    DisableUploadTimeout: true
    EnableLookups: false
    KeyAlias: ""
    KeystoreFile: configuration/keystore.p12
    # [Format:PASSWORD]
    KeystorePass: changeit
    KeystoreType: ""
    MaxHttpHeaderSize: 8192
    MaxKeepAliveRequests: 100
    MaxPostSize: 2097152
    MaxSavePostSize: 4096
    MaxSpareThreads: 50
    MaxThreads: 200
    MinSpareThreads: 4
    NoCompressionUserAgents: ""
    ProxyName: ""
    ProxyPort: 
    RedirectPort: 8443
    RestrictedUserAgents: ""
    Server: ""
    SocketBuffer: 9000
    SslProtocol: TLS
    Strategy: lf
    TcpNoDelay: true
    ThreadPriority: 5
    TruststoreFile: ""
    # [Format:PASSWORD]
    TruststorePass: ""
    TruststoreType: ""
    URIEncoding: UTF-8
    UseBodyEncodingForURI: false
    UseIPVHosts: false
    XpoweredBy: false
    
  # [Restart required]
  AJP:
    Enabled: false
    Port: 8009
    Address: ""
    AllowTrace: false
    BackLog: 100
    BufferSize: 2048
    ConnectionTimeout: 60000
    EnableLookups: false
    MaxPostSize: 2097152
    MaxSavePostSize: 4096
    MaxSpareThreads: 50
    MaxThreads: 200
    MinSpareThreads: 4
    PacketSize: 8192
    ProxyName: ""
    ProxyPort: 
    RedirectPort: 8443
    TcpNoDelay: true
    ThreadPriority: 5
    TomcatAuthentication: true
    URIEncoding: UTF-8
    UseBodyEncodingForURI: false
    UseIPVHosts: false
    XpoweredBy: false