This page last changed on Dec 12, 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 web application 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:
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)
Potentially Compatible But Untested & Unsupported
- Macromedia JRun
- Microsoft IIS Server
- Oracle Application Server
Incompatible
Setup Notes and List of Known Issues for Application Server Configuration 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
- Download the Confluence EAR/WAR zip file. (You need to click the 'Show advanced downloads' link to get access to the EAR/WAR zip file.)
- 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.
- 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
Step 3 - Configure confluence-init.properties
- Inside the Confluence install directory, edit ...confluence/WEB-INF/classes/confluence-init.properties in a text editor
- 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 are using Tomcat 5.5.x:
- 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.)
- Open confluence.xml and add these lines:
<Context path="/confluence" docBase="c:/applications/confluence-2.1.3/confluence" debug="0" reloadable="false">
</Context>
Note: The file atlassian-confluence.log will no longer be created as <Logger> is no longer a valid nested element of <Context> element. See Scott Prater's comments below .
- For docBase specify the value you noted down earlier.
If you are using Tomcat 5.0.x:
- 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.)
- Open confluence.xml and add these lines:
<Context path="/confluence" docBase="c:/applications/confluence-2.1.3/confluence" debug="0" reloadable="false"/>
- For docBase specify the value you noted down earlier.
If you are using Tomcat 4.x
- Open conf/server.xml in a text editor.
- Add the following:
<Context path="/confluence" docBase="c:/applications/confluence-2.1.3/confluence" debug="0" reloadable="false"/>
- For docBase specify the value you noted down earlier.
Step 5 - Configure Your application server
Review any documentation associated with your web server here. If your application server requires deploying Confluence as a EAR/WAR, follow these instructions to build the WAR file:
Windows users
- Open the command line prompt
- Navigate to the Confluence installed directory
- Run the command build war
Linux users
- Open a terminal window
- Navigate to the Confluence installed directory
- Add executable mode to build.sh - chmod +x build.sh
- Run build.sh
- The WAR file is now located in the dist subfolder in your Confluence installed directory
Step 6 - Restart Server
- Shut down, and then restart Tomcat
- 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
An error is preventing Confluence from starting.
- Open a command prompt. On Windows, do this by clicking on your Start menu, then click Run. In the Run box, type cmd and press OK
- From the command prompt, go to your Confluence install directory
- Go into the bin subdirectory
- Run startup.bat and read the error message
- Find the solution to that error below
Confluence won't start - java.lang.NoClassDefFoundError IntraHibernateAttachmentCopier
If you are seeing "java.lang.NoClassDefFoundError: com/atlassian/confluence/pages/persistence/dao/hibernate/AbstractHibernateAttachmentDao$IntraHibernateAttachmentCopier", you have unzipped Confluence using a program that cannot handle long filenames. You must delete your install directory and go back to the point in the instructions that covers unzipping Confluence using a third-party unzip program.
Confluence won't start - Exception in thread "main" java.lang.NoClassDefFoundError: ...
If http://localhost:8080 goes to an error page when you run Confluence, go to the install directory and find the /logs/catalina.out. If this file contains a single line error starting with "Exception in thread "main" java.lang.NoClassDefFoundError", your install path may contain spaces. The solution is to rename your install directory path so that there are no spaces, then restart Confluence.
Confluence won't start - Error creating Confluence Home directory
The confluence.home variable specified in confluence-init.properties cannot be created. To fix this, edit /confluence/WEB-INF/classes/confluence-init.properties and check the path specified exists. Make sure all the directory slashes use / and that the # has been removed. If you're stuck, try using confluence.home=c:/confluence/data
Confluence won't start - JAVA_HOME environment variable is not defined correctly
You have not installed the Java Development Kit, or not set the %JAVA_HOME% to the directory of the JDK. You should re-check your steps in Stage 2.
Confluence won't start - Port 8080 is in use
If you have another Tomcat running on the same machine, you must edit <INSTALL>/conf/server.xml and change both 8080 and 8005 to ports that do not conflict with your other Tomcat instance according to these instructions.
Confluence won't start - Error creating bean with name 'scheduler'
Confluence won't start - Error registering bean with name 'fileSystemAttachmentDataDao'
If you did not use one of the recommended unzipping tools, and happened to use for instance the default Windows XP extractor, one of the classes required for starting up Confluence may not be located due to the lengthy file-path. This is due to the reason that the default Windows tool silently fails to extract files with long names. We suggest you to use other tools such as WinZIP and 7zip and redo the deployment process.
Cause:
org.springframework.beans.factory.BeanDefinitionStoreException: Error registering bean with name 'fileSystemAttachmentDataDao' defined in class path resource [applicationContext.xml]: Class that bean class [com.atlassian.confluence.pages.persistence.dao.FileSystemAttachmentDataDao] depends on not found; nested exception is java.lang.NoClassDefFoundError: com/atlassian/confluence/pages/persistence/dao/FileSystemAttachmentDataDao$FileSystemAttachmentNamingStrategy
at org.springframework.beans.factory.xml.DefaultXmlBeanDefinitionParser.parseBeanDefinition(DefaultXmlBeanDefinitionParser.java:366)
caused by: java.lang.NoClassDefFoundError: com/atlassian/confluence/pages/persistence/dao/FileSystemAttachmentDataDao$FileSystemAttachmentNamingStrategy
at java.lang.Class.forName0(Native Method)
Confluence starts but localhost:8080 times out
Check the server logs for errors. If you are running Confluence Standalone on Windows, error messages will be printed to the console window that opened when you ran startup.bat. On Unix systems, Confluence will log messages to logs/catalina.out.
Confluence starts but localhost:8080 goes to Tomcat start homepage
The CATALINA_HOME environment variable is set to another instance of Tomcat. You should run shutdown.sh, remove the CATALINA_HOME reference to the other Tomcat version, and run startup.sh again.
Confluence starts but logins fail at login screen
If you try to login with the correct username and password but are always returned to the login screen without any error messages, and you are running Zone Alarm, please check that it is not blocking the Confluence server
BUILD FAILED message when trying to create an EAR file in Confluence 2.6 or 2.7
When trying to create a EAR file, you may encounter with the following error:
This is due to the build.xml file being incorrect for Confluence 2.6.x and 2.7.0. This problem will be fixed for future releases. However for these releases, please open the build.xml file and change the following two lines:
From:
<copy preservelastmodified="true" file="${ant.confluence.etc}/ear-application.xml" tofile="${ant.confluence.build.ear}/META-INF/application.xml" overwrite="yes"/>
<copy preservelastmodified="true" file="${ant.confluence.dist}/${ant.confluence.name}-${ant.confluence.version}.war" tofile="ant.confluence.nameild.ear}/Confluence War Distribution.war" overwrite="yes"/>
To:
<copy preservelastmodified="true" file="ear-application.xml" tofile="${ant.confluence.build.ear}/META-INF/application.xml" overwrite="yes"/>
<copy preservelastmodified="true" file="${ant.confluence.dist}/${ant.confluence.name}-${ant.confluence.version}.war" tofile="${ant.confluence.build.ear}/Confluence War Distribution.war" overwrite="yes"/>
RELATED TOPICS
Confluence Cluster Installation
Configuration Guide
Confluence Setup Guide
Confluence Documentation Home
Confluence Main FAQ
|