eXo Platform 3.5

## Chapter 8. Deployment

This chapter covers the following topics:

- Remove sample applications

- Deploy a custom extension

- Set up Apache front-end

- Configure the session timeout for the web server

## Remove sample applications

eXo Platform comes with two sample portals that show the capabilities of the product. However, once implementing your own extensions, you may not need the sample applications. In some cases, you usually want to remove them before deploying your system in production.

The following instructions are used in cases where the hsqldb embedded database configuration is used.

### Remove Acme website/Acme Social Intranet

Both Acme website and Acme Social Intranet are sample extensions that demonstrate the intranet you can implement with eXo Platform.

To remove the Acme site/Acme Social Intranet, do as follows:

1. Stop the server using the command: shutdown.sh.

2. Delete the following relevant files:

- For the Acme website: acme-portal.war, exo.ecms.ext.acme.config.jar and gatein/data.

- For the Acme Social Intranet: office-portal.war, exo.platform.office.config.jar, and gatein/data.

3. Restart the server.

### Remove crash

Crash is a complementary tool for development and maintenance. As it opens telnet and ssh sockets, it is highly recommended that you remove crash for your production deployments. The crash is covered in the crash.war file in tomcat/webapps.

To remove crash, do as follows:

1. Stop the serve by using the shutdown.sh command.

2. Delete the crash.war file.

3. Restart the server.

## Deploy a custom extension

Extensions are packaged as the Java EE web applications and packaged as the normal .war files. To deploy the custom extension, you may do as for any other web apps.

In Tomcat, this ends up by copying the war archive to the webapps folder.

However, the GateIn extension mechanism imposes that the starter.war webapp starts after all extension wars.

This is the case for the sample applications bundled by default.

There are several ways to control the loading order of webapps in Tomcat. Please refer to Tomcat's Deployer How To.

## Set up Apache front-end

It may be necessary to use the HTTP server as a front-end for Tomcat. For example, you may want to keep more than one application server on the same host, and/or you want to access these app servers with the separate DNS names, without adding a port to the URL.

There are two methods that allow you to "glue" Apache HTTP Daemon and Tomcat application server:

- via the HTTP protocol using proxy module.

- via the Apache JServ Protocol using Tomcat connector or HTTPD AJP proxy module.

### Base configuration for Apache

First, you need to configure a new virtual host in Apache HTTPD for the application server. This is the simplest example of a virtual host:

    <VirtualHost *:80>
      ServerName      Enter your server DNS name here
      RedirectMatch permanent "^/?$" "/portal/"
    </VirtualHost>

You can find more information on the Apache HTTP daemon host here.

### Connect via HTTP protocol (Apache mod_proxy)

With the glue method, it is necessary to configure the Apache HTTP daemon to work as the reverse proxy, which will redirect the client's requests to the app server's HTTP connector.

For this connection type, you need to include the mod_proxy module in the HTTP daemon configuration file. This can be found in the httpd.conf file, which is usually located at /etc/httpd/conf/. However, depending on your OS, this path may vary. You will then need to add some directives to your virtual host configuration.

    ProxyRequests   Off
    ProxyPass	 "/" http://YOUR_AS_HOST:AS_HTTP_PORT/
    ProxyPassReverse "/" http://YOUR_AS_HOST:AS_HTTP_PORT/

Details:

- YOUR_AS_HOST - host (IP or DNS name) is the location of your application server. If you run the HTTP daemon on the same host as your app server, you can change this to localhost.

- AS_HTTP_PORT - port is the location where your app server will listen to incoming requests. For Tomcat, this value is 8080 by default. You can find the value at tomcat/conf/server.xml.

In the above example, the HTTP daemon will work in the reverse proxy mode (ProxyRequests Off) and will redirect all requests to the tcp port 8080 on the localhost. So, the configuration of a virtual host looks like the following:

    <VirtualHost *:80>
      ServerName      Enter your server DNS name here
      RedirectMatch	permanent "^/?$" "/portal/"
      ProxyRequests   Off
      ProxyPass	 "/" http://localhost:8080/
      ProxyPassReverse "/" http://localhost:8080/
    </VirtualHost>

For more detail on mod_proxy, refer to this documentation.

### Connect via AJP protocol

As described above, the 'glue' method can be implemented via one of the following ways:

- The first way: Use the native Apache HTTP Daemon's AJP proxy module.

- The second way: Use the native Apache Tomcat's AJP connector.

With the first method, you only need the HTTP daemon and application server, but settings are limited.

With the second method, you can obtain more settings, but you will need to download and install additional modules for the HTTP Daemon that are not included in the default package.

#### AJP proxy module

Make sure that mod_proxy_ajp.so is included in the list of loadable modules. Add the following to your virtual host configuration setting:

    ProxyPass / ajp://localhost:8009/

In this example, the app server is located on the same host as the Apache HTTP daemon, and accepts incoming connections on the port 8009 (the default setting for the Tomcat application server). You can find the full list of virtual host configurations here:

    <VirtualHost *:80>
      ServerName      Enter your server DNS name here
      RedirectMatch	permanent "^/?$" "/portal/"
      ProxyRequests   Off
      ProxyPass	/ ajp://localhost:8009/
    </VirtualHost>

#### Apache Tomcat's AJP connector

1. Download AJP connector module here.

2. Move the downloaded mod_jk.so file to the HTTPD's module directory, for example /etc/httpd/modules. The directory may be different, depending on the OS.

3. Create the configuration file for the mod_jk.conf module.

    LoadModule    jk_module  modules/mod_jk.so
    <IfModule jk_module>
      # ---- Where to find workers.properties
            JkWorkersFile   conf.d/workers.properties
      # ---- Where to put jk logs
      JkLogFile       logs/mod_jk.log
      # ---- Set the jk log level [debug/error/info]
      JkLogLevel    info
      # ---- Select the timestamp log format
      JkLogStampFormat "[%a %b %d %H:%M:%S %Y] "
      JkRequestLogFormat "%w %R %T"
      # ---- Send everything for context /examples to worker named worker1 (ajp13)
      JkMountFileReload       "0"
    </IfModule>

For more details, see the Tomcat documentation.

4. Place the mod_jk.conf file into the directory where other configuration files for Apache HTTP daemon are located. For example, /etc/httpd/conf.d/.

5. Create the workers.properties file, which defines AJP workers for the HTTP daemon.

    worker.list=status, WORKER_NAME
    # Main status worker
    worker.stat.type=status
    worker.stat.read_only=true
    worker.stat.user=admin
    # Your AJP worker configuration
    worker.WORKER_NAME.type=ajp13
    worker.WORKER_NAME.host=localhost
    worker.WORKER_NAME.port=8109
    worker.WORKER_NAME.socket_timeout=120
    worker.WORKER_NAME.socket_keepalive=true

### Note

In the example above, you can change WORKER_NAME to any value.

6. Put this file in the same directory as the mod_jk.conf file.

7. Update the virtual host configuration.

    <VirtualHost *:80>
      ServerName      Enter your server DNS name here
      RedirectMatch	permanent "^/?$" "/portal/"
      ProxyRequests   Off
      JkMount         /*	WORKER_NAME
    </VirtualHost>

## Configure the session timeout for the web server

The session timeout defines the validation period of a session. In the portal environment, such as eXo Platform, it is highly recommended that all web applications have the same session timeout value:

- Tomcat

- JBoss

The session timeout is configurable individually for each web application in the web.xml file:

    <!-- ==================== Default Session Configuration ================= -->

    <!-- You can set the default session timeout (in minutes) for all newly   -->

    <!-- created sessions by modifying the value below.                       -->

    <session-config>

      <session-timeout>30</session-timeout>

    </session-config>

### Tomcat server

In the Tomcat bundle, this file is located at $TOMCAT_HOME/conf/web.xml. To configure the session timeout of Server Tomcat, do as follows:

1. Stop the server by the shutdown.sh command.

2. Open the web.xml file.

3. Change the value of the session-timeout.

4. Save and then restart the server by the gatein.sh command.

### JBoss server

In the JBoss server, this file is located at $Jboss_home/server/default/deployers/jbossweb.deployer/web.xml. To configure the session timeout of the JBoss server, do as follows:

1. Stop the server by using the shutdown.sh command.

2. Open the web.xml file.

3. Change the value of the session timeout.

4. Save and restart the server.