This page last changed on Oct 03, 2007 by smaddox.

The Confluence EAR-WAR edition is intended for deployment into an existing J2EE application server. It is assumed that you already know how to deploy a webapp on the application server of choice. If not, please contact your system administrator to assist you, or consider installing the Confluence Standalone edition instead.

Confluence EAR-WAR requirements

In addition to the Confluence requirements, the EAR-WAR edition requires an application server: 

For more information, please read the Supported Platforms FAQ.

Compatible / Supported

  • Apache Tomcat (4.1 and 5.5)
  • Weblogic (8.1 SP3 and above)
  • Resin (2.11.11 and above)
  • JBoss
  • Orion (2.0.2 and above)
  • Websphere (5.1.1.3 and above)

Compatible / No Technical Support

  • Macromedia JRun - untested
  • Microsoft IIS Server - untested

Incompatible

Setup Notes and List of Known Issues can be found here

  • If deploying as an unexploded WAR, Ant 1.3 or later is required
  • If deploying on an unsupported server, server-related issues cannot be covered by Atlassian technical support. Requests for assistance can be directed to the user forums instead
  • Confluence, the database and application server must use the same character encoding. UTF-8 is recommended
  • A user-contributed Fedora or RHEL/Centos Install Guide is also available for reference
  • Unix, Linux or Solaris users must install these X11 libraries

How to install Confluence EAR-WAR on Tomcat


Step 1 - Download and extract WAR

  1. Download the Confluence WAR zip file
  2. Extract the downloaded zip file:
    • Windows users must avoid Win XP's built-in unzip as it doesn't extract all the files. Use a 3rd party zip extractor like WinZip.
    • Solaris users will need to use GNU tar to handle the long filenames.
    • Tomcat users must not unzip their Confluence install to inside the Tomcat webapps folder as this may cause Confluence to be deployed more than once.
  3. It will unzip your Confluence install directory, which should contain the version number e.g. confluence-2.2.9 or confluence-2.5.0. This directory will be later referred to as the Confluence install directory. Inside is a confluence subdirectory, referred to later as the Confluence WAR directory. Record the absolute path to the Confluence WAR directory.

Step 2 - Check for patches

Review the Release Notes for your Confluence version and apply any patches listed

Step 3 - Check for application server issues 


Known Issues for Apache Tomcat
Known Issues for JBoss
Known Issues for Jetty
Known Issues for Resin 2.x
Known Issues for Resin 3.x
Known Issues for SAP Application Server
Known Issues for WebLogic
Known Issues for Websphere


Step 3 - Configure confluence-init.properties

  1. Inside the Confluence install directory, edit ...confluence/WEB-INF/classes/confluence-init.properties in a text editor
  2. Set the confluence.home property to a directory of your choosing. This is the directory that will contain all of Confluence's configuration, backup and attachment files.

Step 4 - Edit Tomcat context descriptors

If you using Tomcat 5.0.x or Tomcat 5.5.x:

  1. Create a file called confluence.xml in your Tomcat installation's conf/Catalina/localhost directory (if you have set up a different hostname for your tomcat instance, please specify that instead of localhost)
  2. Open confluence.xml and add these lines:
    <Context path="/confluence" docBase="c:/applications/confluence-2.1.3/confluence" debug="0" reloadable="false">
    <Logger className="org.apache.catalina.logger.FileLogger"
    prefix="atlassian-confluence." suffix=".log" timestamp="true"/>
    </Context>

  3. For docBase specify the value you noted down earlier.

If you are using Tomcat 4.x

  1. Open conf/server.xml in a text editor
  2. Add the following:
    <Context path="/confluence" docBase="c:/applications/confluence-2.1.3/confluence" debug="0" reloadable="false">
    <Logger className="org.apache.catalina.logger.FileLogger"
    prefix="atlassian-confluence." suffix=".log" timestamp="true"/>
    </Context>

  3. For docBase specify the value you noted down earlier.

Step 5 - Configure Your Application server

Review any documentation associated with your webserver here. If your application server requires deploying Confluence as a EAR/WAR, follow these instructions to build the WAR file:

Windows users
Linux users

Step 6 - Restart Server

  1. Shut down, and then restart Tomcat
  2. Confluence should now be accessible on http://host:port/confluence



Next Step

Setup Confluence

General Tips & Information

Troubleshooting


Solutions to common issues with installing Confluence. Review your logs by opening the Confluence install directory and checking the /logs/catalina.out and /logs/catalina.out files for errors described below. Click on a problem to show the solution.

Confluence window closes immediately when started
Confluence won't start - java.lang.NoClassDefFoundError IntraHibernateAttachmentCopier
Confluence won't start - Exception in thread "main" java.lang.NoClassDefFoundError: ...
Confluence won't start - Error creating Confluence Home directory
Confluence won't start - JAVA_HOME environment variable is not defined correctly
Confluence won't start - Port 8080 is in use
Confluence won't start - Error creating bean with name 'scheduler'
Confluence won't start - Error registering bean with name 'fileSystemAttachmentDataDao'
Confluence starts but localhost:8080 times out
Confluence starts but localhost:8080 goes to Tomcat start homepage
Confluence starts but logins fail at login screen



RELATED TOPICS

Confluence Cluster Installation
Configuration Guide
Confluence Setup Guide
Confluence 2.5.4 to 2.5.8 Documentation
Confluence Main FAQ


nav_plain_red.png (image/png)
nav_plain_blue.png (image/png)
Document generated by Confluence on Oct 10, 2007 18:36