Go to file
Michael Eischer 1a45f05e19
Merge pull request #4921 from MichaelEischer/restorer-bugs
restore: fix cancelation and partial updates of large files
2024-07-14 11:38:58 +02:00
.github build(deps): bump docker/build-push-action from 5 to 6 2024-07-01 01:15:18 +00:00
changelog amend restore overwrite changelog 2024-07-14 11:21:11 +02:00
cmd/restic ls: extend test sample with a second toplevel file 2024-07-13 10:22:01 +02:00
contrib bump cobra and add completions for fish 2021-05-21 13:47:52 +10:00
doc Merge pull request #4884 from MichaelEischer/lock-and-not-exist-error-codes 2024-07-12 21:05:52 +02:00
docker docker: update the base image to golang:1.22-alpine 2024-03-03 16:18:13 +05:30
helpers fix setting version in build script 2024-07-08 19:30:17 +02:00
internal restore: extend overwrite test for small files 2024-07-14 11:30:41 +02:00
.gitattributes internal/repository: Fix LoadBlob + fuzz test 2022-06-06 17:02:28 +02:00
.gitignore feat: support AWS assume role 2024-01-06 21:19:58 +01:00
.golangci.yml use consistent alias for interal/test package 2024-03-29 00:24:03 +01:00
.readthedocs.yaml doc: add HTMLZip format to .readthedocs.yaml 2023-11-02 00:16:47 +03:00
build.go bump minimum go version on Solaris to 1.20 2023-04-07 15:40:57 +02:00
CHANGELOG.md Generate CHANGELOG.md for 0.16.5 2024-07-01 21:25:33 +02:00
CONTRIBUTING.md CONTRIBUTING.md: Clarify handling of small bugfixes 2024-01-26 23:51:54 +01:00
doc.go gofmt all files 2022-08-19 19:12:26 +02:00
go.mod build(deps): bump google.golang.org/grpc from 1.64.0 to 1.64.1 2024-07-10 18:23:27 +00:00
go.sum build(deps): bump google.golang.org/grpc from 1.64.0 to 1.64.1 2024-07-10 18:23:27 +00:00
GOVERNANCE.md Document project governance 2018-05-28 22:29:06 +02:00
LICENSE Update LICENSE 2017-11-02 11:39:49 +01:00
Makefile Remove vendor from build scripts 2020-03-01 11:30:02 +01:00
README.md Minor README.md cleanups 2024-03-09 23:56:16 +01:00
VERSION helpers/prepare-release: write dev version to VERSION file 2024-07-07 14:04:09 +02:00

Documentation Build Status Go Report Card


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.


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.


You can follow the restic project on Mastodon @resticbackup or subscribe to the project blog.


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


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

Sponsored by AppsCode