Go to file
Dan Christensen 6b639e4c22 Update prune docs and a few other things in usage.rst. 2014-02-03 20:11:47 -05:00
attic Update prune docs and a few other things in usage.rst. 2014-02-03 20:11:47 -05:00
docs Update prune docs and a few other things in usage.rst. 2014-02-03 20:11:47 -05:00
scripts Project rename 2013-07-09 20:14:18 +02:00
.gitattributes Added .gitattributes 2013-08-12 15:12:14 +02:00
.gitignore Packaging improvements 2013-06-24 13:53:02 +02:00
.travis.yml travis: Don't try to use fuse since it's not available 2013-07-25 23:18:34 +02:00
AUTHORS Added AUTHORS file 2014-02-03 21:07:03 +01:00
CHANGES Fix deadlock when extracting 0 sized files from remote repositories 2014-01-30 22:16:21 +01:00
LICENSE Fix sorting of segment names to ignore NFS left over files. 2014-01-03 14:47:44 +01:00
MANIFEST.in Start using versioneer for version numbers 2013-08-05 23:05:15 +02:00
README.rst Update README.rst with the correct way to run the test suite 2014-02-03 23:03:25 +01:00
setup.py Start using versioneer for version numbers 2013-08-05 23:05:15 +02:00
tox.ini Project rename 2013-07-09 20:14:18 +02:00
versioneer.py Start using versioneer for version numbers 2013-08-05 23:05:15 +02:00

README.rst

What is Attic?
--------------
Attic is a deduplicating backup program. The main goal of attic is to provide
an efficient and secure way to backup data. The data deduplication
technique used makes Attic suitable for daily backups since only actual changes
are stored.

Easy to use
~~~~~~~~~~~
Initialze backup repository and create a backup archive::

    $ attic init /usbdrive/my-backup.attic
    $ attic create -v /usbdrive/my-backup.attic::documents ~/Documents

Main features
~~~~~~~~~~~~~
Space efficient storage
  Variable block size deduplication is used to reduce the number of bytes 
  stored by detecting redundant data. Each file is split into a number of
  variable length chunks and only chunks that have never been seen before are
  compressed and added to the repository.

Optional data encryption
    All data can be protected using 256-bit AES encryption and data integrity
    and authenticity is verified using HMAC-SHA256.

Off-site backups
    attic can store data on any remote host accessible over SSH as long as
    attic is installed.

Backups mountable as filesystems
    Backup archives are mountable as userspace filesystems for easy backup
    verification and restores.

What do I need?
---------------
Attic requires Python 3.2 or above to work. Besides Python attic also requires 
msgpack-python and sufficiently recent OpenSSL (>= 1.0.0).

How do I install it?
--------------------
::

  $ pip install Attic

Where are the docs?
-------------------
Go to https://pythonhosted.org/Attic/ for a prebuilt version of the docs. You
can also build them yourself form the docs folder.

Where are the tests?
--------------------
The tests are in the attic/testsuite package. To run the test suite use the
following command::

  $ fakeroot -u python -m attic.testsuite.run