mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-22 15:57:15 +00:00
Code Issues Releases Wiki Activity
No description
842 commits 9 branches 139 tags 60 MiB
Python 86.6%
Cython 7.5%
HTML 3.3%
Shell 1.9%
C 0.7%
Find a file
Thomas Waldmann 95828c576d update AUTHORS 
I merged some pull requests of other developers into borg and now added
them to the developers / contributors list, with permission.

In general, feel free to add yourself to the list if you contributed something
to borg - just make a pull request including your addition to AUTHORS.

That's way easier for me than having to ask whether you want to be in there
and how precisely... - just write your entry yourself!
2015-07-02 23:05:14 +02:00
borg clarify help text, fixes #73 2015-06-28 14:02:38 +02:00
docs add related projects, fix web site url 2015-06-29 23:30:36 +02:00
scripts fix all references to package name 2015-05-22 19:21:41 +02:00
.gitattributes fix all references to package name 2015-05-22 19:21:41 +02:00
.gitignore PR #206 - Merge branch 'fixes' of https://github.com/thomaswaldmann/attic into merge 2015-03-06 23:18:08 +01:00
.travis.yml use py.test for testing, document it 2015-05-22 21:26:41 +02:00
AUTHORS update AUTHORS 2015-07-02 23:05:14 +02:00
CHANGES update CHANGES 2015-06-21 02:36:22 +02:00
LICENSE fork: s/attic/borg/g, fix URLs, add new section to AUTHORS 2015-05-13 15:02:33 +02:00
MANIFEST.in add AUTHORS to MANIFEST.in, so it gets included in releases 2015-06-11 23:04:31 +02:00
README.rst README: mention pytest 2015-06-12 00:11:16 +02:00
setup.cfg add flake8 configuration (style checker) 2015-05-22 21:28:00 +02:00
setup.py a bit too much glob there in setup.py, removed 2015-05-22 22:55:35 +02:00
tox.ini use py.test for testing, document it 2015-05-22 21:26:41 +02:00
versioneer.py upgrade versioneer to 0.14, makes PEP440 compliant version numbers now 2015-05-14 01:25:18 +02:00

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