Documentation for Confluence 4.1.x. Documentation for earlier versions of Confluence is available too.

Skip to end of metadata
Comment: Corrected links that should have been relative instead of absolute.
Go to start of metadata

Confluence is configured to back up its data. A System Administrator can also manually perform this back up from the Administration Console.

(info) You need to have System Administrator permissions in order to perform this function.

Consider an Production backup strategy if your Confluence site is large or you are encountering problems with your automated backup.

(warning) The information on this page does not apply to Confluence OnDemand.

Creating the Site Backup

To manually back up your site,

  1. Go to the Confluence 'Administration Console':

    • Choose Browse > Confluence Admin. The 'Administrator Access' login screen will be displayed.
    • Enter your password and click Confirm. You will be temporarily logged into a secure session to access the 'Administration Console'.
  2. Click 'Backup & Restore' in the 'Administration' section of the left-hand panel.
  3. Select 'Archive to backups folder' to store a copy of the backup in the same folder as Confluence's backups. (If you do not archive the backup it will be made available for you to download, and then deleted from the server after 24 hours).
  4. Select 'Backup attachments' to include attachments in your backup.
  5. Click 'Backup'.
    (info) Please note that this process will take a few minutes.

If you are running Confluence behind Apache and are facing timeout errors, please consider creating the export directly from Tomcat, instead of going through Apache. This will speed up the process and prevent timeouts.

Retrieving the Backup File

Confluence stores the backup as a zipped XML file in the 'backups' directory under the Confluence Home directory on your Confluence server. To find your Confluence Home directory, see the documentation. You will need access to the Confluence server in order to retrieve this file.

Enabling the Download of the Backup File via the Administration Console

By default, it is not possible to retrieve the backup file via the Confluence Administration Console. This feature is disabled for security reasons.

Administrators can enable this functionality by updating the relevant configuration property as described below. When enabled, you will be prompted to download the backup file when the backup process finished. However, we recommend that you turn the feature off in production environments.

To enable download of the backup file from the Administration Console,

  1. Edit the confluence.cfg.xml file found in the Confluence Home Directory.
  2. Set the value of property admin.ui.allow.manual.backup.download to 'true' (without the quotation marks).
  3. Restart Confluence.

If the value of the above configuration property is 'true', it will be possible to download the backup file after manually backing up the site via the Confluence Administration Console. If the value of this property is 'false' or the property is not present in the configuration file, you will need to retrieve the backup file from the file system on the Confluence server. By default, the value is 'false'.

RELATED TOPICS

Page: Manually Backing Up The Site
Page: Backup FAQ
Page: Production Backup Strategy
Page: Configuring Backups
Page: User Submitted Backup & Restore Scripts
Page: Site Backup and Restore

2 Comments

Hide/Show Comments

  1. Jun 28, 2010

    Anonymous

    If you are running Confluence behind Apache and are facing timeout errors, please consider creating the export directly from Tomcat, instead of going through Apache. This will speed up the process and prevent timeouts.

    what does this mean? If going through the admin console, how do you specify if the backup/export is done through Apache or Tomcat? Do you perform the manual backup via command line somewhere?

    1. Sep 03, 2010

      Sashidaran Jayaraman [Atlassian]

      Hi,

      I believe what it means is to bypass Apache and use Tomcat directly for the backup. For example, if you are using Apache, your URL might be something like http://<domain>.com. Try to bypass this and access Tomcat directly. For example, access http://localhost:8080/confluence/admin/backup.action.

      Hope this helps.

      Cheers
      JSashi