This page last changed on May 26, 2009 by jlargman.

On this page

Step 1. Check the Known Issues for Tomcat

Read through the Known Issues for Apache Tomcat.

Step 2. Download and Extract EAR-WAR Installation File

This section gives detailed instructions for installing Confluence EAR-WAR edition on an Apache Tomcat 5.5, or 6 server.

  1. Download the Confluence EAR/WAR zip file. (You need to click the 'Show all' link to see the EAR/WAR zip file.)
  2. Please check your unzip program before extracting the downloaded zip file. Some archive-extract programs cause errors when unzipping the Confluence zip file:
    • Windows users must avoid the Windows built-in unzip utility, as it doesn't extract all the files. Use a third-party unzip program like 7Zip or Winzip.
    • Solaris users will need to use GNU tar to handle the long file names.
  3. Extract the downloaded zip file.
    • Tomcat users, take care not to unzip the Confluence installation into your Tomcat webapps folder, as this may cause Confluence to be deployed more than once.
  4. You have now unzipped your Confluence installation directory, which should contain the version number e.g. confluence-2.10.0 or confluence-2.10.2. This directory will be later referred to as the Confluence installation directory. Inside is a confluence subdirectory, referred to later as the (Exploded) Confluence WAR directory. Record the absolute path to the Confluence WAR directory.

Step 3. Check for Patches

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

Step 4. Check for Application Server Issues

Note that these are optionals and you do not need to go through them to make Confluence EAR/WAR run for the first time. They are listed here only to assist you in getting the best matching configuration for your production requirement.

Step 5. Review Application Server Memory Allocation

Confluence requires a maximum heap allocation (Xmx) of at least 256 MB for normal operation. See Increasing Application Server Memory.

Do not configure a heap allocation so large that it does not allow enough remaining physical memory for your operating system and other applications on the server. The heap allocation should be large enough for Confluence, but not so large that the memory would be paged to disk during normal operation.

Step 6. Configure confluence-init.properties

  1. Inside the Confluence installation directory, edit ...confluence/WEB-INF/classes/confluence-init.properties in a text editor.
  2. Now define your Confluence Home directory, by setting the confluence.home property to a directory of your choosing.
    We suggest using different paths for your installation and home directories. This will facilitate upgrades. This is the directory that will contain all of Confluence's configuration, backup and attachment files.
    Tip: Another term for 'Home directory' would be 'data directory'.

Step 7. Edit Tomcat Context Descriptors

  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.) For Tomcat 6, you must create the Catalina and localhost directories.
  2. Open your new confluence.xml and add these lines:
    <Context path="/confluence" docBase="c:/applications/confluence-2.9.2/confluence" debug="0" reloadable="true">
    </Context>
    

    To run Confluence without a context path of "/confluence", change the path in the Context tag to an empty string (""). If this is Tomcat, name the file ROOT.xml rather than confluence.xml. If you wish to change the context path to a different name, change both the context path and the name of the xml file.

  3. For docBase, specify the value you noted down earlier.
  4. Restart Tomcat, and Confluence should be accessible under /confluence/ on your Tomcat server.
  5. Follow the link below to proceed with the setup wizard.

Step 8. Add UTF-8 Encoding

  1. Edit conf/server.xml and find the line where the Coyote HTTP Connector is defined. It will look something like this, possibly with more parameters:
    <Connector port="8080"/>
    
  2. Add a URIEncoding="UTF-8" property to the connector:
    <Connector port="8080" URIEncoding="UTF-8"/>
    

Step 9. Optional: Run Tomcat on a Different Port

See Running Tomcat on a Different Port.

Step 10. Optional: Running Confluence as a Windows Service

Confluence can be run as a service.

Proceed Through the Confluence Setup Wizard

When you visit the Confluence application in your browser, the Confluence Setup Wizard should appear. The first screen is a prompt for you to enter your license key. Follow the instructions on the screens, and read more guidelines on the Confluence Setup Wizard.

TROUBLESHOOTING

Installation FAQ

RELATED TOPICS

Confluence Setup Guide
Start Confluence automatically on Windows as a Service
Configuration Guide
Confluence Home Directory
Confluence Cluster Installation
Fedora or RHEL/Centos Install GuideContributed by a Confluence user
Known Issues with Enterprise or Webhosting environments
Pull down RSS Feeds or use the Repository plugin through a web proxy
Setting the JAVA_HOME Variable in Windows
Setup a mail session in standalone version
Confluence Documentation Home
Confluence FAQ
Installing Confluence EAR-WAR on Weblogic
Configuring a MySQL Datasource in Apache Tomcat

Document generated by Confluence on Dec 10, 2009 18:41