Runtime Options

< appboard | 2.6 | admin

All configurable server runtime options are stored in [INSTALL_HOME]/server/bin/setenv-custom.*, the extension depending on Windows (.bat) or Linux/Unix (.sh). This file is safe to edit and included in system backups.

Do NOT edit setenv.* as this contains system defaults from Edge and is not included in archives.


Lines in setenv-custom beginning with "rem set" must have "rem" removed in order for the configuration to take effect.


Configurable Options

Option Default Description
HTTP_ADDRESS 0.0.0.0 Determines what IP address Tomcat will bind to. By default it will bind to all IP addresses on the host, but you can uncomment this option and restrict to a specific IP if necessary.
HTTP_PORT 8080 Determines the port Tomcat will listen on. Please note that to use ports < 1024 Tomcat must be run as an administrator or with JSVC on Unix.
SHUTDOWN_PORT 8005 Used on the localhost only to listen for shutdown commands. If you have multiple Tomcat installations on the same host then each will need a separate shutdown port.
HTTP_SSL false To enable HTTPS change this to true, and you possibly want to change HTTP_PORT to 443 to have Tomcat listen on the typical HTTPS port.
KEYSTORE_FILE conf/ssl.crt/tomcat.crt Location of the keystore. The default is a self-signed certificate that ships with enPortal/AppBoard. This path is relative to [INSTALL_HOME]/server/. Refer to the SSL Configuration page for more information.
KEYSTORE_PASS enportal (optional) Password if required to access the keystore.
KEYSTORE_TYPE JKS Type for the self-signed certificate enPortal/AppBoard ships with. Other supported types are PKCS11 and PKCS12. Please refer to the public Tomcat SSL instructions for more information about generating your own certificates. Most SSL certificate providers will provide an option in one of the formats listed above.
CLIENTAUTH false To enable HTTPS client authentication set this to true. If this is enabled the TRUSTSTORE_FILE must also be defined.
TRUSTSTORE_FILE n/a Location of the truststore. By default this is not set and if HTTPS Client Authentication is enabled this option must be set.
TRUSTSTORE_PASS n/a (optional) Password if required to access the truststore
TRUSTSTORE_TYPE KEYSTORE_TYPE See description for the KEYSTORE_TYPE.
JAVA_MEMORY_MAX 1536 Sets the Java runtime option -Xmx, the maximum heap size. See Memory_Configuration for more information on tuning memory parameters.
JAVA_MEMORY_INIT 256 Sets the Java runtime option -Xms, the initial heap size. See Memory_Configuration for more information on tuning memory parameters.
JAVA_PERM_SIZE 64 Sets the Java runtime option -XX:PermSize, the portion of the heap reserved for permanent generation (dynamic loading/unloading of classes). See Memory_Configuration for more information on tuning memory parameters. Only applicable for Java 7; AppBoard v2.6.2+ / enPortal v5.6.2+ require Java 8.
JAVA_PERM_SIZE_MAX 256 Sets the Java runtime option -XX:MaxPermSize, the maximum portion of the heap to be used for permanent generation. See Memory_Configuration for more information on tuning memory parameters. Only applicable for Java 7; AppBoard v2.6.2+ / enPortal v5.6.2+ require Java 8.
JAVA_GC_LOGGING false When set to true Java garbage collection information is logged to gc.log in the logs directory. GC information may be useful when analysing system performance and understanding memory issues. See Memory_Configuration for more information on tuning memory parameters.
CUSTOM_JAVA_OPTS Additional custom JVM options can be defined here. By default this is not defined.
MAC_JAVA_OPTS (see description) Mac OS X specific JVM options. By default configures Java to use the Edge logo as the Dock icon.
JAVA_HOME n/a This is not configured in setenv or setenv-custom by default but can be set here to override the system-wide, or user specific environment. NOTE: on Linux/UNIX this is managed by the post_install script.
PIDFILE n/a This is used by Tomcat when running as a service on Linux/UNIX systems and by default is automatically determined by the TOMCAT_SERVICE name (managed by post_install) in the form /var/run/<service_name>/<service_name>.pid. Use this runtime option to override the default.