2014-12-05 20:58:42 +00:00
|
|
|
[](https://waffle.io/restic/restic)
|
|
|
|
|
[](https://app.wercker.com/project/bykey/e78e51f3e5af7fff50962332615ce9a3)
|
|
|
|
|
[](https://sourcegraph.com/github.com/restic/restic)
|
2014-11-15 23:43:15 +00:00
|
|
|
|
2014-04-28 19:16:39 +00:00
|
|
|
WARNING
|
|
|
|
|
=======
|
2014-04-27 13:49:48 +00:00
|
|
|
|
2014-12-05 20:53:26 +00:00
|
|
|
WARNING: At the moment, consider restic as alpha quality software, it is not
|
2014-04-28 19:16:39 +00:00
|
|
|
yet finished. Do not use it for real data!
|
2014-04-27 13:49:48 +00:00
|
|
|
|
2014-12-05 20:53:26 +00:00
|
|
|
Restic
|
2014-04-27 13:49:48 +00:00
|
|
|
======
|
|
|
|
|
|
2014-12-05 20:53:26 +00:00
|
|
|
Restic is a program that does backups right. The design goals are:
|
2014-04-27 13:49:48 +00:00
|
|
|
|
2014-04-28 19:16:39 +00:00
|
|
|
* Easy: Doing backups should be a frictionless process, otherwise you are
|
2014-12-05 20:53:26 +00:00
|
|
|
tempted to skip it. Restic should be easy to configure and use, so that in
|
2014-04-28 19:16:39 +00:00
|
|
|
the unlikely event of a data loss you can just restore it. Likewise,
|
2014-04-27 13:49:48 +00:00
|
|
|
restoring data should not be complicated.
|
|
|
|
|
|
2014-12-05 20:53:26 +00:00
|
|
|
* Fast: Backing up your data with restic should only be limited by your
|
2014-04-28 19:16:39 +00:00
|
|
|
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.
|
|
|
|
|
|
2014-12-05 20:53:26 +00:00
|
|
|
* Verifiable: Much more important than backup is restore, so restic enables
|
2014-04-28 19:16:39 +00:00
|
|
|
you to easily verify that all data can be restored.
|
|
|
|
|
|
2014-12-05 20:53:26 +00:00
|
|
|
* Secure: Restic uses cryptography to guarantee confidentiality and integrity
|
2014-04-28 19:16:39 +00:00
|
|
|
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
|
2014-12-05 20:53:26 +00:00
|
|
|
administrators are able to access your backups). Restic is built to secure
|
2014-04-28 19:16:39 +00:00
|
|
|
your data against such attackers.
|
2014-04-27 13:49:48 +00:00
|
|
|
|
2014-11-16 11:08:11 +00:00
|
|
|
* 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.
|
|
|
|
|
|
|
|
|
|
|
2014-10-02 19:42:53 +00:00
|
|
|
Building
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
Install Go (at least 1.2), then run:
|
|
|
|
|
|
2015-01-02 22:11:14 +00:00
|
|
|
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
|
2015-01-02 22:13:30 +00:00
|
|
|
`fmt-check` from https://github.com/edsrzf/gofmt-git-hook locally as a
|
2015-01-02 22:16:42 +00:00
|
|
|
pre-commit hook checks formatting before commiting, just copy this script to
|
|
|
|
|
`.git/hooks/pre-commit`.
|
2015-01-02 22:13:30 +00:00
|
|
|
|
|
|
|
|
If you are unsure what to do, please have a look at the github issues,
|
|
|
|
|
especially those tagged
|
2015-01-02 22:16:42 +00:00
|
|
|
[minor complexity](https://github.com/restic/restic/labels/minor%20complexity).
|
2014-10-02 19:42:53 +00:00
|
|
|
|
2014-04-27 13:49:48 +00:00
|
|
|
License
|
|
|
|
|
=======
|
|
|
|
|
|
2014-12-05 20:53:26 +00:00
|
|
|
Restic is licensed under "BSD 2-Clause License". You can find the complete text
|
2014-04-27 13:49:48 +00:00
|
|
|
in the file `LICENSE`.
|
