1.4.1. Basic Customization

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

JVM configuration

ConfigurationDescription
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 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="1g"

EXO_JVM_SIZE_MIN="1g"

EXO_JVM_PERMSIZE_MAX="128m"

JVM memory settings. Their combination equals -Xmx1g -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

ConfigurationDescription
EXO_PROFILES="all,myOwnProfile"

The default profile is "all". If you customize this variable, refer to Startup profiles.

EXO_ASSETS_VERSION="42"

This is version number of eXo Platform which looks like 4.0.1. Usually you do not need to customize this because its default value (check it in setenv.sh) is updated in every release.

EXO_DATA_DIR="/opt/jenkins/.eXo-platform/data"

The default data store 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.

SMTP/Email configuration

You can find details about the SMTP/Email configuration at Outgoing mail service. Here is a quick view of the variables with default value:

ConfigurationDefault value
EXO_DEPLOYMENT_URL="https://intranet.mycompany.com"http://localhost:8080
EXO_EMAIL_FROM="intranet@mycompany.com"noreply@exoplatform.com
EXO_EMAIL_SMTP_HOST="smtp.gmail.com"localhost
EXO_EMAIL_SMTP_PORT="465"25
EXO_EMAIL_SMTP_STARTTLS_ENABLE=truefalse
EXO_EMAIL_SMTP_AUTH=truefalse
EXO_EMAIL_SMTP_USERNAME="account@gmail.com"NONE (not set)
EXO_EMAIL_SMTP_PASSWORD="password"NONE (not set)
EXO_EMAIL_SMTP_SOCKET_FACTORY_PORT="465"NONE (not set)
EXO_EMAIL_SMTP_SOCKET_FACTORY_CLASS="javax.net.ssl.SSLSocketFactory"NONE (not set)

JODConverter configuration

The JODConverter service allows users to preview some document types, such as .pdf and .doc. You are required to install Open Office (or Libre Office) in the same host with eXo Platform, as instructed in JODConverter configuration.

If you turn on the JODConverter service while Open Office server is not ready yet, it does not cause any serious problem except that many Exception messages may be logged. To avoid it, turn off the JODConverter service by uncommenting the line: EXO_JODCONVERTER_ENABLE=false.

Here is a quick view of the variables with default value:

ConfigurationDefault value
EXO_JODCONVERTER_ENABLE=falsetrue
EXO_JODCONVERTER_PORTS="2002,2003,2004,2005"2002
EXO_JODCONVERTER_OFFICEHOME="/usr/lib/libreoffice"By default, the Office server location is auto-detected.

Logs configuration

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:

ConfigurationDescription
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

ConfigurationDescription
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.

Copyright ©. All rights reserved. eXo Platform SAS
blog comments powered byDisqus