borg/README.rst

57 lines
1.8 KiB
ReStructuredText
Raw Normal View History

2013-07-03 20:38:17 +00:00
What is darc?
2013-07-05 10:32:56 +00:00
-------------
2013-07-03 20:38:17 +00:00
Darc is a Deduplicating ARChiver written in Python. The main goal of darc is
to provide an efficient and secure way to backup data. The data deduplication
2013-07-05 10:32:56 +00:00
technique used makes darc suitable for daily backups since only actual changes
are stored.
Easy to use
~~~~~~~~~~~
Initialze backup repository and create a backup archive::
$ darc init /usbdrive/my-backup.darc
$ darc create -v /usbdrive/my-backup.darc::documents ~/Documents
2013-07-03 20:38:17 +00:00
Main features
2013-07-05 10:32:56 +00:00
~~~~~~~~~~~~~
2013-07-03 20:38:17 +00:00
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
darc can store data on any remote host accessible over SSH as long as
darc is installed.
What do I need?
2013-07-05 10:32:56 +00:00
---------------
2013-07-03 20:38:17 +00:00
Darc requires Python 3.2 or above to work. Besides Python darc also requires
msgpack-python and sufficiently recent OpenSSL (>= 1.0.0).
2013-07-03 20:38:17 +00:00
How do I install it?
2013-07-05 10:32:56 +00:00
--------------------
2013-07-03 20:38:17 +00:00
::
$ python setup.py install
2013-07-03 20:38:17 +00:00
Where are the docs?
2013-07-05 10:32:56 +00:00
-------------------
Go to https://pythonhosted.org/darc/ for a prebuilt version of the docs. You
2013-07-03 20:38:17 +00:00
can also build them yourself form the docs folder.
2013-07-03 20:38:17 +00:00
Where are the tests?
2013-07-05 10:32:56 +00:00
--------------------
2013-07-03 20:38:17 +00:00
The tests are in the darc/testsuite package. To run the test suite use the
following command::
2011-11-06 16:28:32 +00:00
2013-07-03 20:38:17 +00:00
$ python -m darc.testsuite.run
2011-11-06 16:28:32 +00:00
2013-07-03 20:38:17 +00:00
Where can I get help?
2013-07-05 10:32:56 +00:00
---------------------
Send questions, comments, patches, etc. to jonas@borgstrom.se. Issues and
pull requests can also be created on https://github.com/jborg/darc