diff --git a/Dockerfile b/Dockerfile index e12d9d5..45e4076 100644 --- a/Dockerfile +++ b/Dockerfile @@ -18,9 +18,12 @@ ARG BACKUP_TMP_DIR="/tmp/backup" ARG TEMPLATES_DIR="/config/templates" ARG appVersion="" ENV VERSION=${appVersion} -LABEL author="Jonas Kaninda" -LABEL version=${appVersion} -LABEL github="github.com/jkaninda/mysql-bkup" +LABEL org.opencontainers.image.title="mysql-bkup" +LABEL org.opencontainers.image.description="A lightweight MySQL backup and restore tool" +LABEL org.opencontainers.image.licenses="MIT" +LABEL org.opencontainers.image.authors="Jonas Kaninda " +LABEL org.opencontainers.image.version=${appVersion} +LABEL org.opencontainers.image.source="https://github.com/jkaninda/mysql-bkup" RUN apk --update add --no-cache mysql-client mariadb-connector-c tzdata ca-certificates RUN mkdir -p $WORKDIR $BACKUPDIR $TEMPLATES_DIR $BACKUP_TMP_DIR && \ diff --git a/README.md b/README.md index 1d919ac..17d4571 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ **MYSQL-BKUP** is a Docker container image designed to **backup, restore, and migrate MySQL databases**. It supports a variety of storage options and ensures data security through GPG encryption. -**MYSQL-BKUP** is designed for seamless deployment on **Docker** and **Kubernetes**, simplifying MySQL backup, restoration, and migration across environments. +MYSQL-BKUP is designed for seamless deployment on **Docker** and **Kubernetes**, simplifying MySQL backup, restoration, and migration across environments. It is a lightweight, multi-architecture solution compatible with **Docker**, **Docker Swarm**, **Kubernetes**, and other container orchestration platforms. @@ -69,12 +69,6 @@ MYSQL-BKUP has been tested and runs successfully on: - [PostgreSQL](https://github.com/jkaninda/pg-bkup) -## Storage: -- Local -- AWS S3 or any S3 Alternatives for Object Storage -- SSH remote storage server -- FTP remote storage server -- Azure Blob storage ## Quickstart @@ -204,10 +198,7 @@ spec: # Pin the image tag to a specific release version in production. # See available releases: https://github.com/jkaninda/mysql-bkup/releases image: jkaninda/mysql-bkup - command: - - /bin/sh - - -c - - backup -d dbname + command: ["backup", "-d", "dbname"] resources: limits: memory: "128Mi" @@ -248,10 +239,7 @@ spec: containers: - name: pg-bkup image: jkaninda/mysql-bkup - command: - - /bin/sh - - -c - - backup -d dbname + command: ["backup", "-d", "dbname"] env: - name: DB_HOST value: "mysql" @@ -270,6 +258,51 @@ spec: restartPolicy: OnFailure ``` +--- + +## ๐Ÿš€ Why Use MYSQL-BKUP? + +**MYSQL-BKUP** isn't just another MySQL backup tool, it's a robust, production-ready solution purpose-built for modern DevOps workflows. + +Hereโ€™s why developers, sysadmins, and DevOps choose **MYSQL-BKUP**: + +### โœ… All-in-One Backup, Restore & Migration + +Whether you're backing up a single database, restoring critical data, or migrating across environments, MYSQL-BKUP handles it all with a **single, unified CLI** no scripting gymnastics required. + + +### ๐Ÿ”„ Works Everywhere You Deploy + +Designed to be cloud-native: + +* **Runs seamlessly on Docker, Docker Swarm, and Kubernetes** +* Supports **CronJobs** for automated scheduled backups +* Compatible with GitOps and CI/CD workflows + +### โ˜๏ธ Flexible Storage Integrations + +Store your backups **anywhere**: + +* Local disks +* Amazon S3, MinIO, Wasabi, Azure Blob, FTP, SSH + +### ๐Ÿ”’ Enterprise-Grade Security + +* **GPG Encryption**: Protect sensitive data with optional encryption before storing backups locally or in the cloud. +* **Secure Storage** Options: Supports S3, Azure Blob, SFTP, and SSH with encrypted transfers, keeping backups safe from unauthorized access. + +### ๐Ÿ“ฌ Instant Notifications + +Stay in the loop with real-time notifications via **Telegram** and **Email**. Know immediately when a backup succeedsโ€”or fails. + +### ๐Ÿƒโ€โ™‚๏ธ Lightweight and Fast + +Written in **Go**, MYSQL-BKUP is fast, multi-arch compatible (`amd64`, `arm64`, `arm/v7`), and optimized for minimal memory and CPU usage. Ideal for both cloud and edge deployments. + +### ๐Ÿงช Tested. Verified. Trusted. + +Actively maintained with **automated testing**, **Docker image size optimizations**, and verified support across major container platforms. + --- ## Available image registries