From 1ffef452f068749b1795c89dde369f8373a16892 Mon Sep 17 00:00:00 2001 From: nold Date: Thu, 19 Oct 2017 19:57:52 +0200 Subject: [PATCH] Add: quick readme --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..106c20d --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +BorgServer - Docker image +====== + + +Container Configuration +===== +We will need two persistent storage directories for our borgserver to be usefull: + +/sshkeys +==== +Here we will put all SSH public keys from our borg clients, we want to backup. Every key must be it's own file, containing only one line, with the key. The name of the file will become the name of the borg repository, we need for our client to connect. + +That means every client get's it's own repository. So you might want to use the hostname of the client as the name of the sshkey file. + +F.e. /sshkeys/webserver.mydomain.com + +Than your client would have to initiat the borg repository like this: +webserver.mydomain.com ~$ borg init ssh://borg@borgserver-container/backup/$(hostname -f) + +!IMPORTANT!: The container wouldn't start the SSH-Deamon until there is at least one ssh-keyfile in this directory! + +/backup +==== +In this directory will borg write all the client data to. It's best to start with an empty directory. + + +Borgserver Configuration +===== + - Place SSH PublicKeys in persistent storage + - Client Repositories will be named by the filename found in /sshkeys