Appboard/old/runtime options: Difference between revisions

imported>Joe.firebaugh
mNo edit summary
imported>Jason.nicholls
No edit summary
Line 3: Line 3:
{{Warning|Do NOT edit <tt>setenv.*</tt> as this contains system defaults from Edge and is not included in archives.}}
{{Warning|Do NOT edit <tt>setenv.*</tt> as this contains system defaults from Edge and is not included in archives.}}


'''Mac OSX Dock Icon for Server'''
To have a dock icon for the enPortal server on Mac OSx you can use the following code in setenv-custom.js:
<code>[bash,N]
os=`uname`
CUSTOM_JAVA_OPTS=""
# IF Mac OSx detected then lets set a tray icon for the dock to diferentiate between other Java processes
if [ "$os" = "Darwin" ]; then
CUSTOM_JAVA_OPTS="-Xdock:icon=EdgeTrayIcon_250x.png -Xdock:name=\"enPortal\""
fi
export CUSTOM_JAVA_OPTS
</code>


== Configurable Options ==
== Configurable Options ==
Line 57: Line 41:
| JAVA_PERM_SIZE_MAX || 256
| JAVA_PERM_SIZE_MAX || 256
| Sets the Java runtime option <tt>-XX:MaxPermSize</tt>, the maximum portion of the heap to be used for permanent generation. See [[Memory_Configuration]] for more information on tuning memory parameters.
| Sets the Java runtime option <tt>-XX:MaxPermSize</tt>, the maximum portion of the heap to be used for permanent generation. See [[Memory_Configuration]] for more information on tuning memory parameters.
|-
| JAVA_GC_LOGGING || false
| When set to <tt>true</tt> Java garbage collection information is logged to <tt>gc.log</tt> in the logs directory. GC information may be useful when analysing system performance and understanding memory issues. This option is available from AppBoard 2.4 and later.
|-
|-
| CUSTOM_JAVA_OPTS ||
| CUSTOM_JAVA_OPTS ||

Revision as of 06:48, 1 April 2014

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.

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


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.
KEYSTORE_PASS enportal Password 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.
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.
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.
CUSTOM_JAVA_OPTS Additional custom JVM options can be defined here. By default this is not defined.
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.