Appboard/2.5/admin/runtime options - Revision history

imported>Jason.nicholls at 05:33, 20 March 2015

2015-03-20T05:33:01Z

← Older revision		Revision as of 05:33, 20 March 2015
Line 26:		Line 26:
	\|-		\|-
	\| KEYSTORE_FILE \|\| conf/ssl.crt/tomcat.crt		\| KEYSTORE_FILE \|\| conf/ssl.crt/tomcat.crt
	\| Location of the keystore. The default is a self-signed certificate that ships with enPortal/AppBoard.		\| Location of the keystore. The default is a self-signed certificate that ships with enPortal/AppBoard. This path is relative to <tt>[INSTALL_HOME]/server/</tt>. Refer to the [[appboard/2.5/admin/ssl_configuration\|SSL Configuration]] page for more information.
	\|-		\|-
	\| KEYSTORE_PASS \|\| enportal		\| KEYSTORE_PASS \|\| enportal

imported>Jason.nicholls: /* Configurable Options */

2014-09-05T12:55:59Z

Configurable Options

← Older revision		Revision as of 12:55, 5 September 2014
Line 19:		Line 19:
	\| SHUTDOWN_PORT \|\| 8005		\| 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.		\| 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.
			\|-
			\|colspan=3\|
	\|-		\|-
	\| HTTP_SSL \|\| false		\| HTTP_SSL \|\| false
Line 27:		Line 29:
	\|-		\|-
	\| KEYSTORE_PASS \|\| enportal		\| KEYSTORE_PASS \|\| enportal
	\| Password required to access the keystore.		\| (optional) Password if required to access the keystore.
	\|-		\|-
	\| KEYSTORE_TYPE \|\| JKS		\| KEYSTORE_TYPE \|\| JKS
	\| Type for the self-signed certificate enPortal/AppBoard ships with. Other supported types are <tt>PKCS11</tt> and <tt>PKCS12</tt>. 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.		\| Type for the self-signed certificate enPortal/AppBoard ships with. Other supported types are <tt>PKCS11</tt> and <tt>PKCS12</tt>. 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 <tt>true</tt>. 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.
			\|-
			\|colspan=3\|
	\|-		\|-
	\| JAVA_MEMORY_MAX \|\| 1536		\| JAVA_MEMORY_MAX \|\| 1536
Line 39:		Line 55:
	\|-		\|-
	\| JAVA_PERM_SIZE \|\| 64		\| JAVA_PERM_SIZE \|\| 64
	\| Sets the Java runtime option <tt>-XX:PermSize</tt>, the portion of the heap reserved for permanent generation (dynamic loading/unloading of classes). See [[appboard/2.5/admin/memory_configuration\|Memory_Configuration]] for more information on tuning memory parameters.		\| Sets the Java runtime option <tt>-XX:PermSize</tt>, the portion of the heap reserved for permanent generation (dynamic loading/unloading of classes). See [[appboard/2.5/admin/memory_configuration\|Memory_Configuration]] for more information on tuning memory parameters. Only applicable for Java 7.
	\|-		\|-
	\| 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 [[appboard/2.5/admin/memory_configuration\|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 [[appboard/2.5/admin/memory_configuration\|Memory_Configuration]] for more information on tuning memory parameters. Only applicable for Java 7.
	\|-		\|-
	\| JAVA_GC_LOGGING \|\| false		\| JAVA_GC_LOGGING \|\| false
Line 53:		Line 69:
	\| Mac OS X specific JVM options. By default configures Java to use the Edge logo as the Dock icon.		\| Mac OS X specific JVM options. By default configures Java to use the Edge logo as the Dock icon.
	\|-		\|-
	\| JAVA_HOME \|\| n/a		\| 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.		\| 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		\| 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 <tt>/var/run/<service_name>/<service_name>.pid</tt>. Use this runtime option to override the default.		\| 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 <tt>/var/run/<service_name>/<service_name>.pid</tt>. Use this runtime option to override the default.
	\|}		\|}

imported>Jason.nicholls: /* Configurable Options */

2014-07-10T10:05:21Z

Configurable Options

← Older revision		Revision as of 10:05, 10 July 2014
Line 45:		Line 45:
	\|-		\|-
	\| JAVA_GC_LOGGING \|\| false		\| 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.		\| 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. See [[appboard/2.5/admin/memory_configuration\|Memory_Configuration]] for more information on tuning memory parameters.
	\|-		\|-
	\| CUSTOM_JAVA_OPTS \|\|		\| CUSTOM_JAVA_OPTS \|\|

imported>Jason.nicholls: /* Configurable Options */

2014-07-10T09:06:35Z

Configurable Options

← Older revision		Revision as of 09:06, 10 July 2014
Line 33:		Line 33:
	\|-		\|-
	\| JAVA_MEMORY_MAX \|\| 1536		\| JAVA_MEMORY_MAX \|\| 1536
	\| Sets the Java runtime option <tt>-Xmx</tt>, the maximum heap size. See [[Memory_Configuration]] for more information on tuning memory parameters.		\| Sets the Java runtime option <tt>-Xmx</tt>, the maximum heap size. See [[appboard/2.5/admin/memory_configuration\|Memory_Configuration]] for more information on tuning memory parameters.
	\|-		\|-
	\| JAVA_MEMORY_INIT \|\| 256		\| JAVA_MEMORY_INIT \|\| 256
	\| Sets the Java runtime option <tt>-Xms</tt>, the initial heap size. See [[Memory_Configuration]] for more information on tuning memory parameters.		\| Sets the Java runtime option <tt>-Xms</tt>, the initial heap size. See [[appboard/2.5/admin/memory_configuration\|Memory_Configuration]] for more information on tuning memory parameters.
	\|-		\|-
	\| JAVA_PERM_SIZE \|\| 64		\| JAVA_PERM_SIZE \|\| 64
	\| Sets the Java runtime option <tt>-XX:PermSize</tt>, the portion of the heap reserved for permanent generation (dynamic loading/unloading of classes). See [[Memory_Configuration]] for more information on tuning memory parameters.		\| Sets the Java runtime option <tt>-XX:PermSize</tt>, the portion of the heap reserved for permanent generation (dynamic loading/unloading of classes). See [[appboard/2.5/admin/memory_configuration\|Memory_Configuration]] for more information on tuning memory parameters.
	\|-		\|-
	\| 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 [[appboard/2.5/admin/memory_configuration\|Memory_Configuration]] for more information on tuning memory parameters.
	\|-		\|-
	\| JAVA_GC_LOGGING \|\| false		\| JAVA_GC_LOGGING \|\| false

imported>Jason.nicholls: /* Configurable Options */

2014-07-10T05:45:12Z

Configurable Options

← Older revision		Revision as of 05:45, 10 July 2014
Line 45:		Line 45:
	\|-		\|-
	\| JAVA_GC_LOGGING \|\| false		\| 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.5 and later~~.		\| 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.
	\|-		\|-
	\| CUSTOM_JAVA_OPTS \|\|		\| CUSTOM_JAVA_OPTS \|\|

imported>Jason.nicholls: 1 revision

2014-06-26T15:52:26Z

1 revision

← Older revision	Revision as of 15:52, 26 June 2014
(No difference)

imported>Jason.nicholls at 09:50, 4 April 2014

2014-04-04T09:50:10Z

New page

{{DISPLAYTITLE:Runtime Options}}
[[Category:AppBoard 2.5]]
All configurable server runtime options are stored in <tt>[INSTALL_HOME]/server/bin/'''setenv-custom'''.*</tt>, the extension depending on Windows (.bat) or Linux/Unix (.sh). This file is safe to edit and included in system backups.

{{Warning|Do NOT edit <tt>setenv.*</tt> 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 <tt>true</tt>, 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 <tt>PKCS11</tt> and <tt>PKCS12</tt>. 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 <tt>-Xmx</tt>, the maximum heap size. See [[Memory_Configuration]] for more information on tuning memory parameters.
|-
| JAVA_MEMORY_INIT || 256
| Sets the Java runtime option <tt>-Xms</tt>, the initial heap size. See [[Memory_Configuration]] for more information on tuning memory parameters.
|-
| JAVA_PERM_SIZE || 64
| Sets the Java runtime option <tt>-XX:PermSize</tt>, 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 <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.5 and later.
|-
| 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 <tt>/var/run/<service_name>/<service_name>.pid</tt>. Use this runtime option to override the default.
|}