ssh client revision added some helper scripts and changed to alpine

README.md

@@ -1 +1,77 @@
-git.limbosolutions.com/kb/borg-backup
+# borg-backup
+
+<https://www.borgbackup.org/>
+
+## container image
+
+## environment variables
+
+<https://borgbackup.readthedocs.io/en/stable/usage/general.html#environment-variables>
+
+``` bash
+docker run git.limbosolutions.com/kb/borg-backup:latest
+```
+
+### docker compose
+
+Example of simple usage for creating a backup
+
+```yaml
+services:
+   borg-backup:
+    image: git.limbosolutions.com/kb/borg-backup:latest
+    command: create ${BORG_REPO}::repos-$(date +%Y%m%d%H%M%S) /mnt/user
+    restart: no
+
+    volumes:
+      - ./home/user:/mnt/user  # Mount local folder to container
+
+    environment:
+      - BORG_REPO=?????
+      - BORG_RSH="ssh -o StrictHostKeyChecking=no"
+      - BORG_PASSPHRASE=????
+
+    configs:
+      - source: id_ed25519 # required for ssh client
+        target: /home/borg/.ssh/id_ed25519     
+      - source: borg_key # required for borg client
+        target: /app/borg/key
+
+        
+configs:
+
+  id_ed25519:
+      content: |
+        -----BEGIN OPENSSH PRIVATE KEY-----
+            **************
+            **************
+        -----END OPENSSH PRIVATE KEY-----
+
+  borg_key:
+      content: |
+        BORG_KEY ???????
+        ????????????????
+        ????????????????
+    
+
+```
+
+### dev
+
+``` bash
+docker compose \
+--project-name borg-backup-dev \
+-f docker-compose.dev.yaml \
+-f docker-compose.dev.local.yaml \
+up 
+```
+
+Force Build:
+
+``` bash
+docker compose \
+--project-name borg-backup-dev \
+-f docker-compose.dev.yaml \
+-f docker-compose.dev.local.yaml \
+up --build
+```