Skip to content

Commit f1c5c0f

Browse files
committed
docs: update key features
1 parent 80cd70e commit f1c5c0f

File tree

2 files changed

+35
-13
lines changed

2 files changed

+35
-13
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
**MYSQL-BKUP** is a Docker container image designed to **backup, restore, and migrate MySQL databases**.
44
It supports a variety of storage options and ensures data security through GPG encryption.
55

6+
**MYSQL-BKUP** is designed for seamless deployment on **Docker** and **Kubernetes**, simplifying MySQL backup, restoration, and migration across environments.
7+
It is a lightweight, multi-architecture solution compatible with **Docker**, **Docker Swarm**, **Kubernetes**, and other container orchestration platforms.
8+
9+
10+
11+
12+
613
[![Tests](https://github.com/jkaninda/mysql-bkup/actions/workflows/tests.yml/badge.svg)](https://github.com/jkaninda/mysql-bkup/actions/workflows/tests.yml)
714
[![Build](https://github.com/jkaninda/mysql-bkup/actions/workflows/release.yml/badge.svg)](https://github.com/jkaninda/mysql-bkup/actions/workflows/release.yml)
815
[![Go Report](https://goreportcard.com/badge/github.com/jkaninda/mysql-bkup)](https://goreportcard.com/report/github.com/jkaninda/mysql-bkup)
@@ -12,9 +19,9 @@ It supports a variety of storage options and ensures data security through GPG e
1219

1320
## Features
1421

15-
- **Storage Options:**
16-
- Local storage
17-
- AWS S3 or any S3-compatible object storage
22+
- **Flexible Storage Backends:**
23+
- Local filesystem
24+
- Amazon S3 & S3-compatible storage (e.g., MinIO, Wasabi)
1825
- FTP
1926
- SSH-compatible storage
2027
- Azure Blob storage
@@ -34,16 +41,19 @@ It supports a variety of storage options and ensures data security through GPG e
3441
- **Telegram**
3542
- **Email**
3643

37-
## Use Cases
44+
## 💡Use Cases
45+
46+
- **Scheduled Backups**: Automate recurring backups using Docker cron or Kubernetes CronJobs.
47+
- **Disaster Recovery:** Quickly restore backups to a clean MySQL instance.
48+
- **Database Migration**: Seamlessly move data across environments using the built-in `migrate` feature.
49+
- **Secure Archiving:** Keep backups encrypted and safely stored in the cloud or remote servers.
3850

39-
- **Automated Recurring Backups:** Schedule regular backups for MySQL databases.
40-
- **Cross-Environment Migration:** Easily migrate MySQL databases across different environments using `migration` feature.
41-
- **Secure Backup Management:** Protect your data with GPG encryption.
4251

52+
## ✅ Verified Platforms:
53+
MYSQL-BKUP has been tested and runs successfully on:
4354

44-
Successfully tested on:
4555
- Docker
46-
- Docker in Swarm mode
56+
- Docker Swarm
4757
- Kubernetes
4858
- OpenShift
4959

docs/index.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ nav_order: 1
1010
**MYSQL-BKUP** is a Docker container image designed to **backup, restore, and migrate MySQL databases**.
1111
It supports a variety of storage options and ensures data security through GPG encryption.
1212

13+
**MYSQL-BKUP** is designed for seamless deployment on **Docker** and **Kubernetes**, simplifying MySQL backup, restoration, and migration across environments.
14+
It is a lightweight, multi-architecture solution compatible with **Docker**, **Docker Swarm**, **Kubernetes**, and other container orchestration platforms.
1315
---
1416

1517
## Key Features
@@ -39,11 +41,21 @@ It supports a variety of storage options and ensures data security through GPG e
3941

4042
---
4143

42-
## Use Cases
44+
## 💡Use Cases
4345

44-
- **Automated Recurring Backups:** Schedule regular backups for MySQL databases.
45-
- **Cross-Environment Migration:** Easily migrate MySQL databases across different environments using `migration` feature.
46-
- **Secure Backup Management:** Protect your data with GPG encryption.
46+
- **Scheduled Backups**: Automate recurring backups using Docker cron or Kubernetes CronJobs.
47+
- **Disaster Recovery:** Quickly restore backups to a clean MySQL instance.
48+
- **Database Migration**: Seamlessly move data across environments using the built-in `migrate` feature.
49+
- **Secure Archiving:** Keep backups encrypted and safely stored in the cloud or remote servers.
50+
51+
52+
## ✅ Verified Platforms:
53+
MYSQL-BKUP has been tested and runs successfully on:
54+
55+
- Docker
56+
- Docker Swarm
57+
- Kubernetes
58+
- OpenShift
4759

4860
---
4961

0 commit comments

Comments
 (0)