Go to file
Alexander Neumann 78727c17a3 Update documentation to reflect changed crypto 2015-03-22 19:18:09 +01:00
backend Fix file mode for data blobs 2015-03-14 20:19:52 +01:00
chunker Slightly improve performance for chunker 2015-02-13 20:03:40 +01:00
cmd Correct string for catting data blobs 2015-03-22 15:42:46 +01:00
debug DebugIf: only test function when tag is enabled 2015-03-15 14:19:37 +01:00
doc Update documentation to reflect changed crypto 2015-03-22 19:18:09 +01:00
pipe Report errors, ignore files and continue. Closes #108 2015-03-15 15:48:05 +01:00
testsuite Bugfix: Backup changed data in incremental mode 2015-03-22 15:09:54 +01:00
.travis.yml Fix YAML config (again) 2015-03-22 13:26:41 +01:00
LICENSE LICENSE: Add email address 2014-09-18 21:10:30 +02:00
Makefile Refactor testsuite 2015-01-17 16:32:24 +01:00
README.md Add "Golang" keyword to README 2015-03-15 16:13:03 +01:00
archiver.go Refactor cache refresh for blobs, add progress 2015-03-22 15:09:50 +01:00
archiver_int_test.go Fix comparison for new files with '.' 2015-03-10 14:17:50 +01:00
archiver_test.go Fix counting for tests for Preload 2015-03-10 15:58:23 +01:00
blob.go Implement streaming chunker using io.Reader 2015-02-09 00:28:54 +01:00
cache.go Remove cache entries for non-existing snapshots 2015-03-22 16:09:35 +01:00
cache_darwin.go Fix darwin support 2015-03-08 14:32:49 +01:00
cache_linux.go Add local cache 2015-03-02 10:04:01 +01:00
cache_test.go Refactor cache refresh for blobs, add progress 2015-03-22 15:09:50 +01:00
crypto.go Refactor JSON data structure for master keys 2015-03-22 19:09:30 +01:00
crypto_int_test.go Refactor JSON data structure for master keys 2015-03-22 19:09:30 +01:00
crypto_test.go Fix benchmark for EncryptWriter 2015-03-14 22:42:30 +01:00
generic_test.go Rename khepri -> restic 2014-12-05 21:45:49 +01:00
key.go Refactor JSON data structure for master keys 2015-03-22 19:09:30 +01:00
key_test.go Refactor crypto layer, switch HMAC for Poyl1305-AES 2015-03-14 20:00:41 +01:00
map.go Recreate blob cache if missing (closes #104) 2015-03-14 18:15:47 +01:00
map_test.go Refactor repository structure 2015-01-14 16:34:30 +01:00
node.go Refactor backup pipeline 2015-03-08 14:16:01 +01:00
node_darwin.go Fix darwin support 2015-03-08 14:32:49 +01:00
node_linux.go Bugfix: Backup changed data in incremental mode 2015-03-22 15:09:54 +01:00
node_windows.go Move platform specific code to different files 2015-02-03 21:18:19 +01:00
pools.go Refactor crypto layer, switch HMAC for Poyl1305-AES 2015-03-14 20:00:41 +01:00
progress.go Progress: Add function that is called on Start() 2015-03-22 14:19:16 +01:00
restorer.go Add walk for trees, restructure 2015-03-02 19:58:06 +01:00
server.go Refactor crypto layer, switch HMAC for Poyl1305-AES 2015-03-14 20:00:41 +01:00
server_test.go Add test for incremental backup 2015-03-10 14:17:54 +01:00
snapshot.go Add walk for trees, restructure 2015-03-02 19:58:06 +01:00
snapshot_darwin.go Introduce UserID, GroupID for snapshot 2015-02-03 22:04:09 +01:00
snapshot_linux.go Introduce UserID, GroupID for snapshot 2015-02-03 22:04:09 +01:00
snapshot_test.go Add walk for trees, restructure 2015-03-02 19:58:06 +01:00
snapshot_windows.go Introduce UserID, GroupID for snapshot 2015-02-03 22:04:09 +01:00
testsuite.sh wip 2015-02-15 15:17:24 +01:00
tree.go Remove unused code 2015-03-08 14:22:35 +01:00
tree_test.go Allow configuring temp dir for tests 2015-02-21 16:53:14 +01:00
walk.go Remove extra argument 2015-03-08 21:21:31 +01:00
walk_test.go Refactor backup pipeline 2015-03-08 14:16:01 +01:00
zerrors_linux.go Rename khepri -> restic 2014-12-05 21:45:49 +01:00

README.md

Stories in Ready Build Status sourcegraph 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 1.3), then run:

export GOPATH=~/src/go
go get github.com/restic/restic/cmd/restic
$GOPATH/bin/restic --help

Contribute

Contributions are welcome! Please make sure that all code submitted in pull-requests is properly formatted with gofmt. Installing the script fmt-check from https://github.com/edsrzf/gofmt-git-hook locally as a pre-commit hook checks formatting before commiting, just copy this script to .git/hooks/pre-commit.

If you are unsure what to do, please have a look at the github issues, especially those tagged minor complexity.

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.