jira Configure

This document will assist you in adding Confluence to your existing JIRA standalone install.

This document is a guideline on how to add Confluence to a JIRA standalone install. It assumes that the files mentioned in this document are shipped with Jira. If you are not running the standalone version of Jira, the steps you will have to take might differ from these instructions.

Step 1 - Download and extract WAR

1. Download the Confluence WAR file
2. Extract the downloaded zip file. It should extract to a folder called confluence-<version>. Inside this folder you'll find a folder called "confluence". Make a note of the absolute path to this directory (as you will need to use it later). Note: Do not copy the confluence folder to the webapps folder inside tomcat - this may cause Confluence to be deployed more than once.

Step 2 - Configure confluence-init.properties

1. Open 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 3 - Edit tomcat context descriptors

If you are deploying to JIRA version 3.3 or higher:

1. Create a file called confluence.xml in your JIRA standalone's conf/Catalina/localhost directory (if you have set up a different hostname for your JIRA 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="true"> <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.

Otherwise (for older versions of JIRA):

1. Open conf/server.xml in a text editor
2. Find the block that begins: <Context path="" docBase="../atlassian-jira" debug="0" reloadable="true"> and ends with </Context> block.
3. After the </Context>, append the following:

   <Context path="/confluence" docBase="c:/applications/confluence-2.1.3/confluence" debug="0" reloadable="true"> <Logger className="org.apache.catalina.logger.FileLogger" prefix="atlassian-confluence." suffix=".log" timestamp="true"/> </Context>

4. For docBase specify the value you noted down earlier.
5. Remove the commons-logging-1.0.4.jar file from the confluence/WEB-INF/lib directory

Do not delete the existing Jira <Context> block. Insert the code above after the Jira <Context> block.

Step 4 - Modify your setenv.sh/bat (ONLY IF YOU ARE RUNNING A SUN MICROSYSTEMS JVM) 

1. Open JIRA's bin/setenv.sh/bat (.sh on unix, .bat on windows) in a text editor.
2. Change the line that says: JAVA_OPTS="-Xms128m -Xmx256m $JAVA_OPTS -Djava.awt.headless=true " to be: JAVA_OPTS="-Xms128m -Xmx256m $JAVA_OPTS -Djava.awt.headless=true -XX:MaxPermSize=128m'

The Java Virtual Machine sets aside a portion of memory as the "permanent space", for objects that it never expects to have to garbage-collect. Because JIRA and Confluence are both quite large applications, it is possible that this permanent space will be filled up. Increasing the application heap size will not help, because the permanent generation size is a separate setting. 

This flag is only supported on JVM's created by Sun Microsystems. If you include this flag while running another vendors JVM (such as JRocket, or IBM's JVM) they will not start.

Step 5 - Restart the Server

1. Shut down, and then restart the standalone server
2. Confluence should now be accessible on the same server as your existing JIRA standalone, under the confluence directory.
   For example, if your JIRA is running at http://jira.example.org:8080/, Confluence will be running on http://jira.example.org:8080/confluencereuse

When setting up the Confluence database do not reuse the JIRA database. Create a new database for Confluence.

Troubleshooting

When I try to send a test mail from Confluence, I get javax.mail.NoSuchProviderException: smtp

In some circumstances, Confluence will be unable to send email after being deployed in the same application-server as JIRA. If, when you try to send a test mail from the administration tool, you get the error: "javax.mail.NoSuchProviderException: smtp", please follow these instructions to fix it.

I have installed JIRA and Confluence in some other application server than Tomcat

These instructions only apply to the standalone Tomcat version of JIRA. Other application servers have not been tested in this configuration, and users have specifically reported difficulties deploying the two applications together in Orion Server and JBoss. We hope to resolve these issues soon.

Confluence is slow, and dumps enormous amounts of information to its logfiles

If you are seeing a large amount of DEBUG logging output, then ensure that you have removed the commons-logging-1.0.4.jar file from the confluence/WEB-INF/lib directory

Comments  (Hide)

The description for the installations works. BUT!

After restarting JIRA all the entries which have been contained (Users, Issues, Projects, ...) before installinge Confluence were gone. We had to import the data from a backup.

Posted by Anonymous at Jan 19, 2005 09:50 | Permalink

Is there a companion document for adding JIRA to a standalone version of Confluence?

Posted by Danny Smitherman at Aug 15, 2005 16:33 | Permalink

There is currently no such document. For various reasons of configuration, adding Confluence to a JIRA standalone is generally easier and preferable to adding JIRA to a Confluence standalone.

Posted by Charles Miller at Aug 15, 2005 23:19 | Permalink

OK, I can do that. I think. How DO I do this? Is it something like this:

1. Shutdown Confluence and Tomcat
2. Install JIRA standalone
3. Start up JIRA standalone
4. Follow instructions for adding Confluence

That easy?

Posted by Danny Smitherman at Aug 16, 2005 14:09 | Permalink

Yes, that's the process to follow.

Posted by Tom Davies at Aug 16, 2005 22:42 | Permalink

At least with JIRA 3.3.1, removing commons-logging-1.0.4.jar from confluence/WEB-INF/lib does not seem necessary. JIRA 3.3.1 uses Tomcat 5.5.9, which has the same commons-logging version as Confluence 1.4.3. If the commons-logging jar is removed from confluence/WEB-INF/lib, I find a huge amount of INFO logging in catalina.out. With commons-logging present, log messages are reduced to a reasonable level.

Posted by Mike McCarrick at Sep 17, 2005 20:00 | Permalink

I did not want confluence to be under JIRA because, in my case, the audiences are different. I chose to do the following:

<Engine name="Catalina" defaultHost="wiki.mydomain.com">

  <Host name="jira.mydomain.com" appBase="webapps" unpackWARs="true" autoDeploy="true">
    <Context path="" docBase="${catalina.home}/atlassian-jira" reloadable="false">
      <Resource name="jdbc/JiraDS" auth="Container" type="javax.sql.DataSource"
        username="jirauser"
        password="jira_password"
        driverClassName="net.sourceforge.jtds.jdbc.Driver"
        url="jdbc:_url_:jiradb"
        validationQuery="Select 1"/>
      <Resource name="UserTransaction" auth="Container" type="javax.transaction.UserTransaction"
        factory="org.objectweb.jotm.UserTransactionFactory" jotm.timeout="60"/>
      <Manager pathname=""/>
    </Context>
  </Host>

  <Host name="wiki.mydomain.com" appBase="webapps" unpackWARs="true" autoDeploy="true">
    <Context path="" docBase="${catalina.home}/../confluence-2.1.5a/confluence" reloadable="false">
      <Logger classname="org.apache.catalina.logger.FileLogger" prefix="atlassian-confluence." suffix=".log" timestamp="true"/>
    </Context>
  </Host>

</Engine>

I have hooked both JIRA and Confluence to authenticate against our Active Directory (LDAP).
I hope this won't cause any integration problems.

Posted by Anthony Whitford at Apr 13, 2006 09:11 | Permalink

I'd like a setup like that too, but I'm not sure if I can do the same on a Jira 3.6 standalone. Should I just wrap the <context> tag in confluence.xml with a <host> tag?

Posted by Michael Ingeman-Nielsen at Jun 20, 2006 07:18 | Permalink

Sure, that should work. You need to make sure the name in the host tag maps to your application server in your DNS.

If you have any issues, please raise a support request at http://support.atlassian.com.

Posted by Matt Ryall at Jun 23, 2006 03:12 | Permalink

Is there a method to allow Confluence and Jira to share users?

Posted by Paul Borowicz at Jun 12, 2006 15:08 | Permalink

Yes there is. Full instructions can be found [here]

Cheers,
Dave

Posted by David Loeng at Jun 12, 2006 20:30 | Permalink

Hi Dave,

I think the link is dead...

Posted by Martin Blazek at Dec 31, 2006 10:31 | Permalink

Hi Martin,

Apologies for that, we've recently moved around/consolidated a lot of our documentation.

Here's the correct link: http://confluence.atlassian.com/display/DOC/Delegate+user+management+to+use+JIRA+logins.

Cheers,
Michelle

Posted by Michelle de Guzman at Jan 01, 2007 18:21 | Permalink

I run JIRA standalone with a context path of "/jira", and I have the context path of Confluence set to "/confluence". The setup here works for me when I am access both JIRA and Confluence via "http://localhost:8080/...". However, I normally run JIRA behind Apache, with the appropriate ProxyPass settings and with "proxyHost" and "proxyPort" set in JIRA's "server.xml".

I expected this would also work for Confluence, that by changing "/jira" to "/confluence" in the URL, I would get Confluence instead of JIRA. However, it isn't working that way. JIRA works OK, but the Confluence URL returns an error 503 page (Service unavailable).

I'm a bit lost as to how to debug this any further. Can anyone suggest what is the appropriate way to have Apache running in front of both JIRA and Confluence? Thanks a lot in advance,

Cheers, Tony.