Go to file
Alexander Neumann 772f647a73 Add VERSION file for 0.6.0-rc.1 2017-05-25 15:27:45 +02:00
.github Improve issue template wording 2017-05-21 10:09:49 +02:00
doc design: Add s3.layout option 2017-05-15 23:37:16 +02:00
src Merge pull request #966 from restic/unify-repo-layout 2017-05-22 21:15:38 +02:00
vendor Update github.com/minio/minio-go 2017-05-15 20:47:50 +02:00
.envrc Add hints how to use the `go` tool and direnv 2016-10-17 13:09:56 +02:00
.gitignore Documentation: Refactor and switch to Sphinx 2017-04-17 20:53:38 +02:00
.hound.yml Enable HoundCI checking for Go 2016-02-05 21:15:46 +01:00
.travis.yml Update Go versions 2017-04-15 10:58:43 +02:00
CHANGELOG.md Update CHANGELOG.md 2017-05-25 15:26:22 +02:00
CONTRIBUTING.md Add CHANGELOG.md and instructions for contributors 2017-03-09 10:40:24 +01:00
Dockerfile Update Dockerfile 2017-02-10 17:25:48 +01:00
LICENSE LICENSE: Add email address 2014-09-18 21:10:30 +02:00
Makefile Fix Makefile 2016-03-31 19:20:57 +02:00
README.rst Fix link in README.rst 2017-05-08 21:31:11 +02:00
VERSION Add VERSION file for 0.6.0-rc.1 2017-05-25 15:27:45 +02:00
Vagrantfile Enable the use of `context` in restic 2017-03-08 20:12:16 +01:00
appveyor.yml Update Go versions 2017-04-15 10:58:43 +02:00
build.go build.go: Add --enable-cgo 2017-05-25 11:03:29 +02:00
build_release_binaries.sh Also include the source in SHA256SUMS 2017-03-09 10:19:45 +01:00
codecov.yml Add codecov.yml 2017-05-16 20:52:42 +02:00
run_integration_tests.go Allow skipping the test against s3 2017-05-14 00:33:19 +02:00

README.rst

|Documentation| |Build Status| |Build status| |Report Card| |Say Thanks|

Introduction
------------

restic is a backup program that is fast, efficient and secure.

For detailed usage and installation instructions check out the `documentation <https://restic.readthedocs.io/en/latest>`__.

Quick start
-----------

Once you've `installed
<https://restic.readthedocs.io/en/latest/installation.html>`__ restic, start
off with creating a repository for your backups:

.. code-block:: console

    $ restic init --repo /tmp/backup
    enter password for new backend:
    enter password again:
    created restic backend 085b3c76b9 at /tmp/backup
    Please note that knowledge of your password is required to access the repository.
    Losing your password means that your data is irrecoverably lost.

and add some data:

.. code-block:: console

    $ restic -r /tmp/backup backup ~/work
    enter password for repository:
    scan [/home/user/work]
    scanned 764 directories, 1816 files in 0:00
    [0:29] 100.00%  54.732 MiB/s  1.582 GiB / 1.582 GiB  2580 / 2580 items  0 errors  ETA 0:00
    duration: 0:29, 54.47MiB/s
    snapshot 40dc1520 saved

For more options check out the `manual guide <https://restic.readthedocs.io/en/latest/manual.html>`__.

Design Principles
-----------------

Restic is a program that does backups right and was designed with the
following principles in mind:

-  **Easy:** Doing backups should be a frictionless process, otherwise
   you might be tempted to skip it. Restic should be easy to configure
   and use, so that, in the event of a data loss, you can just restore
   it. Likewise, restoring data should not be complicated.

-  **Fast**: Backing up your data with restic should only be limited by
   your network or hard disk bandwidth so that you can backup your files
   every day. Nobody does backups if it takes too much time. Restoring
   backups should only transfer data that is needed for the files that
   are to be restored, so that this process is also fast.

-  **Verifiable**: Much more important than backup is restore, so restic
   enables you to easily verify that all data can be restored.

-  **Secure**: Restic uses cryptography to guarantee confidentiality and
   integrity of your data. The location the backup data is stored is
   assumed not to be a trusted environment (e.g. a shared space where
   others like system administrators are able to access your backups).
   Restic is built to secure your data against such attackers.

-  **Efficient**: With the growth of data, additional snapshots should
   only take the storage of the actual increment. Even more, duplicate
   data should be de-duplicated before it is actually written to the
   storage back end to save precious backup space.

News
----

You can follow the restic project on Twitter `@resticbackup <https://twitter.com/resticbackup>`__ or by subscribing to
the `development blog <https://restic.github.io/blog/>`__.

License
-------

Restic is licensed under "BSD 2-Clause License". You can find the
complete text in ``LICENSE``.

.. |Documentation| image:: https://readthedocs.org/projects/restic/badge/?version=latest
   :target: https://restic.readthedocs.io/en/latest/?badge=latest
.. |Build Status| image:: https://travis-ci.org/restic/restic.svg?branch=master
   :target: https://travis-ci.org/restic/restic
.. |Build status| image:: https://ci.appveyor.com/api/projects/status/nuy4lfbgfbytw92q/branch/master?svg=true
   :target: https://ci.appveyor.com/project/fd0/restic/branch/master
.. |Report Card| image:: http://goreportcard.com/badge/github.com/restic/restic
   :target: http://goreportcard.com/report/github.com/restic/restic
.. |Say Thanks| image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
   :target: https://saythanks.io/to/restic