README 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. Overview
  2. --------
  3. atticmatic is a simple Python wrapper script for the Attic backup software
  4. that initiates a backup and prunes any old backups according to a retention
  5. policy. The script supports specifying your settings in a declarative
  6. configuration file rather than having to put them all on the command-line, and
  7. handles common errors.
  8. Read more about Attic at https://attic-backup.org/
  9. Setup
  10. -----
  11. To get up and running with Attic, follow the Attic Quick Start guide at
  12. https://attic-backup.org/quickstart.html to create an Attic repository on a
  13. local or remote host.
  14. If the repository is on a remote host, make sure that your local root user has
  15. key-based ssh access to the desired user account on the remote host.
  16. To install atticmatic, run the following from the directory containing this
  17. README:
  18. python setup.py install
  19. Then copy the following configuration files:
  20. sudo cp sample/atticmatic.cron /etc/init.d/atticmatic
  21. sudo cp sample/config sample/excludes /etc/atticmatic/
  22. Lastly, modify those files with your desired configuration.
  23. Usage
  24. -----
  25. You can run atticmatic and start a backup simply by invoking it without
  26. arguments:
  27. atticmatic
  28. To get additional information about the progress of the backup, use the
  29. verbose option:
  30. atticmattic --verbose
  31. If you'd like to see the available command-line arguments, view the help:
  32. atticmattic --help
  33. Running tests
  34. -------------
  35. To install test-specific dependencies, first run:
  36. python setup.py test
  37. To actually run tests, run:
  38. nosetests --detailed-errors
  39. Feedback
  40. --------
  41. Questions? Comments? Got a patch? Contact witten@torsion.org