Skip to content
Fast, secure, efficient backup program
Branch: master
Clone or download
Latest commit 870e758 Mar 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
changelog Merge pull request 2156 from kayrus/swift-app-cred Mar 16, 2019
cmd/restic
contrib
doc Merge pull request 2156 from kayrus/swift-app-cred Mar 16, 2019
docker Add ssh binary to docker image to allow sftp repository Oct 14, 2018
helpers release: Pull latest alpine image Jan 6, 2019
internal Fix build on FreeBSD for Go < 1.12 Mar 16, 2019
vendor Update dependencies Mar 17, 2019
.gitignore Document the build and release processes Oct 13, 2018
.hound.yml Move top-level files Feb 20, 2016
.travis.yml
CHANGELOG.md
CONTRIBUTING.md Rename OS X to macOS in the documentation Sep 23, 2018
GOVERNANCE.md
LICENSE Update LICENSE Nov 2, 2017
Makefile
README.rst Add hint which OS are supported Nov 18, 2018
VERSION
appveyor.yml
build.go
doc.go Add minimal docs for the top-level package Oct 3, 2018
go.mod
go.sum Update dependencies Mar 17, 2019
run_integration_tests.go

README.rst

Documentation Build Status Build status Report Card Say Thanks TestCoverage Reviewed by Hound

Introduction

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).

For detailed usage and installation instructions check out the documentation.

You can ask questions in our Discourse forum.

Quick start

Once you've installed restic, start off with creating a repository for your backups:

$ 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:

$ restic --repo /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

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.

For more options check out the online documentation.

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:

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.

Reproducible Builds

The binaries released with each restic version starting at 0.6.1 are reproducible, which means that you can easily reproduce a byte identical version from the source code for that release. Instructions on how to do that are contained in the builder repository.

News

You can follow the restic project on Twitter @resticbackup or by subscribing to the development blog.

License

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

Sponsorship

Backend integration tests for Google Cloud Storage and Microsoft Azure Blob Storage are sponsored by AppsCode!

AppsCode

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.