Merge pull request #113 from jkaninda/develop

Develop
jkaninda · Oct 9, 2024 · 4c44166 · 4c44166
2 parents dabba20 + 554df81
commit 4c44166
Show file tree

Hide file tree

Showing 16 changed files with 657 additions and 159 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -25,7 +25,7 @@ jobs:
         uses: docker/build-push-action@v3
         with:
           push: true
-          file: "./docker/Dockerfile"
+          file: "./Dockerfile"
           platforms: linux/amd64,linux/arm64,linux/arm/v7
           build-args: |
             appVersion=develop-${{ github.sha }}

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -39,7 +39,7 @@ jobs:
         uses: docker/build-push-action@v3
         with:
           push: true
-          file: "./docker/Dockerfile"
+          file: "./Dockerfile"
           platforms: linux/amd64,linux/arm64,linux/arm/v7
           build-args: |
             appVersion=${{ env.TAG_NAME }}

diff --git a/docker/Dockerfile → Dockerfile b/docker/Dockerfile → Dockerfile
@@ -52,7 +52,7 @@ ENV VERSION=${appVersion}
 LABEL author="Jonas Kaninda"
 LABEL version=${appVersion}
 
-RUN apk --update add --no-cache mysql-client mariadb-connector-c gnupg tzdata
+RUN apk --update add --no-cache mysql-client mariadb-connector-c tzdata
 RUN mkdir $WORKDIR
 RUN mkdir $BACKUPDIR
 RUN mkdir -p $BACKUP_TMP_DIR

diff --git a/docs/how-tos/deprecated-configs.md b/docs/how-tos/deprecated-configs.md
@@ -0,0 +1,6 @@
+---
+title: Update deprecated configurations
+layout: default
+parent: How Tos
+nav_order: 11
+---
diff --git a/docs/how-tos/encrypt-backup.md b/docs/how-tos/encrypt-backup.md
@@ -1,30 +1,39 @@
 ---
-title: Encrypt backups using GPG
+title: Encrypt backups
 layout: default
 parent: How Tos
 nav_order: 8
 ---
 # Encrypt backup
 
-The image supports encrypting backups using GPG out of the box. In case a `GPG_PASSPHRASE` environment variable is set, the backup archive will be encrypted using the given key and saved as a sql.gpg file instead or sql.gz.gpg.
+The image supports encrypting backups using one of two available methods: GPG with passphrase or GPG with a public key.
+
+
+The image supports encrypting backups using GPG out of the box. In case a `GPG_PASSPHRASE` or `GPG_PUBLIC_KEY` environment variable is set, the backup archive will be encrypted using the given key and saved as a sql.gpg file instead or sql.gz.gpg.
 
 {: .warning }
-To restore an encrypted backup, you need to provide the same GPG passphrase or key used during backup process.
+To restore an encrypted backup, you need to provide the same GPG passphrase used during backup process.
 
 - GPG home directory `/config/gnupg`
 - Cipher algorithm `aes256`
-- 
-To decrypt manually, you need to install `gnupg`
 
-### Decrypt backup
+{: .note }
+The backup encrypted using `GPG passphrase` method can be restored automatically, no need to decrypt it before restoration.
+Suppose you used a GPG public key during the backup process. In that case, you need to decrypt your backup before restoration because decryption using a `GPG private` key is not fully supported.
+
+To decrypt manually, you need to install `gnupg`
 
 ```shell
 gpg --batch --passphrase "my-passphrase" \
 --output database_20240730_044201.sql.gz \
 --decrypt database_20240730_044201.sql.gz.gpg
 ```
+Using your private key
 
-### Backup
+```shell
+gpg --output database_20240730_044201.sql.gz --decrypt database_20240730_044201.sql.gz.gpg
+```
+## Using GPG passphrase
 
 ```yml
 services:
@@ -51,4 +60,32 @@ services:
       - web
 networks:
   web:
+```
+## Using GPG Public Key
+
+```yml
+services:
+  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
+    container_name: mysql-bkup
+    command: backup -d database
+    volumes:
+      - ./backup:/backup
+    environment:
+      - DB_PORT=3306
+      - DB_HOST=mysql
+      - DB_NAME=database
+      - DB_USERNAME=username
+      - DB_PASSWORD=password
+      ## Required to encrypt backup
+      - GPG_PUBLIC_KEY=/config/public_key.asc
+    # mysql-bkup container must be connected to the same network with your database
+    networks:
+      - web
+networks:
+  web:
 ```
diff --git a/docs/how-tos/mutli-backup.md b/docs/how-tos/mutli-backup.md
@@ -0,0 +1,63 @@
+---
+title: Run multiple backup schedules in the same container
+layout: default
+parent: How Tos
+nav_order: 11
+---
+
+Multiple backup schedules with different configuration can be configured by mounting a configuration file into `/config/config.yaml`  `/config/config.yml` or by defining an environment variable `BACKUP_CONFIG_FILE=/backup/config.yaml`.
+
+## Configuration file
+
+```yaml
+#cronExpression: "@every 20m" //Optional for scheduled backups
+cronExpression: "" 
+databases:
+  - host: mysql1
+    port: 3306
+    name: database1
+    user: database1
+    password: password
+    path: /s3-path/database1 #For SSH or FTP you need to define the full path (/home/toto/backup/)
+  - host: mysql2
+    port: 3306
+    name: lldap
+    user: lldap
+    password: password
+    path: /s3-path/lldap #For SSH or FTP you need to define the full path (/home/toto/backup/)
+  - host: mysql3
+    port: 3306
+    name: keycloak
+    user: keycloak
+    password: password
+    path: /s3-path/keycloak #For SSH or FTP you need to define the full path (/home/toto/backup/)
+  - host: mysql4
+    port: 3306
+    name: joplin
+    user: joplin
+    password: password
+    path: /s3-path/joplin #For SSH or FTP you need to define the full path (/home/toto/backup/)
+```
+## Docker compose file
+
+```yaml
+services:
+  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
+    container_name: mysql-bkup
+    command: backup
+    volumes:
+      - ./backup:/backup
+    environment:
+      ## Multi backup config file
+      - BACKUP_CONFIG_FILE=/backup/config.yaml
+    # mysql-bkup container must be connected to the same network with your database
+    networks:
+      - web
+networks:
+  web:
+```
diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -34,41 +34,42 @@ Backup, restore and migrate targets, schedule and retention are configured using
 
 ## Environment variables
 
-| Name                   | Requirement                                                   | Description                                          |
-|------------------------|---------------------------------------------------------------|------------------------------------------------------|
-| DB_PORT                | Optional, default 3306                                        | Database port number                                 |
-| DB_HOST                | Required                                                      | Database host                                        |
-| DB_NAME                | Optional if it was provided from the -d flag                  | Database name                                        |
-| DB_USERNAME            | Required                                                      | Database user name                                   |
-| DB_PASSWORD            | Required                                                      | Database password                                    |
-| AWS_ACCESS_KEY         | Optional, required for S3 storage                             | AWS S3 Access Key                                    |
-| AWS_SECRET_KEY         | Optional, required for S3 storage                             | AWS S3 Secret Key                                    |
-| AWS_BUCKET_NAME        | Optional, required for S3 storage                             | AWS S3 Bucket Name                                   |
-| AWS_BUCKET_NAME        | Optional, required for S3 storage                             | AWS S3 Bucket Name                                   |
-| AWS_REGION             | Optional, required for S3 storage                             | AWS Region                                           |
-| AWS_DISABLE_SSL        | Optional, required for S3 storage                             | Disable SSL                                          |
-| AWS_FORCE_PATH_STYLE   | Optional, required for S3 storage                             | Force path style                                     |
-| FILE_NAME              | Optional if it was provided from the --file flag              | Database file to restore (extensions: .sql, .sql.gz) |
-| GPG_PASSPHRASE         | Optional, required to encrypt and restore backup              | GPG passphrase                                       |
-| BACKUP_CRON_EXPRESSION | Optional if it was provided from the `--cron-expression` flag | Backup cron expression for docker in scheduled mode  |
-| SSH_HOST               | Optional, required for SSH storage                            | ssh remote hostname or ip                            |
-| SSH_USER               | Optional, required for SSH storage                            | ssh remote user                                      |
-| SSH_PASSWORD           | Optional, required for SSH storage                            | ssh remote user's password                           |
-| SSH_IDENTIFY_FILE      | Optional, required for SSH storage                            | ssh remote user's private key                        |
-| SSH_PORT               | Optional, required for SSH storage                            | ssh remote server port                               |
-| REMOTE_PATH            | Optional, required for SSH or FTP storage                     | remote path (/home/toto/backup)                      |
-| FTP_HOST               | Optional, required for FTP storage                            | FTP host name                                        |
-| FTP_PORT               | Optional, required for FTP storage                            | FTP server port number                               |
-| FTP_USER               | Optional, required for FTP storage                            | FTP user                                             |
-| FTP_PASSWORD           | Optional, required for FTP storage                            | FTP user password                                    |
-| TARGET_DB_HOST         | Optional, required for database migration                     | Target database host                                 |
-| TARGET_DB_PORT         | Optional, required for database migration                     | Target database port                                 |
-| TARGET_DB_NAME         | Optional, required for database migration                     | Target database name                                 |
-| TARGET_DB_USERNAME     | Optional, required for database migration                     | Target database username                             |
-| TARGET_DB_PASSWORD     | Optional, required for database migration                     | Target database password                             |
-| TG_TOKEN               | Optional, required for Telegram notification                  | Telegram token (`BOT-ID:BOT-TOKEN`)                  |
-| TG_CHAT_ID             | Optional, required for Telegram notification                  | Telegram Chat ID                                     |
-| TZ                     | Optional                                                      | Time Zone                                            |
+| Name                   | Requirement                                                   | Description                                                     |
+|------------------------|---------------------------------------------------------------|-----------------------------------------------------------------|
+| DB_PORT                | Optional, default 3306                                        | Database port number                                            |
+| DB_HOST                | Required                                                      | Database host                                                   |
+| DB_NAME                | Optional if it was provided from the -d flag                  | Database name                                                   |
+| DB_USERNAME            | Required                                                      | Database user name                                              |
+| DB_PASSWORD            | Required                                                      | Database password                                               |
+| AWS_ACCESS_KEY         | Optional, required for S3 storage                             | AWS S3 Access Key                                               |
+| AWS_SECRET_KEY         | Optional, required for S3 storage                             | AWS S3 Secret Key                                               |
+| AWS_BUCKET_NAME        | Optional, required for S3 storage                             | AWS S3 Bucket Name                                              |
+| AWS_BUCKET_NAME        | Optional, required for S3 storage                             | AWS S3 Bucket Name                                              |
+| AWS_REGION             | Optional, required for S3 storage                             | AWS Region                                                      |
+| AWS_DISABLE_SSL        | Optional, required for S3 storage                             | Disable SSL                                                     |
+| AWS_FORCE_PATH_STYLE   | Optional, required for S3 storage                             | Force path style                                                |
+| FILE_NAME              | Optional if it was provided from the --file flag              | Database file to restore (extensions: .sql, .sql.gz)            |
+| GPG_PASSPHRASE         | Optional, required to encrypt and restore backup              | GPG passphrase                                                  |
+| GPG_PUBLIC_KEY         | Optional, required to encrypt backup                          | GPG public key, used to encrypt backup (/config/public_key.asc) |
+| BACKUP_CRON_EXPRESSION | Optional if it was provided from the `--cron-expression` flag | Backup cron expression for docker in scheduled mode             |
+| SSH_HOST               | Optional, required for SSH storage                            | ssh remote hostname or ip                                       |
+| SSH_USER               | Optional, required for SSH storage                            | ssh remote user                                                 |
+| SSH_PASSWORD           | Optional, required for SSH storage                            | ssh remote user's password                                      |
+| SSH_IDENTIFY_FILE      | Optional, required for SSH storage                            | ssh remote user's private key                                   |
+| SSH_PORT               | Optional, required for SSH storage                            | ssh remote server port                                          |
+| REMOTE_PATH            | Optional, required for SSH or FTP storage                     | remote path (/home/toto/backup)                                 |
+| FTP_HOST               | Optional, required for FTP storage                            | FTP host name                                                   |
+| FTP_PORT               | Optional, required for FTP storage                            | FTP server port number                                          |
+| FTP_USER               | Optional, required for FTP storage                            | FTP user                                                        |
+| FTP_PASSWORD           | Optional, required for FTP storage                            | FTP user password                                               |
+| TARGET_DB_HOST         | Optional, required for database migration                     | Target database host                                            |
+| TARGET_DB_PORT         | Optional, required for database migration                     | Target database port                                            |
+| TARGET_DB_NAME         | Optional, required for database migration                     | Target database name                                            |
+| TARGET_DB_USERNAME     | Optional, required for database migration                     | Target database username                                        |
+| TARGET_DB_PASSWORD     | Optional, required for database migration                     | Target database password                                        |
+| TG_TOKEN               | Optional, required for Telegram notification                  | Telegram token (`BOT-ID:BOT-TOKEN`)                             |
+| TG_CHAT_ID             | Optional, required for Telegram notification                  | Telegram Chat ID                                                |
+| TZ                     | Optional                                                      | Time Zone                                                       |
 
 ---
 ## Run in Scheduled mode

diff --git a/go.mod b/go.mod
@@ -5,21 +5,28 @@ go 1.22.5
 require github.com/spf13/pflag v1.0.5
 
 require (
+	github.com/ProtonMail/gopenpgp/v2 v2.7.5
 	github.com/aws/aws-sdk-go v1.55.3
 	github.com/bramvdbogaerde/go-scp v1.5.0
 	github.com/hpcloud/tail v1.0.0
+	github.com/jlaffaye/ftp v0.2.0
+	github.com/robfig/cron/v3 v3.0.1
 	github.com/spf13/cobra v1.8.0
 	golang.org/x/crypto v0.18.0
+	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
+	github.com/ProtonMail/go-crypto v0.0.0-20230717121422-5aa5874ade95 // indirect
+	github.com/ProtonMail/go-mime v0.0.0-20230322103455-7d82a3887f2f // indirect
+	github.com/cloudflare/circl v1.3.3 // indirect
 	github.com/hashicorp/errwrap v1.1.0 // indirect
 	github.com/hashicorp/go-multierror v1.1.1 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
-	github.com/jlaffaye/ftp v0.2.0 // indirect
 	github.com/jmespath/go-jmespath v0.4.0 // indirect
-	github.com/robfig/cron/v3 v3.0.1 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
 	golang.org/x/sys v0.22.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
 	gopkg.in/fsnotify.v1 v1.4.7 // indirect
 	gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect
 )