restic/README.md

117 lines
5.4 KiB
Markdown
Raw Normal View History

2015-03-14 12:23:44 +00:00
[![Build Status](https://travis-ci.org/restic/restic.svg?branch=master)](https://travis-ci.org/restic/restic)
2015-08-19 20:20:44 +00:00
[![Build status](https://ci.appveyor.com/api/projects/status/nuy4lfbgfbytw92q/branch/master?svg=true)](https://ci.appveyor.com/project/fd0/restic/branch/master)
2015-12-27 19:35:20 +00:00
[![Report Card](http://goreportcard.com/badge/restic/restic)](http://goreportcard.com/report/restic/restic)
2015-05-09 09:22:33 +00:00
[![Coverage Status](https://coveralls.io/repos/restic/restic/badge.svg)](https://coveralls.io/r/restic/restic)
2014-11-15 23:43:15 +00:00
2015-08-21 20:08:10 +00:00
Restic Design Principles
========================
2014-04-27 13:49:48 +00:00
2015-08-21 20:08:10 +00:00
Restic is a program that does backups right and was designed with the following
principles in mind:
2014-04-27 13:49:48 +00:00
2015-08-21 20:08:10 +00:00
* Easy: Doing backups should be a frictionless process, otherwise you might be
tempted to skip it. Restic should be easy to configure and use, so that, in
the 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
2015-08-21 20:08:10 +00:00
network or hard disk bandwidth so that you can backup your files every day.
2014-04-28 19:16:39 +00:00
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
2015-08-21 20:08:10 +00:00
de-duplicated before it is actually written to the storage back end to save
2014-11-16 11:08:11 +00:00
precious backup space.
2015-08-21 20:08:10 +00:00
Build restic
============
2015-06-24 15:59:31 +00:00
Install Go/Golang (at least version 1.3), then run `go run build.go`,
afterwards you'll find the binary in the current directory:
2015-05-12 19:22:52 +00:00
2015-06-24 15:59:31 +00:00
$ go run build.go
2015-05-12 19:36:54 +00:00
$ ./restic --help
Usage:
restic [OPTIONS] <command>
2015-11-13 11:41:36 +00:00
[...]
2015-05-12 19:36:54 +00:00
2015-11-13 11:41:36 +00:00
More documentation can be found on the [website](https://restic.github.io),
especially in the [user manual](https://restic.github.io/manual).
2015-07-11 23:48:24 +00:00
At the moment, the only tested compiler for restic is the official Go compiler.
Building restic with gccgo may work, but is not supported.
Compatibility
=============
Backward compatibility for backups is important so that our users are always
able to restore saved data. Therefore restic follows [Semantic
Versioning](http://semver.org) to clearly define which versions are compatible.
The repository and data structures contained therein are considered the "Public
API" in the sense of Semantic Versioning. This goes for all released versions
of restic, this may not be the case for the master branch.
We guarantee backward compatibility of all repositories within one major version;
as long as we do not increment the major version, data can be read and restored.
We strive to be fully backward compatible to all prior versions.
2015-05-06 21:18:46 +00:00
Contribute and Documentation
============================
Contributions are welcome! More information can be found in
[`CONTRIBUTING.md`](CONTRIBUTING.md). A document describing the design of
2015-08-21 21:53:59 +00:00
restic and the data structures stored on the back end is contained in
2015-05-06 21:18:46 +00:00
[`doc/Design.md`](doc/Design.md).
2015-08-17 19:35:06 +00:00
The development environment is described in [`CONTRIBUTING.md`](CONTRIBUTING.md).
2015-06-24 17:20:27 +00:00
2015-03-13 20:46:52 +00:00
Contact
=======
If you discover a bug, find something surprising or if you would like to
discuss or ask something, please [open a github issue](https://github.com/restic/restic/issues/new).
If you would like to chat about restic, there is also the IRC channel #restic
on irc.freenode.net.
2015-03-13 20:46:52 +00:00
2015-07-07 23:43:09 +00:00
**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
2015-10-29 20:51:21 +00:00
alexander@bumpern.de. If possible, please encrypt your email using the following PGP key
([0x91A6868BD3F7A907](https://pgp.mit.edu/pks/lookup?op=get&search=0xCF8F18F2844575973F79D4E191A6868BD3F7A907)):
```
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
```
2015-07-07 23:43:09 +00:00
2015-06-25 20:32:15 +00:00
Talks
=====
2015-07-25 10:17:26 +00:00
The following talks will be or have been given about restic:
2015-06-25 20:32:15 +00:00
* 2016-01-31: Lightning Talk at the Go Devroom at FOSDEM 2016, Brussels, Belgium
* 2016-01-29: [restic - Backups mal richtig](https://media.ccc.de/v/c4.openchaos.2016.01.restic): Public lecture in German at [CCC Cologne e.V.](https://koeln.ccc.de) in Cologne, Germany
2015-07-25 10:17:26 +00:00
* 2015-08-23: [A Solution to the Backup Inconvenience](https://programm.froscon.de/2015/events/1515.html): Lecture at [FROSCON 2015](https://www.froscon.de) in Bonn, Germany
2015-06-26 16:46:00 +00:00
* 2015-02-01: [Lightning Talk at FOSDEM 2015](https://www.youtube.com/watch?v=oM-MfeflUZ8&t=11m40s): A short introduction (with slightly outdated command line)
* 2015-01-27: [Talk about restic at CCC Aachen](https://videoag.fsmpi.rwth-aachen.de/?view=player&lectureid=4442#content) (in German)
2015-06-25 20:32:15 +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`.