Enportal/5.5/admin/enPortal installation/installation/runtime options - Revision history

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

2015-03-20T09:12:29Z

Configurable Options

← Older revision		Revision as of 09:12, 20 March 2015
Line 27:		Line 27:
	\|-		\|-
	\| 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. This path is relative to <tt>[INSTALL_HOME]/server/</tt>. Refer to the [[enportal/5.5/admin/ssl_configuration\|SSL Configuration]] page for more information.
	\|-		\|-
	\| KEYSTORE_PASS \|\| enportal		\| KEYSTORE_PASS \|\| enportal

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

2014-09-05T12:59:02Z

Configurable Options

← Older revision		Revision as of 12:59, 5 September 2014
Line 20:		Line 20:
	\| 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 32:		Line 34:
	\| 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 40:		Line 56:
	\|-		\|-
	\| 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 [[enportal/5.5/admin/enPortal_installation/installation/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 [[enportal/5.5/admin/enPortal_installation/installation/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 [[enportal/5.5/admin/enPortal_installation/installation/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 [[enportal/5.5/admin/enPortal_installation/installation/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 51:		Line 67:
	\| Additional custom JVM options can be defined here. By default this is not defined.		\| Additional custom JVM options can be defined here. By default this is not defined.
	\|-		\|-
	\| 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''
			\| 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: 1 revision

2014-07-10T05:09:02Z

1 revision

← Older revision	Revision as of 05:09, 10 July 2014
(No difference)

imported>Jason.nicholls: 1 revision

2013-12-19T15:17:46Z

1 revision

New page

[[Category:enPortal 5.5]]
{{DISPLAYTITLE:Runtime Options}}

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 [[enportal/5.5/admin/enPortal_installation/installation/memory_configuration|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 [[enportal/5.5/admin/enPortal_installation/installation/memory_configuration|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 [[enportal/5.5/admin/enPortal_installation/installation/memory_configuration|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 [[enportal/5.5/admin/enPortal_installation/installation/memory_configuration|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.
|-
| 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.
|}