Database Backup Utility

A robust and flexible command-line utility for backing up MySQL, PostgreSQL, and MongoDB 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

   • Support for multiple databases
   • Advanced backup options

2. 🚀 Installation

3. 📋 Requirements

4. 💻 Usage

   • PostgreSQL
   • MySQL
   • MongoDB

5. 🖥️ Interactive Mode

   • TUI Features
     • Main Menu
     • Configuration Sections
     • Real-time display

6. 🔧 Available Options

7. 📁 File Structure

8. 🐳 Container Information

9. 📌 Important Notes

10. 🐛 Troubleshooting

    • Permission Error
    • Connection Error

11. 📂 Project Structure

    • Directory Layout
    • Key Files
    • Key Directories

12. 📝 License

13. ✨ Contributing

✨ Features

Support for multiple databases:

• MySQL
• PostgreSQL
• MongoDB

Advanced backup options:

• Automatic compression (.gz)
• Timestamped backups
• Generated file validation
• Detailed process information

🚀 Installation

1. Clone the repository:

git clone https://github.com/geo-mena/backup.git

2. Install the dependencies:

cd backup

3. Initialize with Docker:

./init.sh

4. Build the Docker image:

docker compose build --no-cache

5. Start the Docker container:

docker compose up -d

6. Access the container:

docker compose exec app sh

📋 Requirements

• Docker
• Docker Compose
• Git

💻 Usage

PostgreSQL

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

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

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:

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:

chmod -R 755 storage

Connection Error

Verify that the host and port are accessible from the Docker container

📂 Project Structure

Directory Layout

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.