Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/capcom6/mariadb-backup-s3
Automate MariaDB backups, compress them, and upload to S3-compatible storage. Easy setup with environment variables and command-line flags.
https://github.com/capcom6/mariadb-backup-s3
automation aws backup cloud compression database devops go golang mariadb s3
Last synced: about 14 hours ago
JSON representation
Automate MariaDB backups, compress them, and upload to S3-compatible storage. Easy setup with environment variables and command-line flags.
- Host: GitHub
- URL: https://github.com/capcom6/mariadb-backup-s3
- Owner: capcom6
- License: apache-2.0
- Created: 2024-07-26T01:57:34.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-07-29T13:58:04.000Z (2 months ago)
- Last Synced: 2024-09-19T03:40:19.086Z (9 days ago)
- Topics: automation, aws, backup, cloud, compression, database, devops, go, golang, mariadb, s3
- Language: Go
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MariaDB Backup to S3
This project automates the process of backing up a MariaDB database, compressing the backup, and uploading it to an S3-compatible storage service.
## Features
- Backup MariaDB databases using `mariabackup`.
- Compress backups into a `.tar.gz` file.
- Upload compressed backups to S3-compatible storage.
## Prerequisites
- Go 1.22 or later
- MariaDB server
- AWS credentials for S3-compatible storage
## Installation
1. Clone the repository:
```shell
git clone https://github.com/capcom6/mariadb-backup-s3.git
cd mariadb-backup-s3
```
2. Build the project:
```shell
go build
```
3. Create a `.env` file in the root directory with the following content:
```dotenv
# AWS Access Key for authenticating AWS services
AWS_ACCESS_KEY=000000000000000000000
# AWS region where the services are hosted
AWS_REGION=us-east-1
# AWS Secret Key for authenticating AWS services
AWS_SECRET_KEY=000000000000000000000
# MariaDB username for database authentication
MARIADB__USER=root
# MariaDB password for database authentication
MARIADB__PASSWORD=000000
# URL for storage service, including bucket name and endpoint
STORAGE__URL=s3://bucket-name/prefix?endpoint=http://127.0.0.1:9000&force_path_style=true
```
## Usage
Run the backup process with the following command:
```shell
./mariadb-backup-s3
```
The process will:
1. Create a temporary directory.
2. Backup the MariaDB database to the temporary directory.
3. Prepare the backup.
4. Compress the prepared backup into a .tar.gz file.
5. Upload the compressed backup to the S3-compatible storage.
## Configuration
The configuration is loaded from environment variables and command-line flags. Environment variables are defined in the `.env` file. Command-line flags can override the environment variables.
## Environment Variables
* `MARIADB__USER`: MariaDB username for database authentication.
* `MARIADB__PASSWORD`: MariaDB password for database authentication.
* `STORAGE__URL`: URL for storage service, including bucket name and endpoint.
## Command-Line Flags
* `--db-user`: Override the MariaDB username.
* `--db-password`: Override the MariaDB password.
* `--storage-url`: Override the storage URL.
## License
This project is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for details.
## Contributing
1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new Pull Request.