Go to file
Alexander Neumann 59a6fadf78 pack: remove unneeded comment 2015-04-30 00:37:07 +02:00
backend Remove backend.Tree 2015-04-29 23:27:36 +02:00
chunker Prefer mixedCaps over underscore 2015-04-24 19:39:32 -04:00
cmd Remove leftover comment 2015-04-30 00:25:00 +02:00
crypto Fix data race, remember when signing key has been masked 2015-04-26 13:07:26 +02:00
debug debug: fix typos 2015-04-09 23:15:45 +02:00
doc doc: Add comment about pack header 2015-04-30 00:31:21 +02:00
pack pack: remove unneeded comment 2015-04-30 00:37:07 +02:00
pipe Use package "restic/test" 2015-04-09 21:15:48 +02:00
server Correct debug log fucntion names 2015-04-29 23:47:50 +02:00
test Major restructure, bundle blobs 2015-04-29 23:27:32 +02:00
testsuite rename "change" to "passwd" 2015-04-25 02:44:26 -04:00
.gitignore gitignore binary files 2015-04-24 18:56:17 -04:00
.travis.yml Reduce verbosity of travis notifications on IRC 2015-04-26 13:09:40 +02: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 Major restructure, bundle blobs 2015-04-29 23:27:32 +02:00
archiver_int_test.go Fix comparison for new files with '.' 2015-03-10 14:17:50 +01:00
archiver_test.go Remove backend.Tree 2015-04-29 23:27:36 +02:00
cache.go Remove backend.Tree 2015-04-29 23:27:36 +02:00
cache_test.go Major restructure, bundle blobs 2015-04-29 23:27:32 +02:00
node.go Major restructure, bundle blobs 2015-04-29 23:27:32 +02:00
node_darwin.go uint64(stat.Rdev) works on both platforms 2015-04-28 23:55:47 -04:00
node_linux.go uint64(stat.Rdev) works on both platforms 2015-04-28 23:55:47 -04:00
pools.go golint 2015-04-28 10:23:13 -04:00
progress.go Merge pull request #143 from fw42/count_errors 2015-04-26 12:05:09 +02:00
restorer.go Major restructure, bundle blobs 2015-04-29 23:27:32 +02:00
snapshot.go Major restructure, bundle blobs 2015-04-29 23:27:32 +02: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 Move Server and Key to new sub-package 2015-04-26 14:46:15 +02:00
testsuite.sh wip 2015-02-15 15:17:24 +01:00
tree.go Major restructure, bundle blobs 2015-04-29 23:27:32 +02:00
tree_test.go Major restructure, bundle blobs 2015-04-29 23:27:32 +02:00
walk.go Major restructure, bundle blobs 2015-04-29 23:27:32 +02:00
walk_test.go Major restructure, bundle blobs 2015-04-29 23:27:32 +02: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.