update borgmatic

Author: dinhngocdung

borgmatic/.env

@@ -1,22 +1,15 @@
-TZ=Asia/Ho_Chi_Minh
-BORG_PASSPHRASE="YOUR-BORG-PASSPHRASE"
+BORGBASE_REPO_PATH=YOUR-REPO_URL                        # URL for your BorgBase repository
+BORG_PASSPHRASE="YOUR-BORG-PASSPHRASE"                  # Passphrase for the Borg repository
 
-VOLUME_EE_SOURCE=/opt/easyengine
-VOLUME_DOCKER_VOLUMES=/var/lib/docker/volumes
-VOLUME_BORGMATIC_CONFIG_SOURCE=./borgmatic
-VOLUME_FAIL2BAN_CONFIG_SOURCE=./fail2ban
-VOLUME_CRONTAB_SOURCE=/var/spool/cron
+# sudo docker compose -f /opt/easyengine/services/docker-compose.yml exec global-db bash -c 'echo $MYSQL_ROOT_PASSWORD'
+MYSQL_ROOT_PASSWORD=YOUR-MYSQL-ROOT-PASSWORD            # Root password for MySQL/MariaDB database backups
 
-VOLUME_RESTORE_DESTINATION=./restore
+VOLUME_EE_SOURCE=/opt/easyengine                        # Source path for EasyEngine data
+VOLUME_DOCKER_VOLUMES=/var/lib/docker/volumes           # Source path for Docker volumes
+VOLUME_BORGMATIC_CONFIG_SOURCE=./borgmatic              # Source path for Borgmatic configuration files
+VOLUME_FAIL2BAN_CONFIG_SOURCE=./fail2ban                # Source path for Fail2Ban configuration files
+VOLUME_CRONTAB_SOURCE=/var/spool/cron                   # Source path for crontab files
 
-VOLUME_EE_SOURCE=/opt/easyengine
-VOLUME_DOCKER_VOLUMES=/var/lib/docker/volumes
-VOLUME_BORGMATIC_CONFIG_SOURCE=/YOUR-PATH/borgmatic
-VOLUME_FAIL2BAN_CONFIG_SOURCE=/YOUR-PATH/fail2ban
-VOLUME_CRONTAB_SOURCE=/var/spool/cron
+VOLUME_RESTORE_DESTINATION=./restore                    # Destination path for restoring backups
 
-BORGBASE_REPO_PATH=YOUR-REPO_URL
-HOST_NAME=YOUR-HOST-NAME
-
-# cd /opt/easyengine/services && sudo docker compose exec global-db bash -c 'echo $MYSQL_ROOT_PASSWORD'
-MYSQL_ROOT_PASSWORD=YOUR-MYSQL-ROOT-PASSWORD
+TZ=Asia/Ho_Chi_Minh                                     # Timezone for the container

borgmatic/data/borgmatic.d/config.yaml

@@ -1,4 +1,4 @@
-## Config for ${HOST_NAME}
+## Config for ${HOSTNAME}
 
 source_directories:
   - /mnt/source/easyengine
@@ -9,14 +9,14 @@ source_directories:
 
 repositories:
   - path: ${BORGBASE_REPO_PATH}
-    label: "${HOST_NAME} on BorgBase"
+    label: "${HOSTNAME} on BorgBase"
 
 exclude_patterns:
   - '*.pyc'
   - ~/*/.cache
 
 compression: auto,zstd
-archive_name_format: '${HOST_NAME}-{now:%Y-%m-%d-%H%M%S}'
+archive_name_format: '${HOSTNAME}-{now:%Y-%m-%d-%H%M%S}'
 
 retries: 5
 retry_wait: 5
@@ -40,26 +40,26 @@ commands:
   - before: action
     when: [create]
     run:
-      - 'echo "Borgmatic: Starting backup for ${HOST_NAME}..."'
+      - 'echo "Borgmatic: Starting backup for ${HOSTNAME}..."'
   - after: action
     when: [create]
     states: [finish]
     run:
-      - 'echo "Borgmatic: Backup for ${HOST_NAME} completed successfully!"'
+      - 'echo "Borgmatic: Backup for ${HOSTNAME} completed successfully!"'
 
   - before: action
     when: [check]
     run:
-      - 'echo "Borgmatic: Starting consistency checks for ${HOST_NAME}..."'
+      - 'echo "Borgmatic: Starting consistency checks for ${HOSTNAME}..."'
   - after: action
     when: [check]
     states: [finish]
     run:
-      - 'echo "Borgmatic: Consistency checks for ${HOST_NAME} completed successfully!"'
+      - 'echo "Borgmatic: Consistency checks for ${HOSTNAME} completed successfully!"'
 
   - after: error
     run:
-      - 'echo "Borgmatic: An error occurred during an operation for ${HOST_NAME}. Please check logs."'
+      - 'echo "Borgmatic: An error occurred during an operation for ${HOSTNAME}. Please check logs."'
 
 mariadb_databases:
   - name: all

borgmatic/docker-compose.yml

@@ -3,33 +3,29 @@ services:
     image: ghcr.io/borgmatic-collective/borgmatic
     container_name: borgmatic
     volumes:
-      # Sao lưu các thư mục EasyEngine và Docker
-      - ${VOLUME_EE_SOURCE}:/mnt/source/easyengine:ro
-      - ${VOLUME_DOCKER_VOLUMES}:/mnt/source/volumes:ro
-      - ${VOLUME_BORGMATIC_CONFIG_SOURCE}:/mnt/source/borgmatic:ro
-      - ${VOLUME_FAIL2BAN_CONFIG_SOURCE}:/mnt/source/fail2ban:ro
-      - ${VOLUME_CRONTAB_SOURCE}:/mnt/source/crontab:ro
-      # Thư mục khôi phục
-      - ${VOLUME_RESTORE_DESTINATION}:/restore
-      # Các thư mục quản lý Borg
-      - ${VOLUME_BORG_REPOSITORY}:/mnt/borg-repository
-      - ${VOLUME_ETC_BORGMATIC}:/etc/borgmatic.d/
-      - ${VOLUME_BORG_CONFIG}:/root/.config/borg
-      - ${VOLUME_SSH}:/root/.ssh
-      - ${VOLUME_BORG_CACHE}:/root/.cache/borg
-      # Đồng bộ múi giờ
-      - /etc/localtime:/etc/localtime:ro
-      - /etc/timezone:/etc/timezone:ro
+      - ${VOLUME_EE_SOURCE}:/mnt/source/easyengine:ro              # Backup EasyEngine directories
+      - ${VOLUME_DOCKER_VOLUMES}:/mnt/source/volumes:ro            # Backup Docker volumes
+      - ${VOLUME_BORGMATIC_CONFIG_SOURCE}:/mnt/source/borgmatic:ro # Backup Borgmatic config
+      - ${VOLUME_FAIL2BAN_CONFIG_SOURCE}:/mnt/source/fail2ban:ro   # Backup Fail2Ban config
+      - ${VOLUME_CRONTAB_SOURCE}:/mnt/source/crontab:ro            # Backup Crontab files
+      - ${VOLUME_RESTORE_DESTINATION}:/restore                     # Restore destination directory
+      - ${VOLUME_BORG_REPOSITORY}:/mnt/borg-repository             # Borg repository management
+      - ${VOLUME_ETC_BORGMATIC}:/etc/borgmatic.d/                  # Borgmatic configuration directory
+      - ${VOLUME_BORG_CONFIG}:/root/.config/borg                   # Borg client configuration
+      - ${VOLUME_SSH}:/root/.ssh                                   # SSH keys for remote access
+      - ${VOLUME_BORG_CACHE}:/root/.cache/borg                     # Borg cache directory
+      - /etc/localtime:/etc/localtime:ro                           # Sync timezone
+      - /etc/timezone:/etc/timezone:ro                             # Sync timezone
     environment:
-      - TZ=${TZ}
-      - BORG_PASSPHRASE=${BORG_PASSPHRASE}
-      - HOST_NAME=${HOST_NAME}
-      - BORGBASE_REPO_PATH=${BORGBASE_REPO_PATH}
-      - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
+      - TZ=${TZ}                                                   # Set timezone
+      - BORG_PASSPHRASE=${BORG_PASSPHRASE}                         # Borg repository passphrase
+      - HOSTNAME=${HOSTNAME}                                       # Get Hostname of host
+      - BORGBASE_REPO_PATH=${BORGBASE_REPO_PATH}                   # Path to BorgBase repository
+      - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}                 # MariaDB root password for backups
     networks:
       global-backend-network:
 
 networks:
   global-backend-network:
-    external: true
-    name: ee-global-backend-network
+    external: true                                                 # Connects to EasyEngine's backend network
+    name: ee-global-backend-network                                # Name of the external network for EasyEngine services