Yet another small README update

This commit is contained in:
nold 2017-10-20 16:41:53 +02:00
parent 51566a95da
commit accc4ab3aa

View file

@ -1,6 +1,29 @@
# BorgServer - Docker image
Debian based container image, running openssh-daemon only accessable by user named "borg" using SSH-Publickey Auth & "borgbackup" as client. Backup-Repositoriees, client's SSH-Keys & SSHd's Hostkeys will be stored in persistent storage.
### Quick Example
Here is a quick example how to configure & run this image:
Create persistent directories
```
mkdir -p borg/sshkeys/client borg/backup
```
Copy any client ssh publickey into container
*Remember*: Filename = Borg-repository name!
```
cp ~/.ssh/my_machine.pub borg/sshkeys/client/my_machine
```
The OpenSSH-Deamon will expose on port 22/tcp - so you will most likely want to redirect it to a different port. Like 2233 in this example:
```
docker run -td
-p 2233:22 \
--volume $(pwd)/borg/sshkeys:/sshkeys \
--volume $(pwd)/borg/backup:/backup \
nold360/borgserver:latest
```
## Borgserver Configuration
* Place Borg-Clients SSH-PublicKeys in persistent storage
* Client Repositories will be named by the filename found in /sshkeys/clients/
@ -24,13 +47,10 @@ Than your client would have to initiat the borg repository like this:
webserver.mydomain.com ~$ borg init ssh://borg@borgserver-container/backup/webserver.mydomain.com
```
!IMPORTANT!: The container wouldn't start the SSH-Deamon until there is at least one ssh-keyfile in this directory!
**!IMPORTANT!**: The container wouldn't start the SSH-Deamon until there is at least one ssh-keyfile in this directory!
##### /sshkeys/host/
This directory will be automaticly created on first start. Also run.sh will copy the SSH-Hostkeys here, so your clients can verify it's borgservers ssh-hostkey.
#### /backup
In this directory will borg write all the client data to. It's best to start with an empty directory.
### Example
Here is a quick example how to run this image: