Go to file
Alexander Neumann 223dc78acb Improve statistics for `prune`
Sample:

    counting files in repo
    building new index for repo
    [0:00] 100.00%  22 / 22 packs
    repository contains 22 packs (1377 blobs) with 90.610 MiB bytes
    processed 1377 blobs: 0 duplicate blobs, 0B duplicate
    load all snapshots
    find data that is still in use for 1 snapshots
    [0:00] 100.00%  1 / 1 snapshots
    found 409 of 1377 data blobs still in use, removing 968 blobs
    will delete 10 packs and rewrite 10 packs, this frees 64.232 MiB
    creating new index
    [0:00] 100.00%  7 / 7 packs
    saved new index as df467c6e
    done

Closes #581
2016-09-12 14:26:47 +02:00
.github Add issue template 2016-02-21 00:35:58 +01:00
doc Fix a small typo in `stdin` example 2016-09-05 19:01:53 +02:00
src Improve statistics for `prune` 2016-09-12 14:26:47 +02:00
vendor Update chunker 2016-09-03 20:56:21 +02:00
.gitignore .gitignore: Add /vendor/pkg 2016-02-21 15:33:13 +01:00
.hound.yml Enable HoundCI checking for Go 2016-02-05 21:15:46 +01:00
.travis.yml Add codecov.io 2016-09-03 10:44:37 +02:00
CONTRIBUTING.md doc: point to correct `db` arg for `go get` 2016-04-13 15:52:08 -04:00
Dockerfile Remove coveralls.io 2016-09-03 11:06:09 +02:00
LICENSE LICENSE: Add email address 2014-09-18 21:10:30 +02:00
Makefile Fix Makefile 2016-03-31 19:20:57 +02:00
README.md Remove coveralls.io 2016-09-03 11:06:09 +02:00
VERSION add VERSION file for 0.2.0 2016-07-30 11:24:52 +02:00
Vagrantfile Vagrantfile: Fix network for darwin 2016-05-07 23:38:41 +02:00
appveyor.yml Require Go 1.6 or greater 2016-08-16 20:32:58 +02:00
build.go Require Go 1.6 or greater 2016-08-16 20:32:58 +02:00
mkdocs.yml Add mkdocs for readthedocs.org 2016-02-21 12:28:46 +01:00
run_integration_tests.go Remove coveralls.io 2016-09-03 11:06:09 +02:00

README.md

Documentation Build Status Build status Report Card

Introduction

restic is a backup program that is fast, efficient and secure. Detailed information can be found in the documentation and the user manual. The design document lists the technical background and gives detailed information about the structure of the repository and the data saved therein.

The latest documentation can be viewed online at https://restic.readthedocs.io/en/latest. On the bottom left corner there is a menu that allows switching to the documentation and user manual for the latest released version.

Build restic

Install Go/Golang (at least version 1.6), then run go run build.go, afterwards you'll find the binary in the current directory:

$ go run build.go

$ ./restic --help
Usage:
  restic [OPTIONS] <command>
[...]

More documentation can be found in the user manual.

At the moment, the only tested compiler for restic is the official Go compiler. Building restic with gccgo may work, but is not supported.

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 the back end is contained in doc/Design.md. The development environment is described in CONTRIBUTING.md.

If you'd like to start contributing to restic, but don't know exactly what do to, have a look at this great article by Dave Cheney: Suggestions for contributing to an Open Source project A few issues have been tagged with the label help wanted, you can start looking at those: https://github.com/restic/restic/labels/help%20wanted

Contact

If you discover a bug, find something surprising or if you would like to discuss or ask something, please open a github issue. If you would like to chat about restic, there is also the IRC channel #restic on irc.freenode.net.

Important: If you discover something that you believe to be a possible critical security problem, please do not open a GitHub issue but send an email directly to alexander@bumpern.de. If possible, please encrypt your email using the following PGP key (0x91A6868BD3F7A907):

pub   4096R/91A6868BD3F7A907 2014-11-01
      Key fingerprint = CF8F 18F2 8445 7597 3F79  D4E1 91A6 868B D3F7 A907
      uid                          Alexander Neumann <alexander@bumpern.de>
      uid                          Alexander Neumann <alexander@debian.org>
      sub   4096R/D5FC2ACF4043FDF1 2014-11-01

License

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