Skip to content
This repository has been archived by the owner on Feb 15, 2018. It is now read-only.

Latest commit

 

History

History
89 lines (53 loc) · 5.67 KB

index.md

File metadata and controls

89 lines (53 loc) · 5.67 KB
layout redirect_to sitenav permalink title
default
anchor title
intro
Introduction
anchor title
quickstart
Quickstart
anchor title
installation
Installation
anchor title
compatibility
Compatibility
anchor title
contribute
Contribute
anchor title
contact
Contact
anchor title
talks
Talks
anchor title
license
License
/
Backups done right!

Introduction

restic is a program that does backups right. The design goals are:

  • Easy: Doing backups should be a frictionless process, otherwise you are tempted to skip it. Restic should be easy to configure and use, so that in the unlikely 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 backend to save precious backup space.

  • Free: restic is free software and licensed under the BSD 2-Clause License and actively developed on GitHub.

Quickstart

A short recorded demo of restic:

<script type="text/javascript" src="https://asciinema.org/a/anro1vq39k80ae7c46s9nj6bs.js" id="asciicast-23554" async></script>

To learn more about restic, checkout the user manual:

Installation

To install, please follow the Installation Instructions Page in the manual or download the latest native binary on the GitHub Download Page.

Compatibility

Backward compatibility for backups is important so that our users are always able to restore saved data. Therefore restic follows Semantic Versioning to clearly define which versions are compatible. The repository and data structures contained therein are considered the "Public API" in the sense of Semantic Versioning.

We guarantee backward compatibility of all repositories within one major version; as long as we do not increment the major version, data can be read and restored. We strive to be fully backward compatible to all prior versions.

Contribute and Documentation

Contributions are welcome! More information can be found in the restic contribution guidelines. A document describing the design of restic and the data structures stored on disc is contained in the design document.

Contact

If you discover a bug or find something surprising, please feel free to open a github issue. If you would like to chat about restic, there is also the IRC channel #restic on irc.freenode.net. Or just write an email :)

Important: If you discover something that you believe to be a possible critical security problem, please do not open a GitHub issue but send an email directly to [email protected]. If possible, please encrypt your email using PGP (0xD3F7A907).

Talks

The following talks will be or have been given about restic:

Blog

For more information regarding restic development, have a look at our blog. The latest posts are:

{% for post in site.posts limit:3 %}

  • {{ post.date | date_to_string }} » [ {{ post.title }} ]({{ post.url }}) {% endfor %}

License

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