From 2ddc097df557727921d88a3da4a152b5b2b11caa Mon Sep 17 00:00:00 2001 From: pierre perso Date: Sun, 4 Apr 2021 08:05:17 +0000 Subject: [PATCH] Check ATTACHMENT_BACKUP_FILE define :microscope: --- Dockerfile | 2 +- README.md | 30 ++++++++++++++++-------------- backup.sh | 26 ++++++++++++++++++++++---- 3 files changed, 39 insertions(+), 19 deletions(-) diff --git a/Dockerfile b/Dockerfile index 57db04c..7bce58c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -11,7 +11,7 @@ RUN apk add --no-cache \ ENV DB_FILE /data/db.sqlite3 ENV BACKUP_FILE /data/db_backup/backup.sqlite3 -ENV ATTACHMENT_BACKUP_FILE=/data/attachments_backup/attachments +#ENV ATTACHMENT_BACKUP_FILE=/data/attachments_backup/attachments ENV ATTACHMENT_DIR=/data/attachments ENV BACKUP_FILE_PERMISSIONS 700 ENV CRON_TIME "0 5 * * *" diff --git a/README.md b/README.md index 4ba8763..58c95c6 100644 --- a/README.md +++ b/README.md @@ -46,19 +46,21 @@ docker run --rm --volumes-from=bitwarden -e UID=0 -e BACKUP_FILE=/myBackup/backu ``` ## Environment variables -| ENV | Description | -| ----------------------- | ------------------------------------------------------------------------ | -| DB_FILE | Path to the Bitwarden sqlite3 database *inside* the container | -| BACKUP_FILE | Path to the desired backup location *inside* the container | -| BACKUP_FILE_PERMISSIONS | Sets the permissions of the backup file (**CAUTION** [^1]) | -| CRON_TIME | Cronjob format "Minute Hour Day_of_month Month_of_year Day_of_week Year" | -| TIMESTAMP | Set to `true` to append timestamp to the `BACKUP_FILE` | -| UID | User ID to run the cron job with | -| GID | Group ID to run the cron job with | -| LOGFILE | Path to the logfile *inside* the container | -| CRONFILE | Path to the cron file *inside* the container | -| DELETE_AFTER | Delete old backups after X many days | -| TZ | Set the timezone inside the container [^2] +| ENV | Description | +| ----------------------- | -------------------------------------------------------------------------------------- | +| DB_FILE | Path to the Bitwarden sqlite3 database *inside* the container | +| BACKUP_FILE | Path to the desired backup location *inside* the container | +| BACKUP_FILE_PERMISSIONS | Sets the permissions of the backup file (**CAUTION** [^1]) | +| CRON_TIME | Cronjob format "Minute Hour Day_of_month Month_of_year Day_of_week Year" | +| TIMESTAMP | Set to `true` to append timestamp to the `BACKUP_FILE` | +| UID | User ID to run the cron job with | +| GID | Group ID to run the cron job with | +| LOGFILE | Path to the logfile *inside* the container | +| CRONFILE | Path to the cron file *inside* the container | +| DELETE_AFTER | Delete old backups after X many days | +| TZ | Set the timezone inside the container [^2] | +| ATTACHMENT_BACKUP_FILE | If present, the directory `ATTACHMENT_DIR` are backup in path `ATTACHMENT_BACKUP_FILE` | +| ATTACHMENT_DIR | Path to the Bitwarden attachement file *inside* the container | [^1]: The permissions should at least be 700 since the backup folder itself gets the same permissions and with 600 it would not be accessible. [^2]: see for more information @@ -75,4 +77,4 @@ If you need timestamps in your local timezone you should mount `/etc/timezone:/e like it's done in the [docker-compose.yml](docker-compose.yml). An other possible solution is to set the environment variable accordingly (like `TZ=Europe/Berlin`) (see for more information). -**Attention** if you are on an ARM based platform please note that [alpine](https://alpinelinux.org/) is used as base image for this project to keep things small. Since alpine 3.13 and above it's possible that you will end up with a container with broken time and date settings (i.e. year 1900). This is a known problem in the alpine project (see [Github issue](https://github.com/alpinelinux/docker-alpine/issues/141) and [solution](https://wiki.alpinelinux.org/wiki/Release_Notes_for_Alpine_3.13.0#time64_requirements)) and there is nothing I can do about it. However in the [alpine wiki](https://wiki.alpinelinux.org/wiki/Release_Notes_for_Alpine_3.13.0#time64_requirements) a solution is being proposed which I also tested tested on my raspberry pi. After following the described process it started working again as expected. If you still experience issues or could for some reason not apply the aforementioned fixes please feel free to open an issue. \ No newline at end of file +**Attention** if you are on an ARM based platform please note that [alpine](https://alpinelinux.org/) is used as base image for this project to keep things small. Since alpine 3.13 and above it's possible that you will end up with a container with broken time and date settings (i.e. year 1900). This is a known problem in the alpine project (see [Github issue](https://github.com/alpinelinux/docker-alpine/issues/141) and [solution](https://wiki.alpinelinux.org/wiki/Release_Notes_for_Alpine_3.13.0#time64_requirements)) and there is nothing I can do about it. However in the [alpine wiki](https://wiki.alpinelinux.org/wiki/Release_Notes_for_Alpine_3.13.0#time64_requirements) a solution is being proposed which I also tested tested on my raspberry pi. After following the described process it started working again as expected. If you still experience issues or could for some reason not apply the aforementioned fixes please feel free to open an issue. diff --git a/backup.sh b/backup.sh index cd65391..f192f88 100644 --- a/backup.sh +++ b/backup.sh @@ -7,13 +7,23 @@ then exit 1; fi + +# Chef if ATTACHMENT_BACKUP_FILE exist. If it's true, attechment are backup. We define var with or without TIMESTAMP +# In anycase, we define var LOCALVAR_ATTACHMENT_BACKUP_FILE to limit the complexity of code (the number of if-else) +LOCALVAR_ATTACHMENT_BACKUP_FILE = "" +if [ -v ATTACHMENT_BACKUP_FILE ] +then + LOCALVAR_ATTACHMENT_BACKUP_FILE = ${ATTACHMENT_BACKUP_FILE} +fi + + if [ $TIMESTAMP = true ] then FINAL_BACKUP_FILE="$(echo "$BACKUP_FILE")_$(date "+%F-%H%M%S")" - FINAL_BACKUP_ATTACHMENT="$(echo "$ATTACHMENT_BACKUP_FILE")_$(date "+%F-%H%M%S")" + FINAL_BACKUP_ATTACHMENT="$(echo "$LOCALVAR_ATTACHMENT_BACKUP_FILE")_$(date "+%F-%H%M%S")" else FINAL_BACKUP_FILE=$BACKUP_FILE - FINAL_BACKUP_ATTACHMENT=$ATTACHMENT_BACKUP_FILE + FINAL_BACKUP_ATTACHMENT=$LOCALVAR_ATTACHMENT_BACKUP_FILE fi @@ -25,10 +35,18 @@ else echo "$(date "+%F %T") - Backup unsuccessfull" fi -/bin/tar -cvzf ${FINAL_BACKUP_ATTACHMENT}.tgz ${ATTACHMENT_DIR} + +if [ -v ATTACHMENT_BACKUP_FILE ] +then + /bin/tar -cvzf ${FINAL_BACKUP_ATTACHMENT}.tgz ${ATTACHMENT_DIR} +fi if [ ! -z $DELETE_AFTER ] && [ $DELETE_AFTER -gt 0 ] then find $(dirname "$BACKUP_FILE") -name "$(basename "$BACKUP_FILE")*" -type f -mtime +$DELETE_AFTER -exec rm -f {} \; -exec echo "Deleted {} after $DELETE_AFTER days" \; - find $(dirname "$ATTACHMENT_BACKUP_FILE") -name "$(basename "$ATTACHMENT_BACKUP_FILE")*" -type f -mtime +$DELETE_AFTER -exec rm -f {} \; -exec echo "Deleted {} after $DELETE_AFTER days" \; + + if [ -v ATTACHMENT_BACKUP_FILE ] + then + find $(dirname "$FINAL_BACKUP_ATTACHMENT") -name "$(basename "$FINAL_BACKUP_ATTACHMENT")*" -type f -mtime +$DELETE_AFTER -exec rm -f {} \; -exec echo "Deleted {} after $DELETE_AFTER days" \; + fi fi