ePages 6.17+ WebInterface.conf 6.17.15
Created: 6.17.15; Updated: 6.17.15

WebInterface.conf is an INI-style configuration file. It's used by a number of components of the web interface, such as epages Service, Application Server and Web Adapter.

Table of Contents

1 File Structure

All sections and key names are case sensitive. Whitespace after the equal sign (=) is significant.

1.1 Section [GLOBAL]

Option Type/Range Default Value Description
MAXREQUEST 0 .. INT_MAX Requests 10000 Maximum number of requests that are processed by one application server. When the application server has processed this number of requests, it terminates itself. It will be re-started automatically by the epages Service.
MAXUPTIME 0 .. INT_MAX Seconds not set Maximum uptime of an application server process. When the application server is running for more than MAXUPTIME seconds it terminates itself after the next request.
MAXMEMORY 0 .. INT_MAX MBytes not set Maximum memory size of one application server [MBytes]. When the application server is using more than MAXMEMORY MBytes of RAM it terminates itself after the next request.
FREEREQUESTPERIOD 0 .. INT_MAX Seconds 5 Heartbeat frequency for idle application servers [sec]. The application server will periodically poll for new cache updates after this period of idle time.
TIMEOUT 1 .. INT_MAX Seconds 150 This value specifies the wait time in seconds until the web adapter tries to find a free application server if the previous request failed. The request could fail when no request routers are available or all application servers are busy.
RETRIES 0 .. INT_MAX Retries 150 Specifies how often the web adapter tries to find an idle application server. Works in conjunction with TIMEOUT. That is, the web adapter will wait for a maximum of RETRIES * TIMEOUT seconds.
MAXCONTENTLENGTH 0 .. INT_MAX KBytes 0 (not limited) Maximum content length in KBytes for incoming POST requests. Larger requests are discarded by the web adapter. They will not be passed on to an application server. The value "0" means that the content length is not limited. The default values is 10 MiB. Values above 20MiB (including unlimited) are not recommended.
INTERVALTIME deprecated deprecated deprecated as of 6.17.5
MAXCACHEITEMS deprecated deprecated deprecated as of 6.17.5, replaced by a setting in ServerConfig.xml
PRIORITY ABOVE_NORMAL, NORMAL, BELOW_NORMAL NORMAL Process priority of application servers
Should be used on Windows only, because Unix processes cannot increase their priority unless they run with root privileges.
MONITOR_PRIORITY ABOVE_NORMAL, NORMAL, BELOW_NORMAL NORMAL Process priority of application servers during unexpected long operations
Should be used on Windows only, because Unix processes cannot increase their priority unless they run with root privileges.
MANUAL_MONITOR_PRIORITY ABOVE_NORMAL, NORMAL, BELOW_NORMAL NORMAL Process priority of application servers during expected long operations, such as product import/export
Should be used on Windows only, because Unix processes cannot increase their priority unless they run with root privileges.
MONITOR_TIMEOUT 0 .. INT_MAX Seconds 15 Timeout in seconds for the hourglass page
DOMAINREDIRECT deprecated deprecated deprecated as of 6.0.7 (EPG-11807)
COOKIES Comma-separated list of strings SessionID, Language, Currency, Locale, PreviewStyle, PopUp List of cookies used by the application server. Any cookies that are not in this list will be ignored
KEEPALIVE Boolean (0/1) 1 Keep the connection between web adapter and request router alive. Note that there is a limit of 1024 concurrent connections. Therefore set KEEPALIVE=0 if you plan to have more than 1000 web server processes/threads
DEBUG deprecated deprecated deprecated as of 6.17.5
OPTIONS String Sets options for the Perl process, for example to enable warnings, profiler or debugger

1.2 Section [IP Address]

Sections with IP addresses are deprecated as of 6.17.5 and can't be used anymore. See ePages 6.17+ ServerConfig.xml for information on how to configure the ePages server components.

1.3 Section [URLRewrite]

This section configures how the web server handles customized URLs (EPG-6666). The default behavior is that all request are re-written as:

  /epages/.shorturl?URI=$OriginalURI

Option Type/Range Default value Description
epages String epages Name of the virtual web server directory of the ePages web adapter
BaseURI deprecated deprecated deprecated
ExceptionPrefix space-separated list of strings /epages/ /WebRoot/ /robots.txt /favicon.ico List of space-separated URI prefixes that are not rewritten
ExceptionRegex space-separated list of strings List of space-separated regular expressions to define additional URI exceptions
ExceptionHost space-separated list of strings List of space-separated host names for which no URLs are rewritten. For example, the provider domain names, such as "[[strato.de]]", "[[www.strato.com]]" can be defined as exceptions

1.4 Section [WA-DEBUG]

Configures the log level for the binary web interface components.

Option Type/Range Default value Description
outfile String Log file name without extension (pid, threadid and '.log' automatically added)
ANYLEVEL Boolean (0/1) 0
SOCKET Boolean (0/1) 0
REQUEST Boolean (0/1) 0
RROUTER Boolean (0/1) 0
LOG Boolean (0/1) 0
LIST Boolean (0/1) 0
HASH Boolean (0/1) 0
INIFILE Boolean (0/1) 0
UTILS Boolean (0/1) 0
SERVER Boolean (0/1) 0
SRVMANAGER Boolean (0/1) 0
WEBSERVER Boolean (0/1) 0
CONFIG Boolean (0/1) 0
SOCKETSEND Boolean (0/1) 0
SOCKETRECV Boolean (0/1) 0
PROCESSING Boolean (0/1) 0
CRITICALSECTION Boolean (0/1) 0
CORE Boolean (0/1) 0
PAGECACHE Boolean (0/1) 0
SERVICE Boolean (0/1) 0
MEMORY Boolean (0/1) 0
ADD_LOGMSGS Boolean (0/1) 0
TRACE Boolean (0/1) 0
FILE Boolean (0/1) 0
CONDITION Boolean (0/1) 0

1.5 WebInterface.conf Example

  [GLOBAL]
  MAXREQUEST=10000
  TIMEOUT=150
  RETRIES=150
  MAXCONTENTLENGTH=0
  [WA-DEBUG]
  SOCKET=1
  RESPONSE=1
  REQUEST=1
  outfile=/tmp/WA-DEBUG

2 Error Files

$EPAGES_WEBROOT/WebAdapterError.html
contains the "Heavy Traffic" message. It is used for all sorts of errors that are produced or catched by the web adapter. Take a look at the log file $EPAGES_LOG/WebAdapter.log for details.
$EPAGES_WEBROOT/WebAdapterContentTooLong.html
is used when a the request body of a POST request exceeds MAXCONTENTLENGTH, i.e. when an uploaded image or CSV file was too large. (since 5.04 patch 10)
$EPAGES_WEBROOT/WebAdapterNotFound.html
is used when the host name or the URL of the request is not registered in the ASPoolDB. The URL of the request is logged in the RequestRouter.log file. (since 6.11.0)

Copyright ePages GmbH 2015