2019-11-23 09:17:48 +00:00
|Documentation| |Build Status| |Build status| |Report Card| |Say Thanks| |Reviewed by Hound|
2017-04-17 18:53:38 +00:00
Introduction
------------
2018-11-18 11:33:52 +00:00
restic is a backup program that is fast, efficient and secure. It supports the three major operating systems (Linux, macOS, Windows) and a few smaller ones (FreeBSD, OpenBSD).
2017-04-17 18:53:38 +00:00
For detailed usage and installation instructions check out the `documentation <https://restic.readthedocs.io/en/latest> `__ .
2017-08-13 17:47:54 +00:00
You can ask questions in our `Discourse forum <https://forum.restic.net> `__ .
2017-08-11 19:38:18 +00:00
2017-04-17 18:53:38 +00:00
Quick start
-----------
2017-04-19 16:32:32 +00:00
Once you've `installed
2017-10-03 18:28:17 +00:00
<https://restic.readthedocs.io/en/latest/020_installation.html> `__ restic, start
2017-04-19 16:32:32 +00:00
off with creating a repository for your backups:
.. code-block :: console
2017-04-17 18:53:38 +00:00
$ 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.
2017-04-19 16:32:32 +00:00
and add some data:
.. code-block :: console
2017-04-17 18:53:38 +00:00
2018-05-18 17:25:56 +00:00
$ restic --repo /tmp/backup backup ~/work
2017-04-17 18:53:38 +00:00
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
2017-08-09 19:56:41 +00:00
Next you can either use `` restic restore `` to restore files or use `` restic
mount`` to mount the repository via fuse and browse the files from previous
snapshots.
2017-10-13 18:01:19 +00:00
For more options check out the `online documentation <https://restic.readthedocs.io/en/latest/> `__ .
2017-04-17 18:53:38 +00:00
2017-08-09 19:56:41 +00:00
Backends
--------
Saving a backup on the same machine is nice but not a real backup strategy.
Therefore, restic supports the following backends for storing backups natively:
2017-10-13 18:01:19 +00:00
- `Local directory <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#local> `__
- `sftp server (via SSH) <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#sftp> `__
2017-12-09 09:04:39 +00:00
- `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> `__ )
2017-10-13 18:01:19 +00:00
- `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)
- `OpenStack Swift <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#openstack-swift> `__
- `BackBlaze B2 <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#backblaze-b2> `__
- `Microsoft Azure Blob Storage <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#microsoft-azure-blob-storage> `__
- `Google Cloud Storage <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#google-cloud-storage> `__
2018-03-17 12:47:44 +00:00
- And many other services via the `rclone <https://rclone.org> `__ `Backend <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#other-services-via-rclone> `__
2017-08-09 19:56:41 +00:00
2017-04-17 18:53:38 +00:00
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.
2017-05-31 21:48:56 +00:00
Reproducible Builds
-------------------
The binaries released with each restic version starting at 0.6.1 are
2017-06-02 19:32:13 +00:00
`reproducible <https://reproducible-builds.org/> `__ , which means that you can
2017-05-31 21:48:56 +00:00
easily reproduce a byte identical version from the source code for that
release. Instructions on how to do that are contained in the
2017-06-02 20:08:04 +00:00
`builder repository <https://github.com/restic/builder> `__ .
2017-05-31 21:48:56 +00:00
2017-04-17 18:53:38 +00:00
News
----
You can follow the restic project on Twitter `@resticbackup <https://twitter.com/resticbackup> `__ or by subscribing to
2018-01-01 20:50:44 +00:00
the `development blog <https://restic.net/blog/> `__ .
2017-04-17 18:53:38 +00:00
License
-------
2017-11-02 10:36:25 +00:00
Restic is licensed under `BSD 2-Clause License <https://opensource.org/licenses/BSD-2-Clause> `__ . You can find the
2017-04-17 18:53:38 +00:00
complete text in `` LICENSE `` .
2018-07-05 19:01:57 +00:00
Sponsorship
-----------
Backend integration tests for Google Cloud Storage and Microsoft Azure Blob
2018-07-05 19:03:40 +00:00
Storage are sponsored by `AppsCode <https://appscode.com> `__ !
2018-07-05 19:01:57 +00:00
|AppsCode|
2017-04-17 18:53:38 +00:00
.. |Documentation| image :: https://readthedocs.org/projects/restic/badge/?version=latest
:target: https://restic.readthedocs.io/en/latest/?badge=latest
2018-05-08 17:13:39 +00:00
.. |Build Status| image :: https://travis-ci.com/restic/restic.svg?branch=master
:target: https://travis-ci.com/restic/restic
2017-04-17 18:53:38 +00:00
.. |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
2017-07-20 20:31:41 +00:00
.. |Report Card| image :: https://goreportcard.com/badge/github.com/restic/restic
:target: https://goreportcard.com/report/github.com/restic/restic
2017-04-21 17:32:37 +00:00
.. |Say Thanks| image :: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
:target: https://saythanks.io/to/restic
2018-07-05 19:01:57 +00:00
.. |AppsCode| image :: https://cdn.appscode.com/images/logo/appscode/ac-logo-color.png
:target: https://appscode.com
2018-07-31 20:53:24 +00:00
.. |Reviewed by Hound| image :: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg
:target: https://houndci.com
