Yavook.de/kiwi-backup
1
0
Fork 0
mirror of https://github.com/yavook/kiwi-backup.git synced 2024-11-22 15:03:01 +00:00
Code Packages Activity

Merge tag 'v0.12.1' into develop

Browse source 
typo
This commit is contained in:
Jörn-Michael Miehe 2022-10-24 03:00:46 +02:00
commit dd5d890ffd
2 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -14,7 +14,7 @@ If you want backups in the host directory `/var/local/kiwi.backup`, just add thi
```yaml ```yaml
backup: backup:
image: yavook/kiwi-backup:0.10 image: yavook/kiwi-backup:0.12
volumes: volumes:
- "${KIWI_INSTANCE}:/kiwi-backup/source:ro" - "${KIWI_INSTANCE}:/kiwi-backup/source:ro"
- "/var/local/kiwi.backup:/kiwi-backup/target" - "/var/local/kiwi.backup:/kiwi-backup/target"
@ -95,14 +95,14 @@ There are three major ways to for inject secrets into `kiwi-backup` environments
#### Container environment #### Container environment
Just fire up your container using `docker run -e "FTP_PASSWORD=my_secret_here" yavook/kiwi-backup:0.10` Just fire up your container using `docker run -e "FTP_PASSWORD=my_secret_here" yavook/kiwi-backup:0.12`
#### Image environment #### Image environment
Create a simple `Dockerfile` from following template. Create a simple `Dockerfile` from following template.
```Dockerfile ```Dockerfile
FROM yavook/kiwi-backup:0.10 FROM yavook/kiwi-backup:0.12
ENV FTP_PASSWORD="my_secret_here" ENV FTP_PASSWORD="my_secret_here"
``` ```
@ -194,7 +194,7 @@ Reasonable defaults for a backup encryption key are:
To quickly generate a key, use the following command, then enter a passphrase: To quickly generate a key, use the following command, then enter a passphrase:
```sh ```sh
docker run --rm -it -v "kiwi-backup.gnupg.tmp:/root/.gnupg" yavook/kiwi-backup:0.10 gpg --quick-gen-key --yes "Administrator <root@my-hostname.com>" rsa4096 encr never docker run --rm -it -v "kiwi-backup.gnupg.tmp:/root/.gnupg" yavook/kiwi-backup:0.12 gpg --quick-gen-key --yes "Administrator <root@my-hostname.com>" rsa4096 encr never
``` ```
To get a more in-depth generation wizard instead, use `gpg --full-gen-key` command without any more args and follow through. To get a more in-depth generation wizard instead, use `gpg --full-gen-key` command without any more args and follow through.
@ -204,13 +204,13 @@ To get a more in-depth generation wizard instead, use `gpg --full-gen-key` comma
This one-liner exports your generated key into a new subdirectory "kiwi-backup.gnupg": This one-liner exports your generated key into a new subdirectory "kiwi-backup.gnupg":
```sh ```sh
docker run --rm -it -v "kiwi-backup.gnupg.tmp:/root/.gnupg" -v "$(pwd)/kiwi-backup.gnupg:/root/kiwi-backup.gnupg" -e "CURRENT_USER=$(id -u):$(id -g)" yavook/kiwi-backup:0.10 sh -c 'cd /root/kiwi-backup.gnupg && gpg --export-secret-keys --armor > secret.asc && gpg --export-ownertrust > ownertrust.txt && chown -R "${CURRENT_USER}" .' docker run --rm -it -v "kiwi-backup.gnupg.tmp:/root/.gnupg" -v "$(pwd)/kiwi-backup.gnupg:/root/kiwi-backup.gnupg" -e "CURRENT_USER=$(id -u):$(id -g)" yavook/kiwi-backup:0.12 sh -c 'cd /root/kiwi-backup.gnupg && gpg --export-secret-keys --armor > secret.asc && gpg --export-ownertrust > ownertrust.txt && chown -R "${CURRENT_USER}" .'
``` ```
You'll now find the "kiwi-backup.gnupg" subdirectory with files "secret.asc" and "ownertrust.txt" in it. Check your exported files: You'll now find the "kiwi-backup.gnupg" subdirectory with files "secret.asc" and "ownertrust.txt" in it. Check your exported files:
```sh ```sh
docker run --rm -v "$(pwd)/kiwi-backup.gnupg:/root/kiwi-backup.gnupg:ro" yavook/kiwi-backup:0.10 sh -c 'cd /root/kiwi-backup.gnupg && gpg --import --batch secret.asc 2>/dev/null && gpg --import-ownertrust ownertrust.txt 2>/dev/null && gpg -k 2>/dev/null | grep -A1 "^pub" | xargs | tail -c17' docker run --rm -v "$(pwd)/kiwi-backup.gnupg:/root/kiwi-backup.gnupg:ro" yavook/kiwi-backup:0.12 sh -c 'cd /root/kiwi-backup.gnupg && gpg --import --batch secret.asc 2>/dev/null && gpg --import-ownertrust ownertrust.txt 2>/dev/null && gpg -k 2>/dev/null | grep -A1 "^pub" | xargs | tail -c17'
``` ```
This should output your 16-digit Key-ID, so take note of it if you haven't already! Afterwards, run `docker volume rm kiwi-backup.gnupg.tmp` to get rid of the key generation volume. This should output your 16-digit Key-ID, so take note of it if you haven't already! Afterwards, run `docker volume rm kiwi-backup.gnupg.tmp` to get rid of the key generation volume.
@ -227,7 +227,7 @@ gpg --export-ownertrust > backup/ownertrust.txt
You can still check your exported files :) You can still check your exported files :)
```sh ```sh
docker run --rm -v "$(pwd)/kiwi-backup.gnupg:/root/kiwi-backup.gnupg:ro" yavook/kiwi-backup:0.10 sh -c 'cd /root/kiwi-backup.gnupg && gpg --import --batch secret.asc && gpg --import-ownertrust ownertrust.txt && gpg -k' docker run --rm -v "$(pwd)/kiwi-backup.gnupg:/root/kiwi-backup.gnupg:ro" yavook/kiwi-backup:0.12 sh -c 'cd /root/kiwi-backup.gnupg && gpg --import --batch secret.asc && gpg --import-ownertrust ownertrust.txt && gpg -k'
``` ```
### Describe local kiwi-backup image ### Describe local kiwi-backup image
@ -235,7 +235,7 @@ docker run --rm -v "$(pwd)/kiwi-backup.gnupg:/root/kiwi-backup.gnupg:ro" yavook/
Now create a simple `Dockerfile` inside the "backup" directory from following template. Now create a simple `Dockerfile` inside the "backup" directory from following template.
```Dockerfile ```Dockerfile
FROM yavook/kiwi-backup:0.10 FROM yavook/kiwi-backup:0.12
COPY secret.asc ownertrust.txt /root/ COPY secret.asc ownertrust.txt /root/
@ -256,7 +256,7 @@ All that's left is to come back to your project's `docker-compose.yml`, where yo
```yaml ```yaml
backup: backup:
image: yavook/kiwi-backup:0.10 image: yavook/kiwi-backup:0.12
# ... # ...
``` ```

6
libexec/kiwi-backup/run_command
View file

@ -20,7 +20,7 @@ if [ -n "${GPG_PASSPHRASE}" ]; then
fi fi
# run start webhook # run start webhook
/usr/local/libexec/kiwi-cron/run_webhook \ /usr/local/libexec/kiwi-backup/run_webhook \
"${WEBHOOK_URL}" "running task ${*}" "${WEBHOOK_INSECURE}" "${WEBHOOK_URL}" "running task ${*}" "${WEBHOOK_INSECURE}"
# hand over # hand over
@ -33,11 +33,11 @@ exit_status="${?}"
# run finish webhook # run finish webhook
if [ "${exit_status}" -eq "0" ]; then if [ "${exit_status}" -eq "0" ]; then
/usr/local/libexec/kiwi-cron/run_webhook \ /usr/local/libexec/kiwi-backup/run_webhook \
"${WEBHOOK_URL}" "task ${*} successful" "${WEBHOOK_INSECURE}" "${WEBHOOK_URL}" "task ${*} successful" "${WEBHOOK_INSECURE}"
else else
/usr/local/libexec/kiwi-cron/run_webhook \ /usr/local/libexec/kiwi-backup/run_webhook \
"${WEBHOOK_FAIL_URL:-${WEBHOOK_URL}}" "task ${*} failed, status ${exit_status}" "${WEBHOOK_INSECURE}" "${WEBHOOK_FAIL_URL:-${WEBHOOK_URL}}" "task ${*} failed, status ${exit_status}" "${WEBHOOK_INSECURE}"
fi fi