mirror of https://github.com/restic/rest-server.git synced 2025-10-19 07:33:21 +00:00

Rest Server is a high performance HTTP server that implements restic's REST backend API.

Find a file

Zlatko Čalušić 061d31829d Create directories before key setup, not on startup		2016-12-27 01:35:45 +01:00
etc	Example systemd service file	2016-11-07 00:54:32 +01:00
.gitignore	Initial commit	2015-08-11 14:19:05 +02:00
.travis.yml	Add .travis.yml	2016-11-05 18:20:43 +01:00
handlers.go	Create directories before key setup, not on startup	2016-12-27 01:35:45 +01:00
htpasswd.go	Remove fs package and dirty tricks it does	2016-11-06 20:09:42 +01:00
LICENSE	Update LICENSE	2016-11-05 17:49:22 +01:00
main.go	Create directories before key setup, not on startup	2016-12-27 01:35:45 +01:00
README.md	Update README.md	2016-11-05 19:00:31 +01:00
router.go	Remove debugging log.Printf()	2016-11-06 19:42:35 +01:00
router_test.go	Remove needless build tags	2016-11-06 11:26:06 +01:00

README.md

Restic Server

Restic Server is a sample server that implements restic's REST backend API. It has been developed for demonstration purpose and is not intended to be used in production.

Getting started

By default the server persists backup data in /tmp/restic. Build and start the server with a custom persistence directory:

go install
restic-server -path /user/home/backup

The server uses an .htpasswd file to specify users. You can create such a file at the root of the persistence directory by executing the following command. In order to append new user to the file, just omit the -c argument.

htpasswd -s -c .htpasswd username

By default the server uses HTTP protocol. This is not very secure since with Basic Authentication, username and passwords will be present in every request. In order to enable TLS support just add the -tls argument and add a private and public key at the root of your persistence directory.

Signed certificate is required by the restic backend, but if you just want to test the feature you can generate unsigned keys with the following commands:

openssl genrsa -out private_key 2048
openssl req -new -x509 -key private_key -out public_key -days 365

Contributors

Contributors are welcome, just open a new issue / pull request.

License

The BSD 2-Clause License

Copyright © 2015, Bertil Chapuis
Copyright © 2016, Zlatko Čalušić
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.