Go to file
Florian Weingarten bace4607bf Fix ModTime for directories 2015-05-13 23:11:31 -04:00
Godeps vendor everything 2015-05-10 22:46:32 +02:00
backend Add minimal documentation for backend/{local,sftp} 2015-05-09 12:54:45 +02:00
chunker chunker: Further cleanup 2015-05-05 00:56:07 +02:00
cmd Fix ModTime for directories 2015-05-13 23:11:31 -04:00
crypto Add doc stubs to all the packages 2015-05-09 13:00:01 +02:00
debug Add doc stubs to all the packages 2015-05-09 13:00:01 +02:00
doc doc: Clarify storage ID 2015-05-04 20:39:07 +02:00
pack Add doc stubs to all the packages 2015-05-09 13:00:01 +02:00
pipe Add doc stubs to all the packages 2015-05-09 13:00:01 +02:00
repository Rename 'Repo' -> 'Repository' 2015-05-09 23:59:58 +02:00
test Rename 'Repo' -> 'Repository' 2015-05-09 23:59:58 +02:00
testsuite test: shorten 'ls' test output 2015-05-06 23:43:36 +02:00
.gitignore Add integration tests 2015-05-11 21:09:32 +02:00
.travis.yml travis/Makefile: output debug information 2015-05-11 22:18:28 +02:00
CONTRIBUTING.md Correct typos found by @fw42 2015-05-09 17:20:18 +02:00
LICENSE LICENSE: Add email address 2014-09-18 21:10:30 +02:00
Makefile travis/Makefile: output debug information 2015-05-11 22:18:28 +02:00
README.md README: Fix indent 2015-05-12 21:36:54 +02:00
archiver.go Rename 'Repo' -> 'Repository' 2015-05-09 23:59:58 +02:00
archiver_int_test.go restorer: unexport archive pipe 2015-05-02 15:31:31 +02:00
archiver_test.go Rename variables 2015-05-09 13:47:21 +02:00
cache.go Rename 'Repo' -> 'Repository' 2015-05-09 23:59:58 +02:00
cache_test.go Rename variables 2015-05-09 13:47:21 +02:00
coverage_all.sh Makefile: Split out coverage into a shell script 2015-05-10 23:04:02 +02:00
doc.go Add minimal documentatation to restic package 2015-05-09 12:52:46 +02:00
node.go Fix ModTime for directories 2015-05-13 23:11:31 -04:00
node_darwin.go node: Move unix-specific functions back to node.go 2015-05-05 21:34:12 +02:00
node_freebsd.go Call open file once on FreeBSD. 2015-05-05 20:47:02 -05:00
node_linux.go node: Move unix-specific functions back to node.go 2015-05-05 21:34:12 +02:00
node_openbsd.go node: Move unix-specific functions back to node.go 2015-05-05 21:34:12 +02:00
node_test.go Add benchmark for NodeFromFileInfo 2015-05-02 00:26:32 +02:00
progress.go Small refactorings and ceosmetic changes 2015-04-29 20:59:06 -04:00
restorer.go Fix ModTime for directories 2015-05-13 23:11:31 -04:00
snapshot.go Rename 'Repo' -> 'Repository' 2015-05-09 23:59:58 +02:00
snapshot_test.go Rename variables 2015-05-09 13:47:21 +02:00
testsuite.sh Add integration tests 2015-05-11 21:09:32 +02:00
tree.go Rename 'Repo' -> 'Repository' 2015-05-09 23:59:58 +02:00
tree_test.go Rename variables 2015-05-09 13:47:21 +02:00
walk.go Rename 'Repo' -> 'Repository' 2015-05-09 23:59:58 +02:00
walk_test.go Rename variables 2015-05-09 13:47:21 +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 make, afterwards you'll find the binary in the current directory:

$ make
[...]

$ ./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.

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 :)

License

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