Go to file
Michael Eischer 6a2b10e2a8
Merge pull request #4685 from konidev20/fix-gh-4676-sub-commands-for-key-management
Move key add, list, remove and passwd as separate sub-commands and improve key sub-command documentation
2024-02-08 19:59:16 +00:00
.github build(deps): bump actions/setup-go from 4 to 5 2024-01-01 01:33:20 +00:00
changelog key: move add, list, remove, passwd to sub-commands 2024-02-06 01:47:43 +05:30
cmd/restic key: fix integration test for invalid arguments 2024-02-08 20:52:30 +01:00
contrib bump cobra and add completions for fish 2021-05-21 13:47:52 +10:00
doc dump: minor cleanups 2024-02-05 20:10:52 +01:00
docker Remove additional `--update` for apk in Dockerfile 2023-10-01 18:00:15 +08:00
helpers Fix typos 2023-12-06 13:11:55 +01:00
internal Apply changelog entry / documentation improvements from review 2024-02-04 19:10:06 +01: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 CI: enable bodyclose linter 2024-01-19 21:17:18 +01:00
.readthedocs.yaml doc: add HTMLZip format to .readthedocs.yaml 2023-11-02 00:16:47 +03:00
CHANGELOG.md Generate CHANGELOG.md for 0.16.4 2024-02-04 19:50:34 +01:00
CONTRIBUTING.md CONTRIBUTING.md: Clarify handling of small bugfixes 2024-01-26 23:51:54 +01: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 README: add Mastodon link 2023-08-27 10:52:12 +02:00
VERSION Add version for 0.16.4 2024-02-04 19:50:52 +01:00
build.go bump minimum go version on Solaris to 1.20 2023-04-07 15:40:57 +02:00
doc.go gofmt all files 2022-08-19 19:12:26 +02:00
go.mod Upgrade zstd library to latest version 2024-02-05 19:53:02 +01:00
go.sum Upgrade zstd library to latest version 2024-02-05 19:53:02 +01:00

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 Mastodon @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