From ce0070c68b8d6ca056b9ff3ea6d9d3af3b0f8cd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?yJan=20Christian=20Gr=C3=BCnhage?= Date: Tue, 25 Apr 2017 19:23:31 +0200 Subject: [PATCH] Added README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8088df2 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +## What is this? +This is a simple backup server for backing up multiple hosts to with [borgbackup](https://borgbackup.readthedocs.io/en/stable/index.html). +It takes in requires config file in json format, that is used to generate the authorized_keys file, which is regenerated on every container startup. + +### Volumes +This container has three volumes: + - ```/backup/config```, which should contain a file called ```hosts.json```, that contains the hosts allowed to connect to this server. For an example, look at the repo of the generation go script at https://git.jcg.re/jcgruenhage/borg-gen-auth-keys. Please note, that the folder variable in the beginning must be set to the next volume: + - ```/backup/storage```, where the actual backups will be located in. + - ```/backup/keys```, where the host keys of the ssh daemon will be stored, so that replacing the container won't make it untrusted, because of changing keys. + +### Ports +This container only listens on port 22, for SSH connections. Map that to some other host port, and connect to that with something like ```borg create ssh://borg@server:10022/backup/storage/client::archive1```, assuming that the hostname of your server is server, the clients hostname is client and you mapped port 22 to port 10022 on the server.