[[PageOutline(2-5,Contents,pullout)]]

= Backup tool that enhances the trac-admin hotcopy utility

== Description

This plugin is a script that provides some additional functionality around TracAdmin's hotcopy function. The script supports archiving the backup in '''gzip''', '''bzip2''' or '''zip''' format and can be configured to retain a specified number of past backups. Ideal for use as a cron job.

The script is derived from the 'hot-backup.py' script included in the Subversion distribution, which provides similar functionality around Subversion's hotcopy utility.

{{{
USAGE: trac-hot-backup.py [OPTIONS] PROJECT_PATH BACKUP_PATH

Create a backup of the project at PROJECT_PATH in a subdirectory of
the BACKUP_PATH location, named with the backup date and time.

Options:
  --archive-type=FMT Create an archive of the backup. FMT can be one of:
                       bz2 : Creates a bzip2 compressed tar file.
                       gz  : Creates a gzip compressed tar file.
                       zip : Creates a compressed zip file.
  --num-backups=N    Number of prior backups to keep around (0 to keep all).
  --help      -h     Print this help message and exit.
}}}

Examples:

 1. Back up the project at `/var/trac/myproj` to `/nfs/backup/trac/myproj-YYYY-mm-dd-HHMM`:

 {{{#!sh
trac-hot-backup.py /var/trac/myproj /nfs/backup/trac
}}}

 2. Back up the project at `/var/trac/myproj` to `/nfs/backup/trac/myproj-YYYY-mm-dd-HHMM.tar.gz` and delete all but the 7 most recent backups, including the one just created:

 {{{#!sh
trac-hot-backup.py --archive-type=gz --num-backups=7 /var/trac/myproj /nfs/backup/trac
}}}

== Bugs/Feature Requests

Existing bugs and feature requests for TracHotBackupScript are 
[report:9?COMPONENT=TracHotBackupScript here].

If you have any issues, create a 
[/newticket?component=TracHotBackupScript new ticket].

[[TicketQuery(component=TracHotBackupScript&group=type,format=progress)]]

== Download

Download the zipped source from [export:trachotbackupscript here], or fetch the script itself [/svn/trachotbackupscript/anyrelease/trac-hot-backup.py here].

== Source

You can check out TracHotBackupScript from [/svn/trachotbackupscript/anyrelease here] using Subversion, or [source:trachotbackupscript/anyrelease browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== Recent Changes

[[ChangeLog(trachotbackupscript, 3)]]

== Author/Contributors

'''Author:''' [wiki:kcalcagno] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''