8c8ebd20b3
Improve docs for contribution |
||
|---|---|---|
| backend | ||
| chunker | ||
| cmd | ||
| crypto | ||
| debug | ||
| doc | ||
| pack | ||
| pipe | ||
| server | ||
| test | ||
| testsuite | ||
| .gitignore | ||
| .travis.yml | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| archiver.go | ||
| archiver_int_test.go | ||
| archiver_test.go | ||
| cache.go | ||
| cache_test.go | ||
| node.go | ||
| node_darwin.go | ||
| node_freebsd.go | ||
| node_linux.go | ||
| node_openbsd.go | ||
| node_test.go | ||
| progress.go | ||
| restorer.go | ||
| snapshot.go | ||
| snapshot_test.go | ||
| testsuite.sh | ||
| tree.go | ||
| tree_test.go | ||
| walk.go | ||
| walk_test.go | ||
README.md
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 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.