Go to file

Alexander Neumann f366a636e6 Fix build_release_binaries.sh		2017-02-02 10:23:18 +01:00
.github	Add issue template	2016-02-21 00:35:58 +01:00
doc	Merge pull request #750 from restic/document-rest-create-repo	2017-02-02 10:03:07 +01:00
src	Don't set GOMAXPROCS	2017-02-02 10:18:07 +01:00
vendor	Vendor github.com/pkg/profile	2017-01-23 17:41:07 +01:00
.envrc	Add hints how to use the `go` tool and direnv	2016-10-17 13:09:56 +02:00
.gitignore	.gitignore: Add /vendor/pkg	2016-02-21 15:33:13 +01:00
.hound.yml	…
.travis.yml	Update .travis.yml	2016-12-30 15:21:49 +01:00
CONTRIBUTING.md	Add paragraph about code contributions	2017-02-01 12:00:38 +01:00
Dockerfile	Remove coveralls.io	2016-09-03 11:06:09 +02:00
LICENSE	…
Makefile	Fix Makefile	2016-03-31 19:20:57 +02:00
README.md	Add paragraph about code contributions	2017-02-01 12:00:38 +01:00
VERSION	Add VERSION file for 0.4.0	2017-02-02 10:21:29 +01:00
Vagrantfile	Vagrantfile: Fix network for darwin	2016-05-07 23:38:41 +02:00
appveyor.yml	Update appveyor configuration	2016-12-30 17:07:42 +01:00
build.go	build.go: Make binaries completely static (disables cgo)	2017-01-12 19:51:26 +01:00
build_release_binaries.sh	Fix build_release_binaries.sh	2017-02-02 10:23:18 +01:00
mkdocs.yml	doc/mkdocs: Improve code hilighting	2016-11-08 20:23:39 +01:00
run_integration_tests.go	CI: cross-compile for OpenBSD	2017-01-12 19:50:41 +01:00

README.md

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 file FAQ.md lists the most frequently asked questions.

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! Please open an issue first (or add a comment to an existing issue) if you plan to work on any code or add a new feature. This way, duplicate work is prevented and we can discuss your ideas and design first.

More information and a description of the development environment 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.

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>
      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.