WIP: feat(global): add support for built-in rclone-based backups

Dockerfile

@@ -1,18 +1,19 @@
 ##################  RUNTIME IMAGE  ###################
 # Create using wellbuilt vaultwarden Docker image as the base image
-# Modify vaultwarden-startup to suit in your PaaS service you are using to deploy this
+# Modify scripts/vaultwarden-startup to suit in your PaaS service you are building
+# this image from source.
 FROM vaultwarden/server:alpine
 
-COPY vaultwarden-startup /usr/bin/vaultwarden-startup
+COPY scripts/ /usr/local/bin/
 
-ENV PORT 3000
+ENV PORT=3000 TZ=UTC
 EXPOSE 3000
 
-## because vaultwarden-startup requires bash, so we install that
-RUN apk add bash coreutils \
-    # Just in case we're still calling the old stuff
-    && ln -s /usr/bin/vaultwarden-startup /usr/bin/bwrs-startup
+RUN apk add --no-cache \
+    # Because the entrypoint script and the backup script itself need rclone and bash,
+    # we'll install them through apk
+    heirloom-mailx p7zip sqlite supercronic tzdata bash coreutils rclone npm \
+  && npm i -g concurrently
 
 WORKDIR /
-ENTRYPOINT ["usr/bin/dumb-init", "--"]
-CMD ["/usr/bin/vaultwarden-startup"]
+ENTRYPOINT ["/usr/local/bin/image-entrypoint"]

scripts/backup-chores.sh

@@ -0,0 +1,195 @@
+#!/bin/bash
+
+. /app/includes.sh
+
+function clear_dir() {
+    rm -rf "${BACKUP_DIR}"
+}
+
+function backup_init() {
+    NOW="$(date +"${BACKUP_FILE_DATE_FORMAT}")"
+    # backup vaultwarden database file
+    BACKUP_FILE_DB="${BACKUP_DIR}/db.${NOW}.sqlite3"
+    # backup vaultwarden config file
+    BACKUP_FILE_CONFIG="${BACKUP_DIR}/config.${NOW}.json"
+    # backup vaultwarden rsakey files
+    BACKUP_FILE_RSAKEY="${BACKUP_DIR}/rsakey.${NOW}.tar"
+    # backup vaultwarden attachments directory
+    BACKUP_FILE_ATTACHMENTS="${BACKUP_DIR}/attachments.${NOW}.tar"
+    # backup vaultwarden sends directory
+    BACKUP_FILE_SENDS="${BACKUP_DIR}/sends.${NOW}.tar"
+    # backup zip file
+    BACKUP_FILE_ZIP="${BACKUP_DIR}/backup.${NOW}.${ZIP_TYPE}"
+}
+
+function backup_db() {
+    color blue "backup vaultwarden sqlite database"
+
+    if [[ -f "${DATA_DB}" ]]; then
+        sqlite3 "${DATA_DB}" ".backup '${BACKUP_FILE_DB}'"
+    else
+        color yellow "not found vaultwarden sqlite database, skipping"
+    fi
+}
+
+function backup_config() {
+    color blue "backup vaultwarden config"
+
+    if [[ -f "${DATA_CONFIG}" ]]; then
+        cp -f "${DATA_CONFIG}" "${BACKUP_FILE_CONFIG}"
+    else
+        color yellow "not found vaultwarden config, skipping"
+    fi
+}
+
+function backup_rsakey() {
+    color blue "backup vaultwarden rsakey"
+
+    local FIND_RSAKEY=$(find "${DATA_RSAKEY_DIRNAME}" -name "${DATA_RSAKEY_BASENAME}*" | xargs -I {} basename {})
+    local FIND_RSAKEY_COUNT=$(echo "${FIND_RSAKEY}" | wc -l)
+
+    if [[ "${FIND_RSAKEY_COUNT}" -gt 0 ]]; then
+        echo "${FIND_RSAKEY}" | tar -c -C "${DATA_RSAKEY_DIRNAME}" -f "${BACKUP_FILE_RSAKEY}" -T -
+
+        color blue "display rsakey tar file list"
+
+        tar -tf "${BACKUP_FILE_RSAKEY}"
+    else
+        color yellow "not found vaultwarden rsakey, skipping"
+    fi
+}
+
+function backup_attachments() {
+    color blue "backup vaultwarden attachments"
+
+    if [[ -d "${DATA_ATTACHMENTS}" ]]; then
+        tar -c -C "${DATA_ATTACHMENTS_DIRNAME}" -f "${BACKUP_FILE_ATTACHMENTS}" "${DATA_ATTACHMENTS_BASENAME}"
+
+        color blue "display attachments tar file list"
+
+        tar -tf "${BACKUP_FILE_ATTACHMENTS}"
+    else
+        color yellow "not found vaultwarden attachments directory, skipping"
+    fi
+}
+
+function backup_sends() {
+    color blue "backup vaultwarden sends"
+
+    if [[ -d "${DATA_SENDS}" ]]; then
+        tar -c -C "${DATA_SENDS_DIRNAME}" -f "${BACKUP_FILE_SENDS}" "${DATA_SENDS_BASENAME}"
+
+        color blue "display sends tar file list"
+
+        tar -tf "${BACKUP_FILE_SENDS}"
+    else
+        color yellow "not found vaultwarden sends directory, skipping"
+    fi
+}
+
+function backup() {
+    mkdir -p "${BACKUP_DIR}"
+
+    backup_db
+    backup_config
+    backup_rsakey
+    backup_attachments
+    backup_sends
+
+    ls -lah "${BACKUP_DIR}"
+}
+
+function backup_package() {
+    if [[ "${ZIP_ENABLE}" == "TRUE" ]]; then
+        color blue "package backup file"
+
+        UPLOAD_FILE="${BACKUP_FILE_ZIP}"
+
+        if [[ "${ZIP_TYPE}" == "zip" ]]; then
+            7z a -tzip -mx=9 -p"${ZIP_PASSWORD}" "${BACKUP_FILE_ZIP}" "${BACKUP_DIR}"/*
+        else
+            7z a -t7z -m0=lzma2 -mx=9 -mfb=64 -md=32m -ms=on -mhe=on -p"${ZIP_PASSWORD}" "${BACKUP_FILE_ZIP}" "${BACKUP_DIR}"/*
+        fi
+
+        ls -lah "${BACKUP_DIR}"
+
+        color blue "display backup ${ZIP_TYPE} file list"
+
+        7z l -p"${ZIP_PASSWORD}" "${BACKUP_FILE_ZIP}"
+    else
+        color yellow "skip package backup files"
+
+        UPLOAD_FILE="${BACKUP_DIR}"
+    fi
+}
+
+function upload() {
+    # upload file not exist
+    if [[ ! -e "${UPLOAD_FILE}" ]]; then
+        color red "upload file not found"
+
+        send_mail_content "FALSE" "File upload failed at $(date +"%Y-%m-%d %H:%M:%S %Z"). Reason: Upload file not found."
+
+        exit 1
+    fi
+
+    # upload
+    local HAS_ERROR="FALSE"
+
+    for RCLONE_REMOTE_X in "${RCLONE_REMOTE_LIST[@]}"
+    do
+        color blue "upload backup file to storage system $(color yellow "[${RCLONE_REMOTE_X}]")"
+
+        rclone ${RCLONE_GLOBAL_FLAG} copy "${UPLOAD_FILE}" "${RCLONE_REMOTE_X}"
+        if [[ $? != 0 ]]; then
+            color red "upload failed"
+
+            HAS_ERROR="TRUE"
+        fi
+    done
+
+    if [[ "${HAS_ERROR}" == "TRUE" ]]; then
+        send_mail_content "FALSE" "File upload failed at $(date +"%Y-%m-%d %H:%M:%S %Z")."
+
+        exit 1
+    fi
+}
+
+function clear_history() {
+    if [[ "${BACKUP_KEEP_DAYS}" -gt 0 ]]; then
+        for RCLONE_REMOTE_X in "${RCLONE_REMOTE_LIST[@]}"
+        do
+            color blue "delete ${BACKUP_KEEP_DAYS} days ago backup files $(color yellow "[${RCLONE_REMOTE_X}]")"
+
+            mapfile -t RCLONE_DELETE_LIST < <(rclone ${RCLONE_GLOBAL_FLAG} lsf "${RCLONE_REMOTE_X}" --min-age "${BACKUP_KEEP_DAYS}d")
+
+            for RCLONE_DELETE_FILE in "${RCLONE_DELETE_LIST[@]}"
+            do
+                color yellow "deleting \"${RCLONE_DELETE_FILE}\""
+
+                rclone ${RCLONE_GLOBAL_FLAG} delete "${RCLONE_REMOTE_X}/${RCLONE_DELETE_FILE}"
+                if [[ $? != 0 ]]; then
+                    color red "delete \"${RCLONE_DELETE_FILE}\" failed"
+                fi
+            done
+        done
+    fi
+}
+
+color blue "running the backup program at $(date +"%Y-%m-%d %H:%M:%S %Z")"
+
+init_env
+check_rclone_connection
+
+clear_dir
+backup_init
+backup
+backup_package
+upload
+clear_dir
+clear_history
+
+send_mail_content "TRUE" "The file was successfully uploaded at $(date +"%Y-%m-%d %H:%M:%S %Z")."
+send_ping
+
+color none ""