Deduplicating archiver with compression and authenticated encryption.

Thomas Waldmann 98a015772d forgot to list some 0.23.0 stuff in CHANGES %!s(int64=10) %!d(string=hai) anos
borg dd78e1a56e improve docs, usage help, changelog %!s(int64=10) %!d(string=hai) anos
docs 21cfdde73b adjust docs theme colours for note divs %!s(int64=10) %!d(string=hai) anos
scripts 5e98400a5a fix all references to package name %!s(int64=10) %!d(string=hai) anos
.gitattributes 5e98400a5a fix all references to package name %!s(int64=10) %!d(string=hai) anos
.gitignore fbaa505191 PR #206 - Merge branch 'fixes' of https://github.com/thomaswaldmann/attic into merge %!s(int64=10) %!d(string=hai) anos
.travis.yml 906ea629f6 use py.test for testing, document it %!s(int64=10) %!d(string=hai) anos
AUTHORS d1f56d480b update AUTHORS %!s(int64=10) %!d(string=hai) anos
CHANGES 98a015772d forgot to list some 0.23.0 stuff in CHANGES %!s(int64=10) %!d(string=hai) anos
LICENSE cb5c9b63b3 fork: s/attic/borg/g, fix URLs, add new section to AUTHORS %!s(int64=10) %!d(string=hai) anos
MANIFEST.in c7da105fd0 add AUTHORS to MANIFEST.in, so it gets included in releases %!s(int64=10) %!d(string=hai) anos
README.rst e92d94cb07 rephrase compatibility note %!s(int64=10) %!d(string=hai) anos
setup.cfg e1c7da1f53 add flake8 configuration (style checker) %!s(int64=10) %!d(string=hai) anos
setup.py 0ad2ab2496 a bit too much glob there in setup.py, removed %!s(int64=10) %!d(string=hai) anos
tox.ini 906ea629f6 use py.test for testing, document it %!s(int64=10) %!d(string=hai) anos
versioneer.py 673fda39c1 upgrade versioneer to 0.14, makes PEP440 compliant version numbers now %!s(int64=10) %!d(string=hai) anos

README.rst

|build|

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

Borg is a fork of Attic and maintained by "The Borg Collective" (see AUTHORS file).

BORG IS NOT COMPATIBLE WITH ORIGINAL ATTIC.
EXPECT THAT WE WILL BREAK COMPATIBILITY REPEATEDLY WHEN MAJOR RELEASE NUMBER
CHANGES (like when going from 0.x.y to 1.0.0). Please read CHANGES document.

NOT RELEASED DEVELOPMENT VERSIONS HAVE UNKNOWN COMPATIBILITY PROPERTIES.

THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS.

Read issue #1 on the issue tracker, goals are being defined there.

Please also see the LICENSE for more informations.

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

$ borg init /mnt/backup
$ borg create -v /mnt/backup::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
Borg can store data on any remote host accessible over SSH. This is
most efficient if Borg is also installed on the remote host.

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

What do I need?
---------------
Borg requires Python 3.2 or above to work.
Borg also requires a sufficiently recent OpenSSL (>= 1.0.0).
In order to mount archives as filesystems, llfuse is required.

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

$ pip3 install borgbackup

Where are the docs?
-------------------
Go to https://borgbackup.github.io/ for a prebuilt version of the documentation.
You can also build it yourself from the docs folder.

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

$ fakeroot -u tox # you need to have tox installed

.. |build| image:: https://travis-ci.org/borgbackup/borg.svg
:alt: Build Status
:target: https://travis-ci.org/borgbackup/borg