Go to file
Alexander Neumann 54c4c29a89 Add checker and command 'check' to replace 'fsck' 2015-07-11 16:27:38 +02:00
Godeps Extract chunker 2015-07-08 16:58:23 -04:00
backend backend: Remove IDSet 2015-07-11 16:12:50 +02:00
checker Add checker and command 'check' to replace 'fsck' 2015-07-11 16:27:38 +02:00
cmd/restic Add checker and command 'check' to replace 'fsck' 2015-07-11 16:27:38 +02:00
crypto Extract chunker 2015-07-08 16:58:23 -04:00
debug Fix debug functions 2015-06-24 20:00:01 +02:00
doc doc: Add obsolete Index files 2015-07-05 11:07:10 +02:00
pack Add doc stubs to all the packages 2015-05-09 13:00:01 +02:00
pipe tests: Remove more flags 2015-06-28 13:52:22 +02:00
repository Add checker and command 'check' to replace 'fsck' 2015-07-11 16:27:38 +02:00
test Add more test helpers 2015-07-05 11:07:10 +02:00
.gitignore Add integration tests 2015-05-11 21:09:32 +02:00
.travis.yml Disable gox cross compile on darwin 2015-07-09 21:05:04 +02:00
CONTRIBUTING.md Document development environment 2015-06-24 20:29:58 +02:00
LICENSE LICENSE: Add email address 2014-09-18 21:10:30 +02:00
Makefile Makefile: Use new build system 2015-06-24 20:29:58 +02:00
README.md Note about security bugs 2015-07-07 19:43:55 -04:00
archiver.go Merge pull request #219 from restic/extract_chunker 2015-07-08 23:40:43 +02:00
archiver_int_test.go restorer: unexport archive pipe 2015-05-02 15:31:31 +02:00
archiver_test.go Extract chunker 2015-07-08 16:58:23 -04:00
build.go Support build tags for `build.go` 2015-06-24 20:29:58 +02:00
cache.go Refactor configuration of cache dir and repository 2015-06-07 18:15:03 +02:00
cache_test.go tests: Remove more flags 2015-06-28 13:52:22 +02:00
doc.go Add minimal documentatation to restic package 2015-05-09 12:52:46 +02:00
lock.go cmd/restic: Add command `unlock`, improve error message 2015-06-28 13:52:23 +02:00
lock_test.go Remove unreliable tests 2015-06-28 16:27:17 +02:00
node.go Fix restore filter 2015-07-09 20:12:31 +02:00
node_darwin.go node/Linux: Implement setting timestamps for symlinks 2015-05-14 23:06:11 +02:00
node_freebsd.go node/Linux: Implement setting timestamps for symlinks 2015-05-14 23:06:11 +02:00
node_linux.go Move error annotation for symlink timestamp restore 2015-05-16 13:25:10 +02:00
node_openbsd.go node/Linux: Implement setting timestamps for symlinks 2015-05-14 23:06:11 +02:00
node_test.go Fix darwin tests 2015-07-09 10:52:44 -04:00
progress.go Small refactorings and ceosmetic changes 2015-04-29 20:59:06 -04:00
restorer.go restorer: Initialize SelectForRestore with default 2015-07-09 20:12:31 +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 Move FindSnapshot, make Repository.List() return IDs 2015-05-17 20:58:22 +02:00
snapshot_test.go tests: Standardize use of SetupRepo/Teardown 2015-06-28 13:52:22 +02:00
tree.go Rename 'Repo' -> 'Repository' 2015-05-09 23:59:58 +02:00
tree_test.go tests: Standardize use of SetupRepo/Teardown 2015-06-28 13:52:22 +02:00
walk.go walk: Honor close of the done channel 2015-07-11 16:13:11 +02:00
walk_test.go tests: Remove more flags 2015-06-28 13:52:22 +02:00

README.md

Stories in Ready Build Status sourcegraph status Coverage Status

WARNING

WARNING: At the moment, consider restic as alpha quality software, it is not yet finished. Do not use it for real data!

Restic

Restic is a program that does backups right. The design goals are:

  • Easy: Doing backups should be a frictionless process, otherwise you are tempted to skip it. Restic should be easy to configure and use, so that in the unlikely 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 harddisk 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 backend to save precious backup space.

Building

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
  find       find a file/directory
  fsck       check the repository
  init       create repository
  key        manage keys
  list       lists data
  ls         list files
  restore    restore a snapshot
  snapshots  show snapshots
  version    display version

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 disc is contained in doc/Design.md.

Development

For development, please have a look at CONTRIBUTING.md, especially the section "Development Environment". If you have any questions, please get in touch!

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 PGP (0xD3F7A907).

Talks

The following talks have been given about restic:

License

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