Deduplicating archiver with compression and authenticated encryption.

Thomas Waldmann 859c33d42b docs: add solutions for (ll)fuse installation problems 10 gadi atpakaļ
borg ed2548ca02 add a __main__.py to nuitka works 10 gadi atpakaļ
docs 859c33d42b docs: add solutions for (ll)fuse installation problems 10 gadi atpakaļ
requirements.d 0b226aec7a add development.txt and modify tox.ini 10 gadi atpakaļ
.gitattributes 5e98400a5a fix all references to package name 10 gadi atpakaļ
.gitignore fbaa505191 PR #206 - Merge branch 'fixes' of https://github.com/thomaswaldmann/attic into merge 10 gadi atpakaļ
.travis.yml 906ea629f6 use py.test for testing, document it 10 gadi atpakaļ
AUTHORS 95828c576d update AUTHORS 10 gadi atpakaļ
CHANGES e17ca5123e Update CHANGES 10 gadi atpakaļ
LICENSE cb5c9b63b3 fork: s/attic/borg/g, fix URLs, add new section to AUTHORS 10 gadi atpakaļ
MANIFEST.in c7da105fd0 add AUTHORS to MANIFEST.in, so it gets included in releases 10 gadi atpakaļ
README.rst 9880ac7ba8 README: mention pytest 10 gadi atpakaļ
setup.cfg 0580f2b4eb style and cosmetic fixes, no semantic changes 10 gadi atpakaļ
setup.py 922a1f6bb7 never fall back to distutils, any sane install method uses setuptools 10 gadi atpakaļ
tox.ini 0b226aec7a add development.txt and modify tox.ini 10 gadi atpakaļ
versioneer.py 673fda39c1 upgrade versioneer to 0.14, makes PEP440 compliant version numbers now 10 gadi atpakaļ

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 and pytest installed

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