https://github.com/geo-mena/backup
🥚 Database backup utility that can backup and restore any DB
https://github.com/geo-mena/backup
cli docker laravel-zero php r2
Last synced: 3 months ago
JSON representation
🥚 Database backup utility that can backup and restore any DB
- Host: GitHub
- URL: https://github.com/geo-mena/backup
- Owner: geo-mena
- Created: 2024-12-31T19:24:19.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-01-01T00:21:22.000Z (5 months ago)
- Last Synced: 2025-01-01T00:22:55.958Z (5 months ago)
- Topics: cli, docker, laravel-zero, php, r2
- Language: PHP
- Homepage:
- Size: 42 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Database Backup Utility
A robust and flexible command-line utility for backing up [MySQL](https://www.mysql.com), [PostgreSQL](https://www.postgresql.org), and [MongoDB](https://www.mongodb.com) databases. Built with simplicity and power in mind, this tool offers a streamlined approach to database backups while providing advanced features for more complex requirements.
---
## 📑 Table of Contents
1. [✨ Features](#-features)
- [Support for multiple databases](#support-for-multiple-databases)
- [Advanced backup options](#advanced-backup-options)
2. [🚀 Installation](#-installation)
3. [📋 Requirements](#-requirements)
4. [💻 Usage](#-usage)
- [PostgreSQL](#postgresql)
- [MySQL](#mysql)
- [MongoDB](#mongodb)
5. [🖥️ Interactive Mode](#️-interactive-mode)
- [TUI Features](#tui-features)
- [Main Menu](#main-menu)
- [Configuration Sections](#configuration-sections)
- [Real-time display](#real-time-display-of)
6. [🔧 Available Options](#-available-options)
7. [📁 File Structure](#-file-structure)
8. [🐳 Container Information](#-container-information)
9. [📌 Important Notes](#️-important-notes)
10. [🐛 Troubleshooting](#-troubleshooting)
- [Permission Error](#permission-error)
- [Connection Error](#connection-error)
11. [📂 Project Structure](#-project-structure)
- [Directory Layout](#directory-layout)
- [Key Files](#key-files)
- [Key Directories](#key-directories)
12. [📝 License](#-license)
13. [✨ Contributing](#-contributing)
## ✨ Features
Support for multiple databases:
- [MySQL](https://www.mysql.com)
- [PostgreSQL](https://www.postgresql.org)
- [MongoDB](https://www.mongodb.com)
Advanced backup options:
- Automatic compression (.gz)
- Timestamped backups
- Generated file validation
- Detailed process information
## 🚀 Installation
1. Clone the repository:
```bash
git clone https://github.com/geo-mena/backup.git
```
2. Install the dependencies:
```bash
cd backup
```
3. Initialize with Docker:
```bash
./init.sh
```
4. Build the Docker image:
```bash
docker compose build --no-cache
```
5. Start the Docker container:
```bash
docker compose up -d
```
6. Access the container:
```bash
docker compose exec app sh
```
## 📋 Requirements
- [Docker](https://www.docker.com)
- [Docker Compose](https://docs.docker.com/compose)
- [Git](https://git-scm.com)
## 💻 Usage
### PostgreSQL
```bash
docker compose run --rm app php application backup \
--type=postgres \
--host=your-host \
--port=5432 \
--database=your-db \
--user=your-user \
--password=your-password \
--compress
```
### MySQL
```bash
docker compose run --rm app php application backup \
--type=mysql \
--host=your-host \
--port=3306 \
--database=your-db \
--user=root \
--password=your-password \
--compress
```
### MongoDB
```bash
docker compose run --rm app php application backup \
--type=mongodb \
--host=your-host \
--port=27017 \
--database=your-db \
--user=your-user \
--password=your-password \
--compress
```
## 🖥️ Interactive Mode
The utility includes a user-friendly Terminal User Interface (TUI) that makes it easier to configure and execute backups. To use the interactive mode:
```bash
docker compose run --rm app php application backup:tui
```
The TUI provides:
- Easy database type selection
- Interactive configuration menus
- Real-time validation
- Visual feedback
- Configuration preview
- Step-by-step guidance
### TUI Features
- Main Menu:
- Database type selection (MySQL, PostgreSQL, MongoDB)
- Visual ASCII art interface
- Color-coded options
- Configuration Sections:
- Connection Settings
- Database Settings
- Output Settings
- Real-time display of:
- Current configuration
- Validation status
- Process feedback
## 🔧 Available Options
| Option | Description | Default Value |
| ------------ | -------------------------------------------- | --------------------- |
| `--type` | Database type (`mysql`/`postgres`/`mongodb`) | `mysql` |
| `--host` | Database host | `localhost` |
| `--port` | Database port | `[depends on type]` |
| `--database` | Database name | **required** |
| `--user` | Database user | - |
| `--password` | Database password | - |
| `--output` | Output directory | `app/storage/backups` |
| `--compress` | Compress the backup | `false` |
## 📁 File Structure
Backups are stored in the storage/backups/ directory with the following format:
```
{database}_{type}_{date}.{extension}[.gz]
```
Example:
```
mydb_postgres_2024-12-31_18-30-00.sql.gz
```
## 🐳 Container Information
The container includes:
- PHP 8.2
- PostgreSQL Client 16
- MySQL Client
- MongoDB Tools
## 📌 Important Notes
- Compressed backups use gzip (.gz)
- Using environment variables for passwords is recommended in production
- Timestamps are in UTC format
## 🐛 Troubleshooting
### Permission Error
If you encounter a permission error, run the following command:
```bash
chmod -R 755 storage
```
### Connection Error
Verify that the host and port are accessible from the Docker container
## 📂 Project Structure
### Directory Layout
```bash
backup-utility/
├── app/
│ ├── Commands/
│ │ ├── BackupCommand.php
│ │ └── BackupTUICommand.php
│ └── Providers/
├── config/
├── docker/
│ └── php/
│ └── Dockerfile
├── storage/
│ └── backups/
├── tests/
├── composer.json
└── docker-compose.yml
```
### Key Files
- `app/Commands/BackupCommand.php`: Core backup functionality implementation
- `app/Commands/BackupTUICommand.php`: Interactive TUI implementation
- `docker/php/Dockerfile`: Docker container configuration
- `docker-compose.yml`: Docker services configuration
- `composer.json`: PHP dependencies and project configuration
- `config/backup.php`: Backup configuration settings
- `storage/backups/`: Default backup storage directory
- `tests/`: Test suite directory
### Key Directories
- `app/`: Contains the main application code
- `config/`: Configuration files
- `docker/`: Docker-related files
- `storage/`: Storage for backups and logs
- `tests/`: Test files
## 📝 License
The **Database Backup Utility** is an open-source software licensed under the MIT license.
## ✨ Contributing
Contributions are welcome! Please open an issue first to discuss any changes you'd like to make.