This page last changed on Jul 18, 2006 by david.soul@atlassian.com.

Instructions on setting up a MySQL DataSource connection for Confluence Standalone or EAR/WAR.

autoReconnect=true is required

The Confluence database connection URL must have autoReconnect=true added to the end to prevent disconnection issues.

Shut down Tomcat

  • Run bin/shutdown.sh or bin/shutdown.bat to bring Tomcat down while you are making these changes

Install the Drivers

  • download the MySQL JDBC drivers from http://www.mysql.com/downloads/api-jdbc-stable.html.
  • After unpacking the file you have downloaded, you'll find a file called something like mysql-connector-java-3.0.10-stable-bin.jar.
  • Copy this file into the common/lib directory of your Tomcat installation.

Configure Tomcat

The configuration is different for Conflence 2.2 onwards due to an upgrade to Tomcat 5.5

For users of Confluence 2.2 and later

  • If you are using the Standalone distribution. edit the conf/server.xml file in your Tomcat installation. Users running their own Tomcat instance must edit the xml file where they declared the Confluence Context descriptor.
  • If editing conf/server.xml, find the following lines:
    <Context path="" docBase="../confluence" debug="0" reloadable="true">
                        <!-- Logger is deprecated in Tomcat 5.5. Logging configuration for Confluence is specified in confluence/WEB-INF/classes/log4j.properties -->
  • Within the Context tags, directly after the opening <Context.../> line, insert the DataSource Resource tag:
    <Resource name="jdbc/confluence" auth="Container" type="javax.sql.DataSource"
             username="yourusername"
             password="yourpassword"
             driverClassName="com.mysql.jdbc.Driver"
             url="jdbc:mysql://localhost:3306/confluence?autoReconnect=true"
             validationQuery="Select 1" />
    • Replace the username and password parameters with the correct values for your database
    • In the url parameter, replace the word 'confluence' with the name of the database your confluence data will be stored in.
    • If you plan to use non-latin characters, you will also need to add "&useUnicode=true&characterEncoding=utf8" on the end of the above URL. These options are not required for any database other than MySQL.

For users of Confluence 2.1.x and earlier

  • Edit the conf/server.xml file in your Tomcat installation
  • Find the following lines:
    <Context path="" docBase="../confluence" debug="0" reloadable="true">
           <Logger className="org.apache.catalina.logger.FileLogger" prefix="atlassian-confluence."
           suffix=".log" timestamp="true"/>
  • Directly after the <Logger.../> line, (before the next </Context> line), insert the following:
    <Resource name="jdbc/confluence" auth="Container" type="javax.sql.DataSource"/>
    <ResourceParams name="jdbc/confluence">
        <parameter>
             <name>factory</name>
             <value>org.apache.commons.dbcp.BasicDataSourceFactory</value>
        </parameter>
        <parameter>
             <name>maxActive</name>
             <value>20</value>
        </parameter>
        <parameter>
             <name>maxIdle</name>
             <value>10</value>
        </parameter>
        <parameter>
            <name>maxWait</name>
            <value>10000</value>
        </parameter>
        <parameter>
            <name>username</name>
            <value>yourusername</value>
        </parameter>
        <parameter>
            <name>password</name>
            <value>yourpassword</value>
        </parameter>
        <parameter>
            <name>driverClassName</name>
            <value>com.mysql.jdbc.Driver</value>
        </parameter>
        <parameter>
            <name>url</name>
            <value>jdbc:mysql://localhost:3306/confluence?autoReconnect=true</value>
        </parameter>
    </ResourceParams>
    • You may want to choose different maxActive and maxIdle values: these are how many total database connections will be allowed at one time, and how many will be kept open even when there is no database activity
    • Replace the username and password parameters with the correct values for your database
    • In the url parameter, replace the word 'confluence' with the name of the database your confluence data will be stored in.
    • If you plan to use non-latin characters, you will also need to add &useUnicode=true&characterEncoding=utf8 on the end of the above URL. These options are not required for any database other than MySQL.

Configure the Confluence web application

  • Edit confluence/WEB-INF/web.xml in your confluence installation
  • Go to the end of the file and just before </web-app>, insert the following:
    <resource-ref>
            <description>Connection Pool</description>
            <res-ref-name>jdbc/confluence</res-ref-name>
            <res-type>javax.sql.Datasource</res-type>
            <res-auth>Container</res-auth>
        </resource-ref>

Configure Confluence

  • If you have not yet set up Confluence
    • Follow the steps in the Confluence Setup Guide
    • In the Database Setup section, choose the "Datasource Connection" option.
    • Set the JNDI name to java:comp/env/jdbc/confluence
    • Set the Database dialect to MySQL.
  • If you are changing an existing Confluence installation over to using a Tomcat datasource
    • Find your ConfluenceHome directory (see: Where Is My ConfluenceHome Directory? if you don't know where it is).
    • Edit the confluence.cfg.xml file
    • Delete any line that contains a property that begins with hibernate.
    • Insert the following at the start of the <properties> section.
      <property name="hibernate.setup"><![CDATA[true]]></property>
          <property name="hibernate.dialect"><![CDATA[net.sf.hibernate.dialect.MySQLDialect]]></property>
          <property name="hibernate.connection.datasource"><![CDATA[java:comp/env/jdbc/confluence]]></property>

Restart Confluence

  • Run bin/startup.sh or bin/startup.bat to start Tomcat with the new settings.

F.A.Q.

I see "Can't call commit when autocommit=true" during an upgrade of Confluence or otherwise.

Check out http://jira.atlassian.com/browse/CONF-1710 This error can be fixed by adding:
&relaxAutoCommit=true
to the end of your JDBC url.

Example:
jdbc:mysql://localhost/confdb?autoReconnect=true&relaxAutoCommit=true

This JDBC url can be found in your confluence.cfg.xml file located in your confluence home folder.

The Configure the Confluence web application instructions give me an error with Tomcat. Specifically, when I add my resource-ref section such that it appears directly under the <description> line I get an error on startup saying the xml file could not be parsed. To resolve this I moved the <resource-ref> section to the end of the file and it starts up/works fine.

Posted by william.crighton at Aug 19, 2004 14:00

With tomcat 5.0.22 and jdk1.5.0_09 against RHEL 4 update 3, I was having problems with multiple parameters to the context/resource/url paramater.  The instructions above sayto add additional parameters with "&".  If you are having errors that complain about proper delimeter ';', then try to replace "&" with "&" instead.

Posted by jbrooks at Oct 07, 2006 16:39

Jeff, you meant to say : then try to replace ";" with "&" instead. Right?

Posted by ivan@atlassian.com at Oct 08, 2006 16:52

Whoops! No, I was trying to show that you should try the escaped version, but it was fully parsed in my comment above. That comment was supposed to say:
...try to replace "&" with "& a m p ;" without the spaces

The example listed above in the FAQ is:
jdbc:mysql://localhost/confdb?autoReconnect=true&relaxAutoCommit=true

If I did that in my install, I would get an error complaining about the need of ';' delimeter for the second paramter. So instead, I used:
jdbc:mysql://localhost/confdb?autoReconnect=true& a m p ;relaxAutoCommit=true

(and again, you will have to remove the spaces between the & and a and m and p and ;

Posted by jbrooks at Oct 08, 2006 17:37

Okay, I finally became smart enough to try this with a code macro:

Instead of:

jdbc:mysql://localhost/confdb?autoReconnect=true&relaxAutoCommit=true

You would use:

jdbc:mysql://localhost/confdb?autoReconnect=true&amp;relaxAutoCommit=true
Posted by jbrooks at Oct 08, 2006 17:39

Thanks Jeff, I made a mistake too, not ';' yet

 &amp 

Posted by ivan@atlassian.com at Oct 08, 2006 19:22

I have a few databases, confluencedb, which stores the confluence stuff, and webdb, which stores some web-related stuff. I would like to put some of the things in the webdb on the wiki, too. I thought/think that's possible with the sql plugin.

However, I keep getting "sql: Security restricted macro with parameter 'datasource' and parameter value 'databasename' is not allowed on this page".

Is there a way to find out more about the error? The logs don't look like Confluence is even attempting to access webdb. I tried changing the names of the datasource to various configurations (for example, connecting to confluencedb, which I know it's using b/c I can login and see content on the wiki), and commented out the restrictions in macro-security.properties just for testing, but I keep getting the same error.

Posted by amyoung at Dec 05, 2006 11:31

Because running arbitrary SQL on a server is not something you want to allow everybody to do, the sql macro, when installed, is disabled by default for security.

See http://confluence.atlassian.com/display/CONFEXT/Scripting+and+External+Content+Macros

Posted by don.willis@atlassian.com at Dec 10, 2006 23:39
Document generated by Confluence on Mar 22, 2007 20:55