initial release

README.md

@@ -0,0 +1,52 @@
+# mariadb backup via rclone
+
+## usage
+
+Sample `docker-compose.yaml` file:
+
+```yaml
+services:
+  db:
+    image: mariadb:11
+    restart: always
+    volumes:
+      - ./data:/var/lib/mysql
+    environment:
+      MARIADB_ROOT_PASSWORD: 1StrongPassword
+      MARIADB_DATABASE: my-db
+    ports:
+      - 3306:3306
+    healthcheck:
+      test: [ "CMD", "healthcheck.sh", "--connect", "--innodb_initialized" ]
+      start_period: 1m
+      start_interval: 10s
+      interval: 1m
+      timeout: 5s
+      retries: 3
+  backup:
+    image: docker.asperti.com/paspo/mariadbbackup-rclone:latest
+    volumes:
+      - ./config:/config:ro
+    environment:
+      MARIADB_HOST: db
+      MARIADB_USER: root
+      MARIADB_PORT: 3306
+      MARIADB_PASSWORD: 1StrongPassword
+      MARIADB_DATABASE: my-db
+      CRONTAB: "15 */4 * * *"
+      COMPRESSION: gzip  # gzip | bzip2 | xz | zstd
+      RCLONE_REMOTE: myremote
+      RCLONE_PATH: /backups
+      RCLONE_CONFIG_FILE: /config/rclone.conf
+```
+
+Sample `rclone.conf` file:
+
+```conf
+[dest]
+type = smb
+host = 192.168.1.100
+user = myuser
+# mypassword
+pass = csWMBe2l6hhopqleKNGcojqVY9DKT5dPrYA
+```