Go to file

Alexander Neumann 7b6bd98c9e crypto: Rename internal functions		2015-04-19 14:57:35 +02:00
backend	Use package "restic/test"	2015-04-09 21:15:48 +02:00
chunker	Use package "restic/test"	2015-04-09 21:15:48 +02:00
cmd	Take last snapshot as parent by default and allow force re-reading	2015-04-07 22:03:50 +02:00
crypto	crypto: Rename internal functions	2015-04-19 14:57:35 +02:00
debug	debug: fix typos	2015-04-09 23:15:45 +02:00
doc	Clarify terminology	2015-04-09 20:48:32 +02:00
pipe	Use package "restic/test"	2015-04-09 21:15:48 +02:00
test	Reorganize crypto code	2015-04-12 09:36:14 +02:00
testsuite	Add test for backing up non-existing files	2015-03-28 16:16:19 +01:00
.travis.yml	Run sftp integration test in a subshell	2015-03-28 15:53:33 +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	Seed chunker with random per-repository polynomial	2015-04-06 00:22:19 +02:00
archiver_int_test.go	Fix comparison for new files with '.'	2015-03-10 14:17:50 +01:00
archiver_test.go	Reorganize crypto code	2015-04-12 09:36:14 +02:00
blob.go	Remove unused key offset from blob struct	2015-03-28 16:59:14 +01:00
cache.go	Add checks for Server.Load(), use Blob for load	2015-03-28 15:07:08 +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	Use package "restic/test"	2015-04-09 21:15:48 +02:00
key.go	crypto: Match signature of Encrypt() to Decrypt()	2015-04-12 20:58:41 +02:00
key_test.go	Reorganize crypto code	2015-04-12 09:36:14 +02:00
map.go	Recreate blob cache if missing (closes #104 )	2015-03-14 18:15:47 +01:00
map_test.go	Use package "restic/test"	2015-04-09 21:15:48 +02:00
node.go	Node: Also store ModeType bits in Mode	2015-04-07 21:57:26 +02: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	Rename crypto functions and constants	2015-04-12 09:41:47 +02:00
progress.go	Progress: Add function that is called on Start()	2015-03-22 14:19:16 +01:00
restorer.go	Add checks for Server.Load(), use Blob for load	2015-03-28 15:07:08 +01:00
server.go	crypto: Match signature of Encrypt() to Decrypt()	2015-04-12 20:58:41 +02:00
server_test.go	Use package "restic/test"	2015-04-09 21:15:48 +02:00
snapshot.go	Add checks for Server.Load(), use Blob for load	2015-03-28 15:07:08 +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	Use package "restic/test"	2015-04-09 21:15:48 +02: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	Add checks for Server.Load(), use Blob for load	2015-03-28 15:07:08 +01:00
tree_test.go	Use package "restic/test"	2015-04-09 21:15:48 +02:00
walk.go	Add checks for Server.Load(), use Blob for load	2015-03-28 15:07:08 +01:00
walk_test.go	Use package "restic/test"	2015-04-09 21:15:48 +02:00
zerrors_linux.go	Rename khepri -> restic	2014-12-05 21:45:49 +01:00

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

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.