2016-02-17 15:52:09 +00:00
|
|
|
Welcome to restic
|
|
|
|
|
=================
|
2016-02-17 15:10:31 +00:00
|
|
|
|
2016-02-21 11:51:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
restic is a backup program that is fast, efficient and secure. On the left you
|
|
|
|
|
can find an overview of the documentation. The project's homepage is
|
|
|
|
|
<https://restic.github.io>, the source code repository can be found on GitHub
|
|
|
|
|
at the URL <https://github.com/restic/restic>.
|
2016-02-21 11:58:42 +00:00
|
|
|
|
|
|
|
|
The documentation you're currently viewing may not match the version of restic
|
|
|
|
|
you have installed. If you cloned the repository manually, you can find the
|
|
|
|
|
right documentation in the directory `doc/`. If you're viewing this online at
|
|
|
|
|
<https://restic.readthedocs.org>, there is a small menu at the bottom left of
|
|
|
|
|
this page, where you can select the version.
|
2016-02-21 12:04:45 +00:00
|
|
|
|
|
|
|
|
The restic documentation is built with [MkDocs](http://www.mkdocs.org). After
|
|
|
|
|
installing it, you can edit and view the documentation locally by running:
|
|
|
|
|
|
|
|
|
|
$ mkdocs serve
|
|
|
|
|
INFO - Building documentation...
|
|
|
|
|
INFO - Cleaning site directory
|
|
|
|
|
[I 160221 12:33:57 server:271] Serving on http://127.0.0.1:8000
|
|
|
|
|
|
|
|
|
|
Afterwards visit the URL with a browser.
|
