Merge branch '17-suggestion-backup-attachements' into 'dev'

Update Dockerfile, entrypoint.sh, backup.sh files

See merge request 1O/bitwarden_rs-backup!6

.github/workflows/lockdown.yml

@@ -0,0 +1,34 @@
+name: 'Lock down repository'
+
+on:
+  issues:
+    types: opened
+  pull_request:
+    types: opened
+
+jobs:
+  lockdown:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/repo-lockdown@v2
+        with:
+          github-token: ${{ github.token }}
+          issue-labels: 'off-topic'
+          issue-comment: >
+            Thanks for your contribution!
+            
+            However, this repository does not accept bug reports,
+            since this is only a mirror of
+            https://gitlab.com/1O/bitwarden_rs-backup.
+
+            Please feel free to open the issue there.
+          skip-closed-issue-comment: true
+          pr-comment: >
+            Thanks for your contribution!
+          
+            However, this repository does not accept pull requests,
+            since this is only a mirror of
+            https://gitlab.com/1O/bitwarden_rs-backup.
+
+            Please feel free to open the pull request there.
+          skip-closed-pr-comment: true

Dockerfile

@@ -11,6 +11,8 @@ 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_DIR=/data/attachments
 ENV BACKUP_FILE_PERMISSIONS 700
 ENV CRON_TIME "0 5 * * *"
 ENV TIMESTAMP false

README.md

@@ -46,19 +46,21 @@ docker run --rm --volumes-from=bitwarden -e UID=0 -e BACKUP_FILE=/myBackup/backu
 ```
 
 ## Environment variables
-| ENV                     | Description                                                              |
+| ENV                     | Description                                                                            |
-| ----------------------- | ------------------------------------------------------------------------ |
+| ----------------------- | -------------------------------------------------------------------------------------- |
-| DB_FILE                 | Path to the Bitwarden sqlite3 database *inside* the container            |
+| DB_FILE                 | Path to the Bitwarden sqlite3 database *inside* the container                          |
-| BACKUP_FILE             | Path to the desired backup location *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])               |
+| 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" |
+| 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`                   |
+| TIMESTAMP               | Set to `true` to append timestamp to the `BACKUP_FILE`                                 |
-| UID                     | User ID to run the cron job with                                         |
+| UID                     | User ID to run the cron job with                                                       |
-| GID                     | Group ID to run the cron job with                                        |
+| GID                     | Group ID to run the cron job with                                                      |
-| LOGFILE                 | Path to the logfile *inside* the container                               |
+| LOGFILE                 | Path to the logfile *inside* the container                                             |
-| CRONFILE                | Path to the cron file *inside* the container                             |
+| CRONFILE                | Path to the cron file *inside* the container                                           |
-| DELETE_AFTER            | Delete old backups after X many days                                     |
+| DELETE_AFTER            | Delete old backups after X many days                                                   |
-| TZ                      | Set the timezone inside the container [^2] 
+| 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 <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones> 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 <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones> 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.
+**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.

backup.sh

@@ -7,13 +7,26 @@ then
   exit 1;
 fi
 
+
+# Check 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)
+if [ ! -z $ATTACHMENT_BACKUP_FILE ]
+then
+  LOCALVAR_ATTACHMENT_BACKUP_FILE="$ATTACHMENT_BACKUP_FILE"
+else
+  LOCALVAR_ATTACHMENT_BACKUP_FILE=""
+fi
+
 if [ $TIMESTAMP = true ]
 then
   FINAL_BACKUP_FILE="$(echo "$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=$LOCALVAR_ATTACHMENT_BACKUP_FILE
 fi
 
+
 /usr/bin/sqlite3 $DB_FILE ".backup $FINAL_BACKUP_FILE"
 if [ $? -eq 0 ]
 then 
@@ -22,7 +35,19 @@ else
   echo "$(date "+%F %T") - Backup unsuccessfull"
 fi
 
+
+if [ ! -z $ATTACHMENT_BACKUP_FILE ]
+then
+  echo "Create tar ${FINAL_BACKUP_ATTACHMENT}.tgz\n"
+  /bin/tar -czf ${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" \;
+
+  if [ ! -z $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

entrypoint.sh

@@ -15,9 +15,16 @@ then
   install -o $UID -g $GID -m $BACKUP_FILE_PERMISSIONS -d $BACKUP_DIR
 fi
 
+ATTACHMENT_BACKUP_DIR=$(dirname "$ATTACHMENT_BACKUP_FILE")
+if [ ! -d "$ATTACHMENT_BACKUP_DIR" ]
+then
+   echo "$ATTACHMENT_BACKUP_DIR not exists. Creating it with owner $UID:$GID and permissions $BACKUP_FILE_PERMISSIONS."
+   install -o $UID -g $GID -m $BACKUP_FILE_PERMISSIONS -d $ATTACHMENT_BACKUP_DIR 
+fi
+
 # For compatibility reasons
 if [ "$1" = "/backup.sh" ]; then
-  >&2 echo "Using /backup.sh is deprecated and will be removed in future versions! Please use \`manual\` as arugment instead"
+  >&2 echo "Using /backup.sh is deprecated and will be removed in future versions! Please use \`manual\` as argument instead"
   $BACKUP_CMD
 fi