Merge pull request #64 from jkaninda/develop

docs: update readme

Makefile

@@ -1,4 +1,6 @@
 BINARY_NAME=mysql-bkup
+IMAGE_NAME=jkaninda/mysql-bkup
+
 include .env
 export
 run:
@@ -16,31 +18,31 @@ compile:
 docker-build:
 	docker build -f docker/Dockerfile  -t jkaninda/mysql-bkup:latest .
 
-docker-run: docker-build
+docker-run: #docker-build
-	docker run --rm --network web --name mysql-bkup -v "./backup:/backup" -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" jkaninda/mysql-bkup bkup backup --prune --keep-last 2
+	docker run --rm --network web --name mysql-bkup -v "./backup:/backup" -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" ${IMAGE_NAME} backup --prune --keep-last 2
 docker-restore: docker-build
-	docker run --rm --network web --name mysql-bkup -v "./backup:/backup" -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}"  -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" jkaninda/mysql-bkup  bkup restore -f ${FILE_NAME}
+	docker run --rm --network web --name mysql-bkup -v "./backup:/backup" -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}"  -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" ${IMAGE_NAME} restore -f ${FILE_NAME}
 
 
-docker-run-scheduled: docker-build
+docker-run-scheduled: #docker-build
-	docker run --rm --network web --name mysql-bkup -v "./backup:/backup" -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" jkaninda/mysql-bkup  bkup backup --mode scheduled --period "* * * * *"
+	docker run --rm --network web --name mysql-bkup -v "./backup:/backup" -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" ${IMAGE_NAME} backup --mode scheduled --period "* * * * *"
 
 
 docker-run-scheduled-s3: docker-build
-	docker run --rm --network web --name mysql-bkup -v "./backup:/backup" -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "ACCESS_KEY=${ACCESS_KEY}" -e "SECRET_KEY=${SECRET_KEY}" -e "BUCKET_NAME=${BUCKET_NAME}" -e "S3_ENDPOINT=${AWS_S3_ENDPOINT}" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" jkaninda/mysql-bkup  bkup backup --storage s3 --mode scheduled --path /custom-path --period "* * * * *"
+	docker run --rm --network web --name mysql-bkup -v "./backup:/backup" -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "ACCESS_KEY=${ACCESS_KEY}" -e "SECRET_KEY=${SECRET_KEY}" -e "BUCKET_NAME=${BUCKET_NAME}" -e "S3_ENDPOINT=${AWS_S3_ENDPOINT}" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" ${IMAGE_NAME} backup --storage s3 --mode scheduled --path /custom-path --period "* * * * *"
 
 docker-run-s3: docker-build
-	docker run --rm --network web --name mysql-bkup -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "ACCESS_KEY=${ACCESS_KEY}" -e "SECRET_KEY=${SECRET_KEY}" -e "AWS_S3_BUCKET_NAME=${AWS_S3_BUCKET_NAME}" -e "AWS_S3_ENDPOINT=${AWS_S3_ENDPOINT}" -e "AWS_REGION=eu2" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" jkaninda/mysql-bkup  bkup backup --storage s3  --path /custom-path
+	docker run --rm --network web --name mysql-bkup -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "ACCESS_KEY=${ACCESS_KEY}" -e "SECRET_KEY=${SECRET_KEY}" -e "AWS_S3_BUCKET_NAME=${AWS_S3_BUCKET_NAME}" -e "AWS_S3_ENDPOINT=${AWS_S3_ENDPOINT}" -e "AWS_REGION=eu2" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" ${IMAGE_NAME} backup --storage s3  --path /custom-path
 
 
 docker-restore-s3: docker-build
-	docker run --rm --network web --name mysql-bkup -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "ACCESS_KEY=${ACCESS_KEY}" -e "SECRET_KEY=${SECRET_KEY}" -e "BUCKET_NAME=${AWS_S3_BUCKET_NAME}" -e "S3_ENDPOINT=${AWS_S3_ENDPOINT}" -e "AWS_REGION=eu2" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" jkaninda/mysql-bkup  bkup restore --storage s3 -f ${FILE_NAME} --path /custom-path
+	docker run --rm --network web --name mysql-bkup -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "ACCESS_KEY=${ACCESS_KEY}" -e "SECRET_KEY=${SECRET_KEY}" -e "BUCKET_NAME=${AWS_S3_BUCKET_NAME}" -e "S3_ENDPOINT=${AWS_S3_ENDPOINT}" -e "AWS_REGION=eu2" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" ${IMAGE_NAME} restore --storage s3 -f ${FILE_NAME} --path /custom-path
 
 docker-run-ssh: docker-build
-	docker run --rm --network web --name mysql-bkup -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "SSH_USER=${SSH_USER}" -e "SSH_HOST_NAME=${SSH_HOST_NAME}" -e "SSH_REMOTE_PATH=${SSH_REMOTE_PATH}" -e "SSH_PASSWORD=${SSH_PASSWORD}" -e "SSH_PORT=${SSH_PORT}" -e "SSH_IDENTIFY_FILE=${SSH_IDENTIFY_FILE}" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" jkaninda/mysql-bkup  bkup backup --storage ssh
+	docker run --rm --network web --name mysql-bkup -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "SSH_USER=${SSH_USER}" -e "SSH_HOST_NAME=${SSH_HOST_NAME}" -e "SSH_REMOTE_PATH=${SSH_REMOTE_PATH}" -e "SSH_PASSWORD=${SSH_PASSWORD}" -e "SSH_PORT=${SSH_PORT}" -e "SSH_IDENTIFY_FILE=${SSH_IDENTIFY_FILE}" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" ${IMAGE_NAME} backup --storage ssh
 
 docker-restore-ssh: docker-build
-	docker run --rm --network web --name mysql-bkup  -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "SSH_USER=${SSH_USER}" -e "SSH_HOST_NAME=${SSH_HOST_NAME}" -e "SSH_REMOTE_PATH=${SSH_REMOTE_PATH}" -e "SSH_PASSWORD=${SSH_PASSWORD}" -e "SSH_PORT=${SSH_PORT}" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" -e "SSH_IDENTIFY_FILE=${SSH_IDENTIFY_FILE}" jkaninda/mysql-bkup  bkup restore --storage ssh -f ${FILE_NAME}
+	docker run --rm --network web --name mysql-bkup  -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "SSH_USER=${SSH_USER}" -e "SSH_HOST_NAME=${SSH_HOST_NAME}" -e "SSH_REMOTE_PATH=${SSH_REMOTE_PATH}" -e "SSH_PASSWORD=${SSH_PASSWORD}" -e "SSH_PORT=${SSH_PORT}" -e "GPG_PASSPHRASE=${GPG_PASSPHRASE}" -e "SSH_IDENTIFY_FILE=${SSH_IDENTIFY_FILE}" ${IMAGE_NAME} restore --storage ssh -f ${FILE_NAME}
 
 run-docs:
 	cd docs && bundle exec jekyll serve -H 0.0.0.0 -t

README.md

@@ -1,5 +1,5 @@
 # MySQL Backup
-mysql-bkup is a Docker container image that can be used to backup and restore Postgres database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH compatible storage.
+MySQL Backup is a Docker container image that can be used to backup and restore MySQL database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH compatible storage.
 It also supports __encrypting__ your backups using GPG.
 
 The [jkaninda/mysql-bkup](https://hub.docker.com/r/jkaninda/mysql-bkup) Docker image can be deployed on Docker, Docker Swarm and Kubernetes.
@@ -13,6 +13,7 @@ It also supports __encrypting__ your backups using GPG.
 ![Docker Pulls](https://img.shields.io/docker/pulls/jkaninda/mysql-bkup?style=flat-square)
 
 - Docker
+- Docker Swarm
 - Kubernetes
 
 ## Documentation is found at <https://jkaninda.github.io/mysql-bkup>
@@ -36,7 +37,7 @@ It also supports __encrypting__ your backups using GPG.
 
 ### Simple backup using Docker CLI
 
-To run a one time backup, bind your local volume to `/backup` in the container and run the `mysql-bkup backup` command:
+To run a one time backup, bind your local volume to `/backup` in the container and run the `backup` command:
 
 ```shell
  docker run --rm --network your_network_name \
@@ -44,7 +45,7 @@ To run a one time backup, bind your local volume to `/backup` in the container a
  -e "DB_HOST=dbhost" \
  -e "DB_USERNAME=username" \
  -e "DB_PASSWORD=password" \
- jkaninda/mysql-bkup  mysql-bkup backup -d database_name
+ jkaninda/mysql-bkup backup -d database_name
 ```
 
 Alternatively, pass a `--env-file` in order to use a full config as described below.
@@ -61,10 +62,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup
-      - /bin/sh
-      - -c
-      - mysql-bkup backup
     volumes:
       - ./backup:/backup
     environment:
@@ -98,6 +96,10 @@ spec:
         spec:
           containers:
           - name: mysql-bkup
+            # In production, it is advised to lock your image tag to a proper
+            # release version instead of using `latest`.
+            # Check https://github.com/jkaninda/mysql-bkup/releases
+            # for a list of available releases.
             image: jkaninda/mysql-bkup
             command:
             - /bin/sh
@@ -135,8 +137,8 @@ This Docker image is published to both Docker Hub and the GitHub container regis
 Depending on your preferences and needs, you can reference both `jkaninda/mysql-bkup` as well as `ghcr.io/jkaninda/mysql-bkup`:
 
 ```
-docker pull jkaninda/mysql-bkup:v1.0
+docker pull jkaninda/mysql-bkup
-docker pull ghcr.io/jkaninda/mysql-bkup:v1.0
+docker pull ghcr.io/jkaninda/mysql-bkup
 ```
 
 Documentation references Docker Hub, but all examples will work using ghcr.io just as well.

docker/Dockerfile

@@ -31,7 +31,7 @@ ENV SSH_HOST_NAME=""
 ENV SSH_IDENTIFY_FILE=""
 ENV SSH_PORT="22"
 ARG DEBIAN_FRONTEND=noninteractive
-ENV VERSION="v1.0"
+ENV VERSION="v1.2.1"
 ARG WORKDIR="/app"
 ARG BACKUPDIR="/backup"
 ARG BACKUP_TMP_DIR="/tmp/backup"
@@ -65,3 +65,4 @@ RUN ln -s /usr/local/bin/mysql-bkup /usr/local/bin/bkup
 ADD docker/supervisord.conf /etc/supervisor/supervisord.conf
 
 WORKDIR $WORKDIR
+ENTRYPOINT ["/usr/local/bin/mysql-bkup"]

docs/how-tos/backup-to-s3.md

@@ -22,10 +22,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup --storage s3 -d database --path /my-custom-path
-      - /bin/sh
-      - -c
-      - mysql-bkup backup --storage s3 -d database --path /my-custom-path
     environment:
       - DB_PORT=3306
       - DB_HOST=mysql
@@ -62,10 +59,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup --storage s3 -d my-database --mode scheduled --period "0 1 * * *"
-      - /bin/sh
-      - -c
-      - mysql-bkup backup --storage s3 -d my-database --mode scheduled --period "0 1 * * *"
     environment:
       - DB_PORT=3306
       - DB_HOST=mysql

docs/how-tos/backup-to-ssh.md

@@ -23,10 +23,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup --storage remote -d database
-      - /bin/sh
-      - -c
-      - mysql-bkup backup --storage remote -d database
     volumes:
       - ./id_ed25519:/tmp/id_ed25519"
     environment:
@@ -66,10 +63,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup -d database --storage ssh --mode scheduled --period "0 1 * * *"
-      - /bin/sh
-      - -c
-      - mysql-bkup backup -d database --storage ssh --mode scheduled --period "0 1 * * *"
     volumes:
       - ./id_ed25519:/tmp/id_ed25519"
     environment:

docs/how-tos/backup.md

@@ -7,7 +7,7 @@ nav_order: 1
 
 # Backup database
 
-To backup the database, you need to add `backup` subcommand to `mysql-bkup` or `bkup`.
+To backup the database, you need to add `backup` command.
 
 {: .note }
 The default storage is local storage mounted to __/backup__. The backup is compressed by default using gzip. The flag __`disable-compression`__ can be used when you need to disable backup compression.
@@ -27,10 +27,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup -d database
-      - /bin/sh
-      - -c
-      - mysql-bkup backup -d database
     volumes:
       - ./backup:/backup
     environment:
@@ -54,7 +51,7 @@ networks:
  -e "DB_HOST=dbhost" \
  -e "DB_USERNAME=username" \
  -e "DB_PASSWORD=password" \
- jkaninda/mysql-bkup  mysql-bkup backup -d database_name
+ jkaninda/mysql-bkup  backup -d database_name
 ```
 
 In case you need to use recurring backups, you can use `--mode scheduled` and specify the periodical backup time by adding `--period "0 1 * * *"` flag as described below.
@@ -68,10 +65,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup -d database --mode scheduled --period "0 1 * * *"
-      - /bin/sh
-      - -c
-      - mysql-bkup backup -d database --mode scheduled --period "0 1 * * *"
     volumes:
       - ./backup:/backup
     environment:

docs/how-tos/deploy-on-kubernetes.md

@@ -0,0 +1,240 @@
+---
+title: Deploy on Kubernetes
+layout: default
+parent: How Tos
+nav_order: 8
+---
+
+## Deploy on Kubernetes
+
+To deploy MySQL Backup on Kubernetes, you can use Job to backup or Restore your database.
+For recurring backup you can use CronJob, you don't need to run it in scheduled mode. as described bellow.
+
+## Backup Job
+
+```yaml
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: backup
+spec:
+  ttlSecondsAfterFinished: 100
+  template:
+    spec:
+      containers:
+      - name: mysql-bkup
+        # In production, it is advised to lock your image tag to a proper
+        # release version instead of using `latest`.
+        # Check https://github.com/jkaninda/mysql-bkup/releases
+        # for a list of available releases.
+        image: jkaninda/mysql-bkup
+        command:
+        - bkup
+        - backup
+        - --storage
+        - ssh
+        - --disable-compression
+        resources:
+          limits:
+            memory: "128Mi"
+            cpu: "500m"
+        env:
+          - name: DB_PORT
+            value: "3306"
+          - name: DB_HOST
+            value: ""
+          - name: DB_NAME
+            value: "dbname"
+          - name: DB_USERNAME
+            value: "username"
+          # Please use secret!
+          - name: DB_PASSWORD
+            value: ""
+          - name: SSH_HOST_NAME
+            value: "xxx"
+          - name: SSH_PORT
+            value: "22"
+          - name: SSH_USER
+            value: "xxx"
+          - name: SSH_PASSWORD
+            value: "xxxx"
+          - name: SSH_REMOTE_PATH
+            value: "/home/toto/backup"
+          # Optional, required if you want to encrypt your backup
+          - name: GPG_PASSPHRASE
+            value: "xxxx"
+      restartPolicy: Never
+```
+
+## Restore Job
+
+```yaml
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: restore-job
+spec:
+  ttlSecondsAfterFinished: 100
+  template:
+    spec:
+      containers:
+      - name: mysql-bkup
+        # In production, it is advised to lock your image tag to a proper
+        # release version instead of using `latest`.
+        # Check https://github.com/jkaninda/mysql-bkup/releases
+        # for a list of available releases.
+        image: jkaninda/mysql-bkup
+        command:
+        - bkup
+        - restore
+        - --storage
+        - ssh
+        - --file store_20231219_022941.sql.gz
+        resources:
+          limits:
+            memory: "128Mi"
+            cpu: "500m"
+        env:
+        - name: DB_PORT
+          value: "3306" 
+        - name: DB_HOST
+          value: ""
+        - name: DB_NAME
+          value: "dbname"
+        - name: DB_USERNAME
+          value: "username"
+        # Please use secret!
+        - name: DB_PASSWORD
+          value: ""
+        - name: SSH_HOST_NAME
+          value: "xxx"
+        - name: SSH_PORT
+          value: "22"
+        - name: SSH_USER
+          value: "xxx"
+        - name: SSH_PASSWORD
+          value: "xxxx"
+        - name: SSH_REMOTE_PATH
+          value: "/home/xxxx/backup"
+          # Optional, required if your backup was encrypted
+        #- name: GPG_PASSPHRASE
+        #  value: "xxxx"
+      restartPolicy: Never
+```
+
+## Recurring backup
+
+```yaml
+apiVersion: batch/v1
+kind: CronJob
+metadata:
+  name: backup-job
+spec:
+  schedule: "* * * * *"
+  jobTemplate:
+    spec:
+      template:
+        spec:
+          containers:
+          - name: mysql-bkup
+            image: jkaninda/mysql-bkup
+            command:
+            - bkup
+            - backup
+            - --storage
+            - ssh
+            - --disable-compression
+            resources:
+              limits:
+                memory: "128Mi"
+                cpu: "500m"
+            env:
+            - name: DB_PORT
+              value: "3306" 
+            - name: DB_HOST
+              value: ""
+            - name: DB_NAME
+              value: "username"
+            - name: DB_USERNAME
+              value: "username"
+            # Please use secret!
+            - name: DB_PASSWORD
+              value: ""
+            - name: SSH_HOST_NAME
+              value: "xxx"
+            - name: SSH_PORT
+              value: "xxx"
+            - name: SSH_USER
+              value: "jkaninda"
+            - name: SSH_REMOTE_PATH
+              value: "/home/jkaninda/backup"
+            - name: SSH_PASSWORD
+              value: "password"
+            # Optional, required if you want to encrypt your backup
+            #- name: GPG_PASSPHRASE
+            #  value: "xxx"
+          restartPolicy: Never
+```
+
+## Kubernetes Rootless
+    
+
+```yaml
+apiVersion: batch/v1
+kind: CronJob
+metadata:
+  name: backup-job
+spec:
+  schedule: "* * * * *"
+  jobTemplate:
+    spec:
+      template:
+        spec:
+          securityContext:
+            runAsUser: 1000
+            runAsGroup: 3000
+            fsGroup: 2000
+          containers:
+            # In production, it is advised to lock your image tag to a proper
+            # release version instead of using `latest`.
+            # Check https://github.com/jkaninda/mysql-bkup/releases
+            # for a list of available releases.
+            - name: mysql-bkup
+              image: jkaninda/mysql-bkup
+              command:
+                - bkup
+                - backup
+                - --storage
+                - ssh
+                - --disable-compression
+              resources:
+                limits:
+                  memory: "128Mi"
+                  cpu: "500m"
+              env:
+                - name: DB_PORT
+                  value: "3306"
+                - name: DB_HOST
+                  value: ""
+                - name: DB_NAME
+                  value: "xxx"
+                - name: DB_USERNAME
+                  value: "xxx"
+                # Please use secret!
+                - name: DB_PASSWORD
+                  value: ""
+                - name: SSH_HOST_NAME
+                  value: "xxx"
+                - name: SSH_PORT
+                  value: "22"
+                - name: SSH_USER
+                  value: "jkaninda"
+                - name: SSH_REMOTE_PATH
+                  value: "/home/jkaninda/backup"
+                - name: SSH_PASSWORD
+                  value: "password"
+              # Optional, required if you want to encrypt your backup
+              #- name: GPG_PASSPHRASE
+              #  value: "xxx"
+          restartPolicy: OnFailure
+```

docs/how-tos/encrypt-backup.md

@@ -32,10 +32,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup -d database
-      - /bin/sh
-      - -c
-      - mysql-bkup backup -d database
     volumes:
       - ./backup:/backup
     environment:

docs/how-tos/restore-from-s3.md

@@ -7,7 +7,7 @@ nav_order: 5
 
 # Restore database from S3 storage
 
-To restore the database, you need to add `restore` subcommand to `mysql-bkup` or `bkup` and specify the file to restore by adding `--file store_20231219_022941.sql.gz`.
+To restore the database, you need to add `restore` command and specify the file to restore by adding `--file store_20231219_022941.sql.gz`.
 
 {: .note }
 It supports __.sql__ and __.sql.gz__ compressed file.
@@ -23,10 +23,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: restore --storage s3 -d my-database -f store_20231219_022941.sql.gz --path /my-custom-path
-      - /bin/sh
-      - -c
-      - mysql-bkup restore --storage s3 -d my-database -f store_20231219_022941.sql.gz --path /my-custom-path
     volumes:
       - ./backup:/backup
     environment:
@@ -52,50 +49,47 @@ networks:
 
 ## Restore on Kubernetes
 
-
+Simple Kubernetes restore Job:
-### Simple Kubernetes CronJob usage:
 
 ```yaml
 apiVersion: batch/v1
-kind: CronJob
+kind: Job
 metadata:
-  name: bkup-job
+  name: restore-db
 spec:
-  schedule: "0 1 * * *"
+  template:
-  jobTemplate:
     spec:
-      template:
+      containers:
-        spec:
+        - name: mysql-bkup
-          containers:
+          image: jkaninda/mysql-bkup
-          - name: mysql-bkup
+          command:
-            image: jkaninda/mysql-bkup
-            command:
             - /bin/sh
             - -c
-            - mysql-bkup restore -s s3 --path /custom_path -f store_20231219_022941.sql.gz
+            - bkup restore -s s3 --path /custom_path -f store_20231219_022941.sql.gz
-            env:
+          env:
-              - name: DB_PORT
+            - name: DB_PORT
-                value: "3306" 
+              value: "3306"
-              - name: DB_HOST
+            - name: DB_HOST
-                value: ""
+              value: ""
-              - name: DB_NAME
+            - name: DB_NAME
-                value: ""
+              value: ""
-              - name: DB_USERNAME
+            - name: DB_USERNAME
-                value: ""
+              value: ""
-              # Please use secret!
+            # Please use secret!
-              - name: DB_PASSWORD
+            - name: DB_PASSWORD
-                value: ""
+              value: ""
-              - name: AWS_S3_ENDPOINT
+            - name: AWS_S3_ENDPOINT
-                value: "https://s3.amazonaws.com"
+              value: "https://s3.amazonaws.com"
-              - name: AWS_S3_BUCKET_NAME
+            - name: AWS_S3_BUCKET_NAME
-                value: "xxx"
+              value: "xxx"
-              - name: AWS_REGION
+            - name: AWS_REGION
-                value: "us-west-2"    
+              value: "us-west-2"
-              - name: AWS_ACCESS_KEY
+            - name: AWS_ACCESS_KEY
-                value: "xxxx"        
+              value: "xxxx"
-              - name: AWS_SECRET_KEY
+            - name: AWS_SECRET_KEY
-                value: "xxxx"    
+              value: "xxxx"
-              - name: AWS_DISABLE_SSL
+            - name: AWS_DISABLE_SSL
-                value: "false"
+              value: "false"
-          restartPolicy: OnFailure
+      restartPolicy: Never
+  backoffLimit: 4
 ```

docs/how-tos/restore-from-ssh.md

@@ -6,7 +6,7 @@ nav_order: 6
 ---
 # Restore database from SSH remote server
 
-To restore the database from your remote server, you need to add `restore` subcommand to `mysql-bkup` or `bkup` and specify the file to restore by adding `--file store_20231219_022941.sql.gz`.
+To restore the database from your remote server, you need to add `restore` command and specify the file to restore by adding `--file store_20231219_022941.sql.gz`.
 
 {: .note }
 It supports __.sql__ and __.sql.gz__ compressed file.
@@ -22,10 +22,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: restore --storage ssh -d my-database -f store_20231219_022941.sql.gz --path /home/jkaninda/backups
-      - /bin/sh
-      - -c
-      - mysql-bkup restore --storage ssh -d my-database -f store_20231219_022941.sql.gz --path /home/jkaninda/backups
     volumes:
       - ./backup:/backup
     environment:
@@ -50,49 +47,47 @@ networks:
 ```
 ## Restore on Kubernetes
 
-Simple Kubernetes CronJob usage:
+Simple Kubernetes restore Job:
 
 ```yaml
 apiVersion: batch/v1
-kind: CronJob
+kind: Job
 metadata:
-  name: bkup-job
+  name: restore-db
 spec:
-  schedule: "0 1 * * *"
+  template:
-  jobTemplate:
     spec:
-      template:
+      containers:
-        spec:
+        - name: mysql-bkup
-          containers:
+          image: jkaninda/mysql-bkup
-          - name: mysql-bkup
+          command:
-            image: jkaninda/mysql-bkup
-            command:
             - /bin/sh
             - -c
-            - mysql-bkup restore -s ssh -f store_20231219_022941.sql.gz
+            - bkup restore -s ssh -f store_20231219_022941.sql.gz
-            env:
+          env:
-              - name: DB_PORT
+            - name: DB_PORT
-                value: "3306" 
+              value: "3306"
-              - name: DB_HOST
+            - name: DB_HOST
-                value: ""
+              value: ""
-              - name: DB_NAME
+            - name: DB_NAME
-                value: ""
+              value: ""
-              - name: DB_USERNAME
+            - name: DB_USERNAME
-                value: ""
+              value: ""
-              # Please use secret!
+            # Please use secret!
-              - name: DB_PASSWORD
+            - name: DB_PASSWORD
-                value: ""
+              value: ""
-              - name: SSH_HOST_NAME
+            - name: SSH_HOST_NAME
-                value: ""
+              value: ""
-              - name: SSH_PORT
+            - name: SSH_PORT
-                value: "22"
+              value: "22"
-              - name: SSH_USER
+            - name: SSH_USER
-                value: "xxx"
+              value: "xxx"
-              - name: SSH_REMOTE_PATH
+            - name: SSH_REMOTE_PATH
-                value: "/home/jkaninda/backups"    
+              value: "/home/jkaninda/backups"
-              - name: AWS_ACCESS_KEY
+            - name: AWS_ACCESS_KEY
-                value: "xxxx"        
+              value: "xxxx"
-              - name: SSH_IDENTIFY_FILE
+            - name: SSH_IDENTIFY_FILE
-                value: "/tmp/id_ed25519"
+              value: "/tmp/id_ed25519"
-          restartPolicy: Never
+      restartPolicy: Never
+  backoffLimit: 4
 ```

docs/how-tos/restore.md

@@ -7,7 +7,7 @@ nav_order: 4
 
 # Restore database
 
-To restore the database, you need to add `restore` subcommand to `mysql-bkup` or `bkup` and specify the file to restore by adding `--file store_20231219_022941.sql.gz`.
+To restore the database, you need to add `restore` command and specify the file to restore by adding `--file store_20231219_022941.sql.gz`.
 
 {: .note }
 It supports __.sql__ and __.sql.gz__ compressed file.
@@ -23,10 +23,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: restore -d database -f store_20231219_022941.sql.gz
-      - /bin/sh
-      - -c
-      - mysql-bkup restore -d database -f store_20231219_022941.sql.gz
     volumes:
       - ./backup:/backup
     environment:

docs/index.md

@@ -6,7 +6,7 @@ nav_order: 1
 
 # About mysql-bkup
 {:.no_toc}
-mysql-bkup is a Docker container image that can be used to backup and restore MySQL database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH compatible storage.
+MySQL Backup is a Docker container image that can be used to backup and restore MySQL database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH remote storage.
 It also supports __encrypting__ your backups using GPG.
 
 We are open to receiving stars, PRs, and issues!
@@ -32,7 +32,7 @@ Code and documentation for `v1` version on [this branch][v1-branch].
 
 ### Simple backup using Docker CLI
 
-To run a one time backup, bind your local volume to `/backup` in the container and run the `mysql-bkup backup` command:
+To run a one time backup, bind your local volume to `/backup` in the container and run the `backup` command:
 
 ```shell
  docker run --rm --network your_network_name \
@@ -40,7 +40,7 @@ To run a one time backup, bind your local volume to `/backup` in the container a
  -e "DB_HOST=dbhost" \
  -e "DB_USERNAME=username" \
  -e "DB_PASSWORD=password" \
- jkaninda/mysql-bkup  mysql-bkup backup -d database_name
+ jkaninda/mysql-bkup backup -d database_name
 ```
 
 Alternatively, pass a `--env-file` in order to use a full config as described below.
@@ -56,10 +56,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup
-      - /bin/sh
-      - -c
-      - mysql-bkup backup
     volumes:
       - ./backup:/backup
     environment:
@@ -81,8 +78,8 @@ This Docker image is published to both Docker Hub and the GitHub container regis
 Depending on your preferences and needs, you can reference both `jkaninda/mysql-bkup` as well as `ghcr.io/jkaninda/mysql-bkup`:
 
 ```
-docker pull jkaninda/mysql-bkup:v1.0
+docker pull jkaninda/mysql-bkup
-docker pull ghcr.io/jkaninda/mysql-bkup:v1.0
+docker pull ghcr.io/jkaninda/mysql-bkup
 ```
 
 Documentation references Docker Hub, but all examples will work using ghcr.io just as well.

docs/old-version/index.md

@@ -21,7 +21,7 @@ In the old version, S3 storage was mounted using s3fs, so we decided to migrate
 
 | Options               | Shorts | Usage                                                                  |
 |-----------------------|--------|------------------------------------------------------------------------|
-| mysql-bkup               | bkup   | CLI utility                                                            |
+| mysql-bkup            | bkup   | CLI utility                                                            |
 | backup                |        | Backup database operation                                              |
 | restore               |        | Restore database operation                                             |
 | history               |        | Show the history of backup                                             |

examples/docker-compose.s3.yaml

@@ -6,10 +6,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup --storage s3 -d my-database"
-      - /bin/sh
-      - -c
-      - mysql-bkup backup --storage s3 -d my-database"
     environment:
       - DB_PORT=3306
       - DB_HOST=mysql

examples/docker-compose.scheduled.local.yaml

@@ -1,12 +1,11 @@
 version: "3"
 services:
   mysql-bkup:
+    # In production, it is advised to lock your image tag to a proper
+    # release version instead of using `latest`.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup --dbname database_name --mode scheduled --period "0 1 * * *"
-      - /bin/sh
-      - -c
-      - mysql-bkup backup --dbname database_name --mode scheduled --period "0 1 * * *"
     volumes:
       - ./backup:/backup
     environment:

examples/docker-compose.scheduled.s3.yaml

@@ -6,10 +6,7 @@ services:
     # for a list of available releases.
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup --storage s3 -d my-database --mode scheduled --period "0 1 * * *"
-      - /bin/sh
-      - -c
-      - mysql-bkup backup --storage s3 -d my-database --mode scheduled --period "0 1 * * *"
     environment:
       - DB_PORT=3306
       - DB_HOST=mysql

examples/docker-compose.yaml

@@ -3,10 +3,7 @@ services:
   mysql-bkup:
     image: jkaninda/mysql-bkup
     container_name: mysql-bkup
-    command:
+    command: backup --dbname database_name
-      - /bin/sh
-      - -c
-      - mysql-bkup backup --dbname database_name
     volumes:
       - ./backup:/backup
     environment:

pkg/scripts.go

@@ -24,7 +24,7 @@ func CreateCrontabScript(disableCompression bool, storage string) {
 
 	scriptContent := fmt.Sprintf(`#!/usr/bin/env bash
 set -e
-bkup backup --dbname %s --port %s --storage %s %v
+/usr/local/bin/mysql-bkup backup --dbname %s --port %s --storage %s %v
 `, os.Getenv("DB_NAME"), os.Getenv("DB_PORT"), storage, disableC)
 
 	if err := utils.WriteToFile(backupCronFile, scriptContent); err != nil {