Go to file
Alexander Neumann 874b29b91f Improve memory usage (and speed) of crypto reader/writer
benchcmp:

    benchmark                         old ns/op     new ns/op     delta
    BenchmarkChunkEncrypt             260811933     261294510     +0.19%
    BenchmarkChunkEncryptParallel     262787948     259394601     -1.29%
    BenchmarkEncryptWriter            89769328      87108804      -2.96%
    BenchmarkEncrypt                  88586645      87489151      -1.24%
    BenchmarkDecryptReader            99669425      90019414      -9.68%
    BenchmarkEncryptDecryptReader     189263157     185185733     -2.15%
    BenchmarkDecrypt                  89631109      89172417      -0.51%

    benchmark                         old MB/s     new MB/s     speedup
    BenchmarkChunkEncrypt             40.20        40.13        1.00x
    BenchmarkChunkEncryptParallel     39.90        40.42        1.01x
    BenchmarkEncryptWriter            93.45        96.30        1.03x
    BenchmarkEncrypt                  94.69        95.88        1.01x
    BenchmarkDecryptReader            84.16        93.19        1.11x
    BenchmarkEncryptDecryptReader     44.32        45.30        1.02x
    BenchmarkDecrypt                  93.59        94.07        1.01x

    benchmark                         old allocs     new allocs     delta
    BenchmarkChunkEncrypt             113            113            +0.00%
    BenchmarkChunkEncryptParallel     104            104            +0.00%
    BenchmarkEncryptWriter            20             20             +0.00%
    BenchmarkEncrypt                  14             14             +0.00%
    BenchmarkDecryptReader            38             18             -52.63%
    BenchmarkEncryptDecryptReader     61             55             -9.84%
    BenchmarkDecrypt                  17             17             +0.00%

    benchmark                         old bytes     new bytes     delta
    BenchmarkChunkEncrypt             8515750       8515750       +0.00%
    BenchmarkChunkEncryptParallel     8515766       8515766       +0.00%
    BenchmarkEncryptWriter            8391305       28927         -99.66%
    BenchmarkEncrypt                  2475          2475          +0.00%
    BenchmarkDecryptReader            33563550      527827        -98.43%
    BenchmarkEncryptDecryptReader     50348456      35814894      -28.87%
    BenchmarkDecrypt                  8391127       8391127       +0.00%
2015-02-16 22:35:46 +01:00
backend Remove Compress() and Uncompress() from backend 2015-02-16 00:30:51 +01:00
chunker Slightly improve performance for chunker 2015-02-13 20:03:40 +01:00
cmd wip 2015-02-15 15:17:24 +01:00
debug debug: do not seek after creating log file 2015-02-08 14:46:29 +01:00
doc Remove duplicate paragraphs 2015-02-02 08:41:53 +01:00
pipe wip 2015-02-15 15:17:24 +01:00
testsuite Refactor testsuite 2015-01-17 16:32:24 +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 Correct URL in README.md 2015-01-02 23:16:42 +01:00
archiver.go Remove Compress() and Uncompress() from backend 2015-02-16 00:30:51 +01:00
archiver_test.go wip 2015-02-15 15:17:24 +01:00
blob.go Implement streaming chunker using io.Reader 2015-02-09 00:28:54 +01:00
generic_test.go Rename khepri -> restic 2014-12-05 21:45:49 +01:00
key.go Improve memory usage (and speed) of crypto reader/writer 2015-02-16 22:35:46 +01:00
key_int_test.go Refactor tests, integrate debug break points 2015-01-14 17:32:37 +01:00
key_test.go Remove EncryptFrom*() methods, add Tests for EncryptTo() 2015-02-15 23:38:45 +01:00
map.go Refactor debug into debug module 2015-01-17 16:32:13 +01:00
map_test.go Refactor repository structure 2015-01-14 16:34:30 +01:00
node.go wip 2015-02-15 15:17:24 +01:00
node_darwin.go Extend darwin support 2015-02-03 21:32:01 +01:00
node_linux.go Always cast link counter to uint64 2015-02-03 22:06:17 +01:00
node_windows.go Move platform specific code to different files 2015-02-03 21:18:19 +01:00
pools.go chunker: Add test, only pass hash.Hash to New() 2015-02-11 13:12:36 +01:00
progress.go Progress: Add convenience functions 2015-02-07 17:05:49 +01:00
restorer.go Make CreateAtNodeAt() independend from Tree 2015-02-03 21:04:51 +01:00
scanner.go Refactor repository structure 2015-01-14 16:34:30 +01:00
server.go Re-use zlib writers to reduce memory usage 2015-02-16 22:35:26 +01:00
server_test.go Add test and benchmark for SaveFrom() 2015-02-16 22:35:46 +01:00
snapshot.go Introduce UserID, GroupID for snapshot 2015-02-03 22:04:09 +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 Refactor repository structure 2015-01-14 16:34:30 +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 wip 2015-02-15 15:17:24 +01:00
tree_test.go Refactor repository structure 2015-01-14 16:34:30 +01:00
wercker.yml Add gofmt test to wercker.yml 2015-02-15 15:07:43 +01:00
zerrors_linux.go Rename khepri -> restic 2014-12-05 21:45:49 +01:00

README.md

Stories in Ready wercker 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 (at least 1.2), 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.

License

Restic is licensed under "BSD 2-Clause License". You can find the complete text in the file LICENSE.