ArchiCOW documentation

Contents:

• Installation
  • Install as a Python distribution
  • Install from Git repository
• Configuration
  • Invocation
  • Configuration file
• Process modules
  • RsyncProcess
• Storage modules
  • HardlinkStorage
  • BtrfsStorage
• Prepare scripts
  • Mount bind – prepare_mountbind.sh
  • LVM snapshot – prepare_lvmsnap.sh

Overview

Backup system supporting copy-on-write storage.

Features

• aims to be easy, admin friendly tool
  • runs from cron
  • simple filesystem structure of backups, accessible without the need of special tools
  • outputs machine parsable status of your backups for monitoring tools (planned)
• pluggable backup methods
  • rsync over SSH
  • tar over SSH (planned)
• pluggable backup storage modules
  • simple file or directory
  • incremental with hard links between common files
  • BTRFS snapshot incremental storage
• optional remote helper scripts to prepare data for backup
  • create LVM snapshot for consistency
  • bind-mount root FS for clean backup without other mounts
  • dump database (planned)

Locations

ArchiCOW packages are available from Cheese shop (PyPI) at https://pypi.python.org/pypi/archicow

Documentation is available online at http://pythonhosted.org/archicow/

The project page is hosted on Github.

If you’ve never worked with git or contributed to a project on Github, there is a quick start guide.

If you find something wrong or know of a missing feature, please create an issue on the project page. If you find that inconvenient or have some security concerns, you could also drop me a line at <devel@beli.sk>.

License

Copyright 2014-2015 Michal Belica <devel@beli.sk>

ArchiCOW is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

ArchiCOW is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with ArchiCOW.  If not, see < http://www.gnu.org/licenses/ >.

A copy of the license can be found in the LICENSE file in the distribution.