JBoss.orgCommunity Documentation

Install JBoss EARs

eXo Platform provides EARs packages to deploy in your existing JBoss application server. They are distributed in the package named eXo-Platform-jboss-3.5.x.zip.

Install eXo Platform on JBoss

1. Copy the following files to jboss-root/server/default/deploy.

  • gatein-ds.xml

  • gatein.ear

  • gatein-wsrp-extension-$version.ear

  • starter-gatein-$version.ear

  • exo-wcm-extension-$version.ear

  • exo-workflow-extension-$version.ear

  • exo-collaboration-extension-$version.ear

  • exo-knowledge-extension-$version.ear

  • exo-social-extension-$version.ear

  • exo-platform-extension-$version.ear

  • exo-social-intranet-$version.ear

  • exo-acme-website-$version.ear

  • exo-default-portal-$version.ear

  • exo-gadget-pack-$version.ear

2. Create the jboss-root/server/default/conf/gatein folder, then copy these files to this folder.

  • configuration.properties

  • configuration.xml

3. Copy the oauthkey.pem file to jboss-root/server/default/conf/gatein/gadgets.

4. Configure the JVM parameters.

  • On Linux, add these lines to the end of jboss-root/bin/run.conf: 

# Platform environment variables
EXO_PROFILES="-Dexo.profiles=default"
EXO_OPTS="-Dexo.product.developing=false -Dexo.conf.dir.name=gatein -Dgatein.data.dir=../gatein"
REMOTE_DEBUG="-Xdebug -Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n -Dcom.sun.management.jmxremote -Dorg.exoplatform.container.configuration.debug"
EXO_XML="-Djavax.xml.stream.XMLOutputFactory=com.sun.xml.stream.ZephyrWriterFactory -Djavax.xml.stream.XMLInputFactory=com.sun.xml.stream.ZephyrParserFactory -Djavax.xml.stream.XMLEventFactory=com.sun.xml.stream.events.ZephyrEventFactory"
JAVA_OPTS="$JAVA_OPTS $EXO_OPTS $EXO_PROFILES $EXO_XML"

  • On Windows, add these lines to the end of jboss-root/bin/run.conf.bat:

rem # Platform environment variables
set "EXO_PROFILES=-Dexo.profiles=default"
set "EXO_OPTS=-Dexo.product.developing=false -Dexo.conf.dir.name=gatein -Dgatein.data.dir=../gatein"
set "REMOTE_DEBUG=-Xdebug -Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n -Dcom.sun.management.jmxremote -Dorg.exoplatform.container.configuration.debug"
set "EXO_XML=-Djavax.xml.stream.XMLOutputFactory=com.sun.xml.stream.ZephyrWriterFactory -Djavax.xml.stream.XMLInputFactory=com.sun.xml.stream.ZephyrParserFactory -Djavax.xml.stream.XMLEventFactory=com.sun.xml.stream.events.ZephyrEventFactory"
set "JAVA_OPTS=%JAVA_OPTS% %EXO_OPTS% %EXO_PROFILES% %EXO_XML%"

Adapt to your needs:

  • To use another implementation of SAX, change the class names in the EXO_XML variable. For example: com.sun.xml.internal.stream.XMLOutputFactoryImpl.

  • To debug the application, simply add $REMOTE_DEBUG to the JAVA_OPTS variable.

5. Add the eXo Platform logging categories to jboss-root/server/default/conf/jboss-log4j.xml.




<!-- Limit the JSR170 categories -->

<category name="exo.jcr">

  <priority value="INFO"/>

</category>

<!-- Limit the JSR-168 and JSR-286 categories -->

<category name="org.exoplatform.services">

  <priority value="INFO"/>

</category>

6. Configure the emptySessionPath attribute.

From JBoss AS 4 or lower, to make Wiki work properly, you have to configure the emptySessionPath attribute in the server.xml file. If you are running Jboss with the "default" profile, this file will be located in server/default/deploy/jbossweb.sar/server.xml/ path.

Depending on the Connector you are using, you have to set the emptySessionPath attribute to "true" for that Connector respectively.

For example, if you are using the AJP Connector, the configuration should be as follows:

<!-- Define an AJP 1.3 Connector on port 8009 -->
<Connector port="8009" address="${jboss.bind.address}" protocol="AJP/1.3"
    emptySessionPath="true" enableLookups="false" redirectPort="8443" />

However, from JBoss AS 5 or higher, emptySessionPath="true" no longer sets the cookie path / by default. Instead, the cookie path is set via the following element in the Context element in the server/default/deploy/jbossweb.sar/context.xml file.

<SessionCookie path="/" />

Session cookies are now scoped to the context by default. 7. Start up the server.

  • On Linux and OS X: 

$JBOSS_HOME/bin/run.sh

  • On Windows: 

%JBOSS_HOME%\bin\run.bat

The server is started successfully when you see the following message in your log/console:

INFO [org.jboss.bootstrap.microcontainer.ServerImpl] (main) JBoss (Microcontainer) [5.1.1 (build: ...)] Started in 5m:29s:259ms

8. Shut down the server.

  • On Linux and OS X:

$JBOSS_HOME/bin/shutdown.sh

  • On Windows: 

%JBOSS_HOME%\bin\shutdown.bat

The server has been stopped successfully when you see the following message in your log/console:

INFO  [org.jboss.bootstrap.microcontainer.ServerImpl] (JBoss Shutdown Hook) Shutdown complete