You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Alexander Neumann 1d7e7fcd6b
Merge pull request #4049 from MichaelEischer/fix-rewrite-docs
4 hours ago
.github CI: remove option to configure command used to install go tools 1 day ago
changelog rest: remove workaround for content-length handling bug 1 day ago
cmd/restic remove no longer necessary conditional compiles 1 day ago
contrib bump cobra and add completions for fish 2 years ago
doc doc: design.rst: Fix highlighting for index snippet 1 day ago
docker docker: Increase Go version to 1.19 4 weeks ago
helpers Add powershell completion 3 months ago
internal bloblru: Upgrade to hashicorp/golang-lru/v2 1 day ago
.dockerignore Multistage Docker build 1 year ago
.gitattributes internal/repository: Fix LoadBlob + fuzz test 6 months ago
.gitignore
.golangci.yml CI: ignore warning about missing package comment 2 months ago
CHANGELOG.md Generate CHANGELOG.md for 0.14.0 3 months ago
CONTRIBUTING.md update the minimum required go version to 1.18 1 day ago
GOVERNANCE.md
LICENSE
Makefile
README.md Use S3's proper product name, Amazon S3 1 year ago
VERSION Add version for 0.14.0 3 months ago
build.go update the minimum required go version to 1.18 1 day ago
doc.go gofmt all files 3 months ago
go.mod bloblru: Upgrade to hashicorp/golang-lru/v2 1 day ago
go.sum bloblru: Upgrade to hashicorp/golang-lru/v2 1 day ago

README.md

Documentation Build Status Go Report Card

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 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 project 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!

Sponsored by AppsCode