restic/README.md

103 lines
3.7 KiB
Markdown
Raw Normal View History

2014-12-05 20:58:42 +00:00
[![Stories in Ready](https://badge.waffle.io/restic/restic.png?label=ready&title=Ready)](https://waffle.io/restic/restic)
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)
2014-12-05 20:58:42 +00:00
[![sourcegraph status](https://sourcegraph.com/api/repos/github.com/restic/restic/.badges/status.png)](https://sourcegraph.com/github.com/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
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.
Building
========
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>
Application Options:
-r, --repo= Repository directory to backup to/restore from
Help Options:
-h, --help Show this help message
Available commands:
backup save file/directory
cache manage cache
cat dump something
find find a file/directory
fsck check the repository
init create repository
key manage keys
list lists data
ls list files
restore restore a snapshot
snapshots show snapshots
version display version
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
restic and the data structures stored on disc is contained in
[`doc/Design.md`](doc/Design.md).
2015-06-24 17:20:27 +00:00
Development
===========
For development, please have a look at [`CONTRIBUTING.md`](CONTRIBUTING.md),
especially the section "Development Environment". If you have any questions,
please get in touch!
2015-03-13 20:46:52 +00:00
Contact
=======
If you discover a bug or find something surprising, please feel free to [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. Or just write me an email :)
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`.