From 160ad45d6ff8dfb2278fa56a028d1b9debf5273e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zlatko=20=C4=8Calu=C5=A1i=C4=87?= Date: Sat, 5 Nov 2016 17:40:17 +0100 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index aa5d33e..729907d 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,31 @@ # Restic Server -Restic Server is a sample server that implement restic's rest backend api. -It has been developed for demonstration purpose and is not intented to be used in production. +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`. +By default the server persists backup data in `/tmp/restic`. Build and start the server with a custom persistence directory: ``` -go build -./restic-server -path /user/home/backup +go install +restic-server -path /user/home/backup ``` -The server use 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. +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. 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. +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 are required by the restic backend but if you just want to test the feature you can generate unsigned keys with the following commands: +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