Documentation for Confluence 5.4.
Documentation for Confluence OnDemand and earlier versions of Confluence is available too.

Skip to end of metadata
Go to start of metadata

This page tells you how to set up a MySQL datasource connection for Confluence.

Step 1. Shut down Tomcat

  1. Run bin/shutdown.sh or bin/shutdown.bat to bring Tomcat down while you are making these changes.
  2. Make a backup of your <CONFLUENCE_HOME>/confluence.cfg.xml file and your <CONFLUENCE_INSTALLATION>/conf/server.xml file, so that you can easily revert if you have a problem.

Step 2. Install the MySQL database driver

  1. Download the MySQL JDBC driver. Links are available on this page: Database JDBC Drivers.
  2. Unpack the archive file you have downloaded, and find the JAR file called something like this: mysql-connector-java-x.x.x-bin.jar, where x.x.x is a version number.
  3. Copy the JAR file into the lib folder of your Tomcat installation: <TOMCAT-INSTALLATION>/lib.

On this page:

Related pages:

Step 3. Configure Tomcat

  1. Edit the conf/server.xml file in your Tomcat installation.
  2. Find the following lines:

  3. Insert the DataSource Resource element within the Context element, directly after the opening <Context.../> line,  before Manager:

    • 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, add "&useUnicode=true&characterEncoding=utf8" on the end of the above URL.
Notes
  • If switching from a direct JDBC connection to a datasource connection, you can find the above details in your <CONFLUENCE_HOME>/confluence.cfg.xml file.
  • The configuration properties for Tomcat's standard datasource resource factory (org.apache.tomcat.dbcp.dbcp.BasicDataSourceFactory) are as follows:
    • driverClassName – Fully qualified Java class name of the JDBC driver to be used.
    • maxActive – The maximum number of active instances that can be allocated from this pool at the same time.
    • maxIdle – The maximum number of connections that can sit idle in this pool at the same time.
    • maxWait – The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception.
    • password – Database password to be passed to your JDBC driver.
    • url – Connection URL to be passed to your JDBC driver. (For backwards compatibility, the property driverName is also recognised.)
    • user – Database username to be passed to your JDBC driver.
    • validationQuery – SQL query that can be used by the pool to validate connections before they are returned to the application. If specified, this query must be an SQL SELECT statement that returns at least one row.
  • Why is the validationQuery element needed? When a database server reboots, or there is a network failure, all the connections in the connection pool are broken and this normally requires an application server reboot. However, the Commons DBCP (Database Connection Pool) which is used by the Tomcat application server can validate connections before issuing them by running a simple SQL query, and if a broken connection is detected, a new one is created to replace it. To do this, you will need to set the validationQuery option on the database connection pool.

Step 4. Configure the Confluence web application

  1. Edit this file in your Confluence installation: <CONFLUENCE_INSTALLATION>/confluence/WEB-INF/web.xml.
  2. Insert the following element just before </web-app> near the end of the file:

If you are changing an existing Confluence installation over to using a Tomcat datasource:

  1. Edit the <CONFLUENCE_HOME>/confluence.cfg.xml file.
  2. Delete any line that contains a property that begins with hibernate.
  3. Insert the following at the start of the <properties> section.

Step 5. Restart Tomcat

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

14 Comments

  1. 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.

  2. 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.

    1. 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

  3. When configuring Confluence, the instructions direct to remove all properties that begin with '''hibernate'''. We have properties begining with '''hibernate.3cp0'''. Will the '''3cp0''' statements removal cause a problem?

  4. After upgrading from confluence 2.9.2 to 2.10.3 this seems to no longer be working.

    I just get the following error about, "sql: Unexpected program error: com.atlassian.renderer.v2.macro.MacroException: org.apache.tomcat.dbcp.dbcp.SQLNestedException: Cannot create PoolableConnectionFactory (Could not create connection to database server. Attempted reconnect 3 times. Giving up.)"

  5. Have you copied the MySQL Java Connector to \...\confluence\WEB-INF\lib ?

    Regards

    1. Yes, we are using a MySQL backend for confluence which is working fine.  It's just the data source that isn't.

      1. I figured it out.  The MySQL host cache needed to be cleared on the database server.

      2. Anonymous

        any solution to that ?

        I did step by step this manual on 2 fresh freebsd8 VMs and:

        any ideas here ? tomcat v6 , mysql5 what a reason of not working this could be ?

        1. Anonymous

          Ever found a solution?

  6. Anonymous

    <res-type>javax.sql.Datasource</res-type> should be <res-type>javax.sql.DataSource</res-type> with a capital 'S'.

  7. Anonymous

    how can i do this without shutting down tomcat or interrupting the service?

    I have a SaaS application with several  db, one for each client and i can't shutdown everytime i add a new client.

    thanks!

    1. Is using a direct JDBC connection an option? That wouldn't require a restart of Tomcat for each new client.

      Also note that deploying multiple Atlassian applications in the same container is not supported: Deploying Multiple Atlassian Applications in a Single Tomcat Container.