Backup Manager

Name Backup Manager
Vendor Adaptavist.com Ltd (Website)
Authors Dan Hardiker, Keith Brophy
Homepage http://confluence.atlassian.com/display/CONFEXT/Backup+Manager
Issue Management http://jira.adaptavist.com/browse/CBM
Continuous Integration n/a
Categories Administration
Most Recent Version 1.1.3
Availability Confluence v2.10-m1 to v2.10.3
State Stable
Support By: Adaptavist Community Support
Website: http://www.adaptavist.com/display/free/Support
License Freeware / Open Source (BSD)
Price Free
Release Docs https://www.adaptavist.com/display/Host/Backup+Manager+plugin
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/confluence/backup-manager/tags/1.1.3
Download JAR backup-manager-1.1.3.jar
Use the Atlassian Plugin Repository inside of Confluence to install this plugin!
This plugin assumes there is a $confluence.home/backups directory with zip files in – this is the case for the majority of unaltered Confluence installations.

Description/Features

A simple plugin for listing / downloading / deleting the backups from your Confluence installation (made automatically each night and placed in the home directory). You can also configure the worker job that makes sure that your backup directory is cleaned to your specifications.

Once installed, you'll see a new "Backup Manager" link in the Administration Console:

Click it to launch the Backup Manager. There are two key sections, we'll start with the file listing (bottom section) first...

File Listing

This lists all your backup files in reverse chronological order, with the newest at the top. Clicking the filename will download the backup; selecting the checkbox next to files and pushing the button will delete them (after asking you for confirmation, of course).

The skulls next to some of the items indicate that they will be deleted next time the housekeeping worker runs; they are also checked for deletion so that you can easily remove them now (or modify the selection first).

Housekeeping

This area controls a worker process which will run in the background and clean up the backup directory based on your criteria.

First, you need to specify how often you want the worker to actually execute - the job triggers every 5 minutes, but you can configure it to a more appropriate timing value here. The table also shows the last time that the worker executed, and the next time that it is due to execute. Please note that these times will be reset if you restart either Confluence or disable/uninstall the plugin.

Second, you need to define which conditions are enabled and what their settings are - they should be self explanatory. To familiarise yourself with the effects of the various combinations, I suggest setting the worker interval to 'never' and playing around with the settings. The skulls shown in the file listing will show you what the effects will be if the worker runs.

You can always reset the configuration of the worker back to the defaults, or you can run the configuration now. Please note that 'run now' first saves any configuration changes – which may affect the outcome from what is shown by the skulls.

The defaults are sensible and will suit most people.

Version History

Version Date State License Price
Show description 1.0 (#1) 31 Jul 2007 Stable Freeware / Open Source (BSD) Free

Release Notes
The initial public release.

Contributors

Show description 1.1 (#2) 01 Aug 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

The JIRA server does not support trust requests. Issues have been retrieved anonymously. You can set the macro to always use an anonymous request by setting the anonymous parameter to true
JIRA Issues (4 issues)
Type Key Summary Assignee Reporter Priority Status Resolution Created Updated Due
New Feature CBM-4 Show an icon next to backups which will be deleted by the next execution of the worker Dan Hardiker Dan Hardiker Major Closed Fixed Aug 01, 2007 Aug 01, 2007
Improvement CBM-3 Show the total size of the backups folder Dan Hardiker Dan Hardiker Major Closed Fixed Aug 01, 2007 Aug 01, 2007
New Feature CBM-2 Create a Housekeeping Worker Dan Hardiker Dan Hardiker Major Closed Fixed Aug 01, 2007 Aug 01, 2007
Improvement CBM-1 Sort list of backup files in UI - preferably by date Dan Hardiker Jack Baty Minor Closed Fixed Aug 01, 2007 Aug 01, 2007

Contributors

Show description 1.1.1 (#3) 01 Aug 2007 Stable Freeware / Open Source (BSD) Free

Release Notes
Bad default which deleted anything older than a day. Turning default worker off by default.

Contributors

Show description 1.1.2 (#4) 15 Jan 2009 Stable Freeware / Open Source (BSD) Free

Release Notes
Update for Confluence 2.10 compatibility.

Contributors

Show description 1.1.3 (#5) 20 Mar 2009 Stable Freeware / Open Source (BSD) Free

Release Notes
Ensure only system administrators and super users (those who belong to the confluence-administrators group) can access the backup action. This is in line with the system backup actions within Confluence.

Contributors

Outstanding Issues

Labels

plugin plugin Delete
backups backups Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Comments (7)

 

  1. Jan 18, 2008

    Bob Swift says:

    Is this only suppose to work if you are using the default backup directory locat...

    Is this only suppose to work if you are using the default backup directory location - backups directory in home directory? That is what seems to be happening on my 2.7 system. Apparently, that is the restriction, since that is noted on the top of the page!

    1. Jan 19, 2008

      Dan Hardiker says:

      You are right, the documented restriction is accurate.

      You are right, the documented restriction is accurate.

  2. Jul 21, 2008

    John Thurston says:

    I've tried the plugin but find it does not behave as expected. If I set the wor...

    I've tried the plugin but find it does not behave as expected.

    If I set the worker-interval at every week, and check the box for Delete oldest backup files until only 10 remain in total,  all of my backups are marked with a skull when I hit the update button.  I see the same resultsif I check the box for Delete any remaining backups which are older than 4 weeks.    In my example, I have fewer than 10 files which are all less than 4-weeks of age. 

    If I press the Run Now button, it actually does delete all of my backup files

    The Keep at least...  and the Delete oldest backups while...  settings seem to work correctly, but the other two seem to be broken.

  3. Dec 23, 2008

    Bastian Widmer says:

    Hi there. Is someone else experiencing problems with the Backupmanager 1.1.1 on...

    Hi there.

    Is someone else experiencing problems with the Backupmanager 1.1.1 on Confluence 2.10.

    I run 2 Servers and they behave strange with the new Version of Confluence.

    I can't update my Settings ... each value is nulled out or set to minimum after hitting the Update Button (along with setting the Worker Interval)

    Someone has the same problems?

    greetings bastian

    1. Jan 12

      Christian Nesemann says:

      yes, same here. It doesn't seem to work with Confluence 2.10

      yes, same here.

      It doesn't seem to work with Confluence 2.10

      1. Jan 13

        Christian Nesemann says:

        ok created an issue for that.

        ok created an issue for that.

  4. Jan 28

    Laurie Iversen says:

    when I try to use it with version 2.10.1 I get the following error: org.apache....

    when I try to use it with version 2.10.1 I get the following error:

    org.apache.velocity.exception.MethodInvocationException: Invocation of method 'getTotalLength' in class com.adaptavist.confluence.backups.BackupManagerAction threw exception java.lang.NullPointerException @ /templates/backups/backup-manager.vm[168,107]
        at org.apache.velocity.runtime.parser.node.ASTMethod.execute(ASTMethod.java:286)

    caused by: java.lang.NullPointerException
        at com.adaptavist.confluence.backups.BackupManagerAction.getTotalLength(BackupManagerAction.java:73)