2013-06-29 21:56:44 +00:00
|
|
|
.. include:: global.rst.inc
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
Darc
|
|
|
|
|
====
|
|
|
|
|
|project_name| is a Deduplicating ARChiver written in Python.
|
2013-07-03 20:38:07 +00:00
|
|
|
The main goal of |project_name| is to provide an efficient and secure way
|
|
|
|
|
to backup data. The data deduplication technique used makes |project_name|
|
|
|
|
|
suitable for taking daily backups.
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
Main Features
|
|
|
|
|
-------------
|
2011-11-05 18:42:28 +00:00
|
|
|
Space efficient storage
|
2013-07-03 20:38:07 +00:00
|
|
|
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.
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
Optional data encryption
|
|
|
|
|
All data can be protected using 256-bit AES_ encryption and data integrity
|
|
|
|
|
and authenticity is verified using `HMAC-SHA256`_.
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
Off-site backups
|
2013-07-03 20:38:07 +00:00
|
|
|
|project_name| can store data on any remote host accessible over SSH as
|
|
|
|
|
long as |project_name| is installed.
|
2011-11-06 15:59:14 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
Easy to use
|
2011-11-05 18:42:28 +00:00
|
|
|
-----------
|
2013-07-03 20:38:07 +00:00
|
|
|
Initialize a new backup :ref:`repository <repository_def>` and create your
|
|
|
|
|
first backup :ref:`archive <archive_def>` in two lines::
|
2011-11-06 15:59:14 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
$ darc init /usbdrive/my-backup.darc
|
|
|
|
|
$ darc create -v /usbdrive/my-backup.darc::documents ~/Documents
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
See the :ref:`generalusage` section for more detailed examples.
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
Easy installation
|
2011-11-06 15:59:14 +00:00
|
|
|
-----------------
|
2013-06-29 21:56:44 +00:00
|
|
|
You can use pip to install |project_name| quickly and easily::
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
$ pip install darc
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-30 19:30:17 +00:00
|
|
|
Need more help with installing? See :ref:`installation`
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
User's Guide
|
|
|
|
|
============
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-30 19:30:17 +00:00
|
|
|
installation
|
2013-06-29 21:56:44 +00:00
|
|
|
generalusage
|
|
|
|
|
faq
|
|
|
|
|
definitions
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
Contribute
|
|
|
|
|
==========
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-06-29 21:56:44 +00:00
|
|
|
Found a bug? Have any ideas to improve |project_name|?
|
2013-07-03 20:38:07 +00:00
|
|
|
Head over to |project_name|'s github_ page and create an issue or a pull
|
|
|
|
|
request.
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-07-03 20:38:07 +00:00
|
|
|
You can also ask the author a question directly by
|
|
|
|
|
`email <mailto:jonas@borgstrom.se>`_.
|
