2013-06-29 21:56:44 +00:00
|
|
|
.. include:: global.rst.inc
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-08-01 11:23:15 +00:00
|
|
|
Welcome to Attic
|
|
|
|
|
================
|
2013-07-08 21:38:27 +00:00
|
|
|
|project_name| is a deduplicating backup program 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|
|
2014-02-04 02:26:36 +00:00
|
|
|
suitable for daily backups since only the changes are stored.
|
2011-11-05 18:42:28 +00:00
|
|
|
|
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
|
|
|
|
2014-04-05 18:24:46 +00:00
|
|
|
$ attic init /somewhere/my-repository.attic
|
2014-04-06 20:47:22 +00:00
|
|
|
$ attic create /somewhere/my-repository.attic::Monday ~/Documents
|
|
|
|
|
$ attic create --stats /somewhere/my-repository.attic::Tuesday ~/Documents
|
|
|
|
|
Archive name: Tuesday
|
|
|
|
|
Archive fingerprint: 387a5e3f9b0e792e91ce87134b0f4bfe17677d9248cb5337f3fbf3a8e157942a
|
|
|
|
|
Start time: Tue Mar 25 12:00:10 2014
|
|
|
|
|
End time: Tue Mar 25 12:00:10 2014
|
|
|
|
|
Duration: 0.08 seconds
|
|
|
|
|
Number of files: 358
|
|
|
|
|
Original size Compressed size Deduplicated size
|
|
|
|
|
This archive: 57.16 MB 46.78 MB 151.67 kB
|
|
|
|
|
All archives: 114.02 MB 93.46 MB 44.81 MB
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-08-04 20:50:34 +00:00
|
|
|
See the :ref:`quickstart` chapter for a more detailed example.
|
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-07-08 21:38:27 +00:00
|
|
|
$ pip install attic
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2014-03-12 20:00:30 +00:00
|
|
|
|project_name| is also part of the Debian_, Ubuntu_, `Arch Linux`_ and Slackware_
|
2014-01-26 11:51:56 +00:00
|
|
|
distributions of GNU/Linux.
|
|
|
|
|
|
2013-07-31 18:51:01 +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-07-31 18:51:01 +00:00
|
|
|
foreword
|
2013-06-30 19:30:17 +00:00
|
|
|
installation
|
2013-07-31 18:51:01 +00:00
|
|
|
quickstart
|
2013-08-04 19:23:12 +00:00
|
|
|
usage
|
2013-06-29 21:56:44 +00:00
|
|
|
faq
|
2014-12-16 15:03:20 +00:00
|
|
|
internals
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2013-08-06 19:35:43 +00:00
|
|
|
Getting help
|
|
|
|
|
============
|
|
|
|
|
|
2014-02-04 02:26:36 +00:00
|
|
|
If you've found a bug or have a concrete feature request, you can add your bug
|
|
|
|
|
report or feature request directly to the project's `issue tracker`_. For more
|
|
|
|
|
general questions or discussions, a post to the mailing list is preferred.
|
2013-08-06 19:35:43 +00:00
|
|
|
|
|
|
|
|
Mailing list
|
|
|
|
|
------------
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2014-02-04 02:26:36 +00:00
|
|
|
There is a mailing list for Attic on librelist_ that you can use for feature
|
2013-08-06 19:35:43 +00:00
|
|
|
requests and general discussions about Attic. A mailing list archive is
|
|
|
|
|
available `here <http://librelist.com/browser/attic/>`_.
|
2011-11-05 18:42:28 +00:00
|
|
|
|
2014-02-04 02:26:36 +00:00
|
|
|
To subscribe to the list, send an email to attic@librelist.com and reply
|
|
|
|
|
to the confirmation mail. Likewise, to unsubscribe, send an email to
|
2013-08-06 19:35:43 +00:00
|
|
|
attic-unsubscribe@librelist.com and reply to the confirmation mail.
|
