github.com/advanderveer/restic@v0.8.1-0.20171209104529-42a8c19aaea6/README.rst (about)

     1  |Documentation| |Build Status| |Build status| |Report Card| |Say Thanks| |TestCoverage|
     2  
     3  Introduction
     4  ------------
     5  
     6  restic is a backup program that is fast, efficient and secure.
     7  
     8  For detailed usage and installation instructions check out the `documentation <https://restic.readthedocs.io/en/latest>`__.
     9  
    10  You can ask questions in our `Discourse forum <https://forum.restic.net>`__.
    11  
    12  Quick start
    13  -----------
    14  
    15  Once you've `installed
    16  <https://restic.readthedocs.io/en/latest/020_installation.html>`__ restic, start
    17  off with creating a repository for your backups:
    18  
    19  .. code-block:: console
    20  
    21      $ restic init --repo /tmp/backup
    22      enter password for new backend:
    23      enter password again:
    24      created restic backend 085b3c76b9 at /tmp/backup
    25      Please note that knowledge of your password is required to access the repository.
    26      Losing your password means that your data is irrecoverably lost.
    27  
    28  and add some data:
    29  
    30  .. code-block:: console
    31  
    32      $ restic -r /tmp/backup backup ~/work
    33      enter password for repository:
    34      scan [/home/user/work]
    35      scanned 764 directories, 1816 files in 0:00
    36      [0:29] 100.00%  54.732 MiB/s  1.582 GiB / 1.582 GiB  2580 / 2580 items  0 errors  ETA 0:00
    37      duration: 0:29, 54.47MiB/s
    38      snapshot 40dc1520 saved
    39  
    40  Next you can either use ``restic restore`` to restore files or use ``restic
    41  mount`` to mount the repository via fuse and browse the files from previous
    42  snapshots.
    43  
    44  For more options check out the `online documentation <https://restic.readthedocs.io/en/latest/>`__.
    45  
    46  Backends
    47  --------
    48  
    49  Saving a backup on the same machine is nice but not a real backup strategy.
    50  Therefore, restic supports the following backends for storing backups natively:
    51  
    52  - `Local directory <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#local>`__
    53  - `sftp server (via SSH) <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#sftp>`__
    54  - `HTTP REST server <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server>`__ (`protocol <doc/100_references.rst#rest-backend>`__ `rest-server <https://github.com/restic/rest-server>`__)
    55  - `AWS S3 <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#amazon-s3>`__ (either from Amazon or using the `Minio <https://minio.io>`__ server)
    56  - `OpenStack Swift <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#openstack-swift>`__
    57  - `BackBlaze B2 <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#backblaze-b2>`__
    58  - `Microsoft Azure Blob Storage <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#microsoft-azure-blob-storage>`__
    59  - `Google Cloud Storage <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#google-cloud-storage>`__
    60  
    61  Design Principles
    62  -----------------
    63  
    64  Restic is a program that does backups right and was designed with the
    65  following principles in mind:
    66  
    67  -  **Easy:** Doing backups should be a frictionless process, otherwise
    68     you might be tempted to skip it. Restic should be easy to configure
    69     and use, so that, in the event of a data loss, you can just restore
    70     it. Likewise, restoring data should not be complicated.
    71  
    72  -  **Fast**: Backing up your data with restic should only be limited by
    73     your network or hard disk bandwidth so that you can backup your files
    74     every day. Nobody does backups if it takes too much time. Restoring
    75     backups should only transfer data that is needed for the files that
    76     are to be restored, so that this process is also fast.
    77  
    78  -  **Verifiable**: Much more important than backup is restore, so restic
    79     enables you to easily verify that all data can be restored.
    80  
    81  -  **Secure**: Restic uses cryptography to guarantee confidentiality and
    82     integrity of your data. The location the backup data is stored is
    83     assumed not to be a trusted environment (e.g. a shared space where
    84     others like system administrators are able to access your backups).
    85     Restic is built to secure your data against such attackers.
    86  
    87  -  **Efficient**: With the growth of data, additional snapshots should
    88     only take the storage of the actual increment. Even more, duplicate
    89     data should be de-duplicated before it is actually written to the
    90     storage back end to save precious backup space.
    91  
    92  Reproducible Builds
    93  -------------------
    94  
    95  The binaries released with each restic version starting at 0.6.1 are
    96  `reproducible <https://reproducible-builds.org/>`__, which means that you can
    97  easily reproduce a byte identical version from the source code for that
    98  release. Instructions on how to do that are contained in the
    99  `builder repository <https://github.com/restic/builder>`__.
   100  
   101  News
   102  ----
   103  
   104  You can follow the restic project on Twitter `@resticbackup <https://twitter.com/resticbackup>`__ or by subscribing to
   105  the `development blog <https://restic.github.io/blog/>`__.
   106  
   107  License
   108  -------
   109  
   110  Restic is licensed under `BSD 2-Clause License <https://opensource.org/licenses/BSD-2-Clause>`__. You can find the
   111  complete text in ``LICENSE``.
   112  
   113  .. |Documentation| image:: https://readthedocs.org/projects/restic/badge/?version=latest
   114     :target: https://restic.readthedocs.io/en/latest/?badge=latest
   115  .. |Build Status| image:: https://travis-ci.org/restic/restic.svg?branch=master
   116     :target: https://travis-ci.org/restic/restic
   117  .. |Build status| image:: https://ci.appveyor.com/api/projects/status/nuy4lfbgfbytw92q/branch/master?svg=true
   118     :target: https://ci.appveyor.com/project/fd0/restic/branch/master
   119  .. |Report Card| image:: https://goreportcard.com/badge/github.com/restic/restic
   120     :target: https://goreportcard.com/report/github.com/restic/restic
   121  .. |Say Thanks| image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
   122     :target: https://saythanks.io/to/restic
   123  .. |TestCoverage| image:: https://codecov.io/gh/restic/restic/branch/master/graph/badge.svg
   124     :target: https://codecov.io/gh/restic/restic