Minor docs tweaks

This commit is contained in:
Jonas Borgström 2013-07-03 22:38:07 +02:00
parent f3295cf3e8
commit 6052a1ed74
5 changed files with 44 additions and 39 deletions

View file

@ -7,8 +7,8 @@ Definitions
.. _deduplication_def:
Deduplication
Deduplication is a technique for improving storage utilization by eliminating
redundant data.
Deduplication is a technique for improving storage utilization by
eliminating redundant data.
.. _archive_def:
@ -21,11 +21,11 @@ Archive
.. _repository_def:
Repository
A repository is a filesystem directory storing data from zero or more archives.
The data in a repository is both deduplicated and encrypted making it both
efficient and safe.
A repository is a filesystem directory storing data from zero or more
archives. The data in a repository is both deduplicated and encrypted
making it both efficient and safe.
Key file
When a repository is initialized a key file containing a password protected
encryption key is created. It is vital to keep this file safe since the repository
data is totally inaccessible without it.
When a repository is initialized a key file containing a password
protected encryption key is created. It is vital to keep this file safe
since the repository data is totally inaccessible without it.

View file

@ -12,8 +12,8 @@ Currently Linux and MacOS X are supported.
Can I backup VM disk images?
----------------------------
Yes, the :ref:`deduplication <deduplication_def>` technique used by darc
will make sure only the modified parts of the file is stored.
Yes, the :ref:`deduplication <deduplication_def>` technique used by darc will
make sure only the modified parts of the file is stored.
Which file attributes are preserved?
------------------------------------

View file

@ -4,10 +4,12 @@
General Usage
=============
The following examples showcases how to use |project_name| to backup some important files from a users home directory.
The following examples showcases how to use |project_name| to backup some
important files from a users home directory.
Initialize a local :ref:`repository <repository_def>` to store backup :ref:`archives <archive_def>` in
(See :ref:`encrypted_repos` and :ref:`remote_repos` for more details)::
Initialize a local :ref:`repository <repository_def>` to store backup
:ref:`archives <archive_def>` in (See :ref:`encrypted_repos` and
:ref:`remote_repos` for more details)::
$ darc init /somewhere/my-backup.darc
@ -15,9 +17,10 @@ Create an archive containing the ``~/src`` and ``~/Documents`` directories::
$ darc create -v /somwhere/my-backup.darc::first-backup ~/src ~/Documents
Create another archive the next day. This backup will be a lot quicker since only new data is stored.
The ``--stats`` option tells |project_name| to print statistics about the newly created archive such as
the amount of unique data (not shared with other archives)::
Create another archive the next day. This backup will be a lot quicker since
only new data is stored. The ``--stats`` option tells |project_name| to print
statistics about the newly created archive such as the amount of unique data
(not shared with other archives)::
$ darc create -v --stats /somwhere/my-backup.darc::second-backup ~/src ~/Documents
@ -37,8 +40,8 @@ Recover disk space by manually deleting the *first-backup* archive::
$ darc delete /somwhere/my-backup.darc::first-backup
Use the ``prune`` subcommand to delete all archives except a given number of *daily*, *weekly*,
*monthly* and *yearly* archives::
Use the ``prune`` subcommand to delete all archives except a given number of
*daily*, *weekly*, *monthly* and *yearly* archives::
$ darc prune /somwhere/my-backup.darc --daily=7 --weekly=2 --monthly=6
@ -52,9 +55,8 @@ Repository encryption is enabled at repository encryption time::
$ darc init --passphrase | --key-file
When repository encryption is enabled all data is encrypted using 256-bit
AES_ encryption and the integrity and authenticity is verified using
`HMAC-SHA256`_.
When repository encryption is enabled all data is encrypted using 256-bit AES_
encryption and the integrity and authenticity is verified using `HMAC-SHA256`_.
|project_name| supports two different methods to derive the AES and HMAC keys.
@ -64,9 +66,8 @@ Passphrase based encryption
secure as long as a *strong* passphrase is used.
Key file based encryption
This method generates random keys at repository initialization time
that are stored in a password protected file in the ``~/.darc/keys/``
directory.
This method generates random keys at repository initialization time that
are stored in a password protected file in the ``~/.darc/keys/`` directory.
This method is secure and suitable for automated backups.
.. Note::
@ -79,8 +80,8 @@ Key file based encryption
Remote repositories
-------------------
|project_name| can initialize and access repositories on remote hosts as the host
is accessible using SSH and |project_name| is installed.
|project_name| can initialize and access repositories on remote hosts as the
host is accessible using SSH and |project_name| is installed.
The following syntax is used to address remote repositories::

View file

@ -3,28 +3,30 @@
Darc
====
|project_name| is a Deduplicating ARChiver written in Python.
The main goal of darc is to provide an efficient and secure way to backup data.
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.
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.
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
|project_name| can store data on any remote host accessible over SSH as long as
|project_name| is installed.
|project_name| can store data on any remote host accessible over SSH as
long as |project_name| is installed.
Easy to use
-----------
Initialize a new backup :ref:`repository <repository_def>` and create your first
backup :ref:`archive <archive_def>` in two lines::
Initialize a new backup :ref:`repository <repository_def>` and create your
first backup :ref:`archive <archive_def>` in two lines::
$ darc init /usbdrive/my-backup.darc
$ darc create -v /usbdrive/my-backup.darc::documents ~/Documents
@ -54,6 +56,8 @@ Contribute
==========
Found a bug? Have any ideas to improve |project_name|?
Head over to |project_name|'s github_ page and create an issue or a pull request.
Head over to |project_name|'s github_ page and create an issue or a pull
request.
You can also ask the author a question directly by `email <mailto:jonas@borgstrom.se>`_.
You can also ask the author a question directly by
`email <mailto:jonas@borgstrom.se>`_.

View file

@ -4,8 +4,8 @@
Installation
=============
|project_name| requires Python_ 3.2 or above to work. Even though Python 3
is not the default Python version on most Linux distributions it is usually
|project_name| requires Python_ 3.2 or above to work. Even though Python 3 is
not the default Python version on most Linux distributions it is usually
available as an optional install.
Other dependencies: