1.7.1. Basic Customization

Warning

You are looking at documentation for an older release. Not what you want? See the current release documentation.

Simple assignment statement is used to customize variables in this section:

In .sh: variable_name=variable_value.
In .bat: SET variable_name=variable_value.

JVM configuration

Configuration	Description
`JAVA_HOME="/opt/java/jdk6"`	JAVA_HOME is auto-detected by default. In case you specify it, notice that it is parent of the `jre` folder.
`EXO_JVM_VENDOR="IBM"`	This configuration (for Tomcat and Linux only) is here because IBM Java requires different XML Parser library. Do not uncomment it unless you are using IBM Java.
`EXO_JVM_SIZE_MAX="4g"` `EXO_JVM_SIZE_MIN="1g"` `EXO_JVM_PERMSIZE_MAX="128m"`	JVM memory settings. Their combination equals `-Xmx4g -Xms1g -XX:MaxPermSize=128m`, in which `EXO_JVM_SIZE_MAX` equals `Xmx`. Uses "g" for Gigabytes and "m" for Megabytes. It is possible to set the same value for `EXO_JVM_SIZE_MAX` and `EXO_JVM_SIZE_MIN`.
`EXO_JVM_USER_LANGUAGE="fr"` `EXO_JVM_USER_REGION="FR"`	JVM locale settings. Their combination equals `-Duser.language=fr -Duser.region=FR`. The default language is "en", the default region is "US". A full list of valid language codes can be found at IANA Language Subtag Registry.
`EXO_DEBUG=true` `EXO_DEBUG_PORT="8000"`	Their combination equals the JVM Option: `-agentlib:jdwp=transport=dt_socket,address=8000,server=y,suspend=n` Is not used for production environment.

Platform configuration

Configuration	Description
`EXO_PROFILES="all,myOwnProfile"`	Tomcat only. The default profile is "all". If you customize this variable, refer to Startup profiles.
`EXO_CONF_DIR="/opt/ciagent/.eXo-platform/conf"`	The default configuration folder is `./gatein/conf/` (Tomcat only).
`EXO_DATA_DIR="/opt/jenkins/.eXo-platform/data"`	The default data directory is `./gatein/data` (Tomcat only).
`EXO_DEV=true`	Preserved for the development tasks. Do not uncomment this in the production environment.
`EXO_JCR_SESSION_TRACKING=true`	If this variable is true, the eXo JCR Session Leak Detector is activated. If you do not uncomment this line, it is set equal to `EXO_DEV`.

Logs configuration

Tomcat only. The logs configuration is to control how often, which kind of message/event to be written to the log stream (screen or log files), and their format. Configuring logs is more than a trivial task, however eXo Platform tries to ease it by exposing 3 variables that you can customize:

Configuration	Description
`EXO_LOGS_LOGBACK_CONFIG_FILE="$CATALINA_BASE/conf/logback.xml"`	Gives a possibility to use your own logback configuration file. To customize a logback configuration file, you can learn its syntax and design here.
`EXO_LOGS_DISPLAY_CONSOLE=true`	By default, the console log is disabled unless you start eXo Platform by the start_eXo script without the --background option.
`EXO_LOGS_COLORIZED_CONSOLE=true`	By default, the console log is colored in Linux, but not colored in Windows.

Tomcat configuration

Configuration	Description
`CATALINA_PID="$CATALINA_BASE/temp/catalina.pid"`	By uncommenting this line you are certain that you can always get the process ID of eXo Platform from a file.
`EXO_TOMCAT_UNPACK_WARS=true`	If this line is uncommented, `webapps/*.war` files are extracted. This option does not target to the administration tasks, it is preserved for the development tasks.

JBoss configuration

Configuration	Description
`MAX_FD="maximum"`	Specifies the maximum file descriptor limit.
`PROFILER=""`	Specifies a profiler configuration file.
`JAVA_OPTS="$JAVA_OPTS -Djboss.modules.lockless=false"`	Uncomment this to not use JBoss Modules lockless mode.
`JAVA_OPTS="$JAVA_OPTS -Djboss.modules.metrics=true"`	Uncomment this to gather JBoss Modules metrics.