Fast, secure, efficient backup program
Find a file
Alexander Neumann 19a713970f Merge pull request #344 from restic/fix-338
pipe: propagate errors properly
2015-11-08 17:58:55 +01:00
backend Simplify Implementation of Join 2015-11-03 18:48:51 +01:00
checker Let the checker return a list of hints along with errors 2015-10-25 16:26:50 +01:00
cmd/restic Add integration test for error on readdirnames 2015-11-06 23:19:56 +01:00
crypto crypto tests: remove dependency on /dev/urandom 2015-08-18 21:40:40 +02:00
debug debug: log timing 2015-10-27 20:51:55 +01:00
doc Update index format 2015-10-12 20:53:07 +02:00
filter Allow filter patterns/paths to be both '/' and os.PathSeparator 2015-08-17 11:48:24 +02:00
fuse add build constraints for windows 2015-08-18 21:40:40 +02:00
Godeps Update chunker version 2015-09-12 22:14:58 +02:00
pack Fix Unpacker test 2015-10-25 18:21:48 +01:00
pipe pipe: make test platform-independent 2015-11-06 22:38:34 +01:00
repository Refactor Index.Lookup() to return struct PackedBlob 2015-10-31 14:47:42 +01:00
test tests: use internal bzip2/gzip implementation 2015-08-19 21:00:17 +02:00
testdata Add benchmark for WalkTree with high-latency repo 2015-10-27 20:51:55 +01:00
.gitignore Add Vagrantfile 2015-07-18 23:25:30 +02:00
.travis.yml Update Go 1.4 to version 1.4.3 2015-09-27 17:22:12 +02:00
appveyor.yml appveyor: remove old Go installation 2015-09-27 18:34:11 +02:00
archiver.go archiver: ignore dir nodes with errors 2015-11-07 11:42:28 +01:00
archiver_int_test.go restorer: unexport archive pipe 2015-05-02 15:31:31 +02:00
archiver_test.go Add and use MasterIndex 2015-10-12 22:34:12 +02:00
build.go Merge pull request #281 from restic/version-with-git 2015-08-26 20:53:24 +02:00
cache.go windows: fix nil pointer reference 2015-08-19 20:23:52 +02:00
cache_test.go tests: Remove more flags 2015-06-28 13:52:22 +02:00
CONTRIBUTING.md Add note on determinism 2015-11-05 23:10:35 +01:00
doc.go Add minimal documentatation to restic package 2015-05-09 12:52:46 +02:00
LICENSE LICENSE: Add email address 2014-09-18 21:10:30 +02:00
lock.go lock: fix merge error, use processExists() 2015-08-19 21:14:15 +02:00
lock_test.go lock_test: correct merge error, use offset 500k 2015-08-19 20:25:59 +02:00
lock_unix.go Split out process check as separate function. 2015-08-16 15:30:36 +02:00
lock_windows.go Split out process check as separate function. 2015-08-16 15:30:36 +02:00
Makefile clean up Makefile 2015-08-20 19:05:19 +02:00
node.go pipe: propagate errors properly 2015-11-06 19:41:57 +01:00
node_darwin.go Add Windows node support. 2015-08-14 15:57:47 +02:00
node_freebsd.go Add Windows node support. 2015-08-14 15:57:47 +02:00
node_linux.go Add Windows node support. 2015-08-14 15:57:47 +02:00
node_openbsd.go Add Windows node support. 2015-08-14 15:57:47 +02:00
node_test.go Remove tempfiles after test 2015-10-31 14:53:03 +01:00
node_unix.go Remove empty lines. 2015-08-16 13:21:00 +02:00
node_windows.go Don't panic on mknod on Windows 2015-08-16 13:24:21 +02:00
progress.go Update progress status when necessary 2015-08-18 12:57:05 +02:00
README.md Show full GPG fingerprint in README 2015-10-29 21:51:21 +01:00
restorer.go Make check for non-existing paths OS independent. 2015-08-17 11:01:24 +02:00
run_integration_tests.go Install the 'cover' tool 2015-09-27 17:58:13 +02:00
run_tests.go run_tests: Exit with error if failed tests were found 2015-06-28 13:52:22 +02:00
snapshot.go Create uid/gid convertion function. 2015-08-16 13:16:02 +02:00
snapshot_test.go tests: Standardize use of SetupRepo/Teardown 2015-06-28 13:52:22 +02:00
tree.go make repo for tree walker mockable 2015-10-27 20:51:55 +01:00
tree_test.go test helpers: add RemoveAll and ResetReadOnly 2015-08-18 21:40:40 +02:00
Vagrantfile Vagrantfile: Disable default rsync on /vagrant 2015-08-18 21:40:39 +02:00
VERSION add VERSION file for 0.1.0 2015-08-21 22:20:57 +02:00
walk.go load trees in parallel 2015-10-27 22:44:10 +01:00
walk_test.go Fix walk tree test for windows 2015-10-28 22:02:37 +01:00

Stories in Ready Build Status Build status sourcegraph status Coverage Status

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

Build restic

Install Go/Golang (at least version 1.3), then run go run build.go, afterwards you'll find the binary in the current directory:

$ go run build.go

$ ./restic --help
Usage:
  restic [OPTIONS] <command>

Application Options:
  -r, --repo= Repository directory to backup to/restore from

Help Options:
  -h, --help  Show this help message

Available commands:
  backup     save file/directory
  cache      manage cache
  cat        dump something
  check      check the repository
  find       find a file/directory
  init       create repository
  key        manage keys
  list       lists data
  ls         list files
  restore    restore a snapshot
  snapshots  show snapshots
  unlock     remove locks
  version    display version

A short demo recording can be found here: asciicast

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 CONTRIBUTING.md. A document describing the design of restic and the data structures stored on the back end is contained in doc/Design.md. The development environment is described in CONTRIBUTING.md.

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 me 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 alexander@bumpern.de. If possible, please encrypt your email using the following PGP key (0x91A6868BD3F7A907):

pub   4096R/91A6868BD3F7A907 2014-11-01
      Key fingerprint = CF8F 18F2 8445 7597 3F79  D4E1 91A6 868B D3F7 A907
      uid                          Alexander Neumann <alexander@bumpern.de>
      uid                          Alexander Neumann <alexander@debian.org>
      sub   4096R/D5FC2ACF4043FDF1 2014-11-01

Talks

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

License

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