mirror of
https://github.com/kevinveenbirkenbach/docker-volume-backup.git
synced 2025-04-21 17:24:58 +02:00
Update README.md
This commit is contained in:
GitHub
parent
f847c8dd74
commit
a355f34e6e
126
README.md
126
README.md
@ -1,67 +1,109 @@
|
||||
# Backup Docker Volumes to Local
|
||||
[](./LICENSE.txt)
|
||||
# Backup Docker Volumes to Local (dobaulo) 📦🔄
|
||||
|
||||
## goal
|
||||
This script backups all docker-volumes with the help of rsync.
|
||||
**Backup Docker Volumes to Local** is a set of Python and shell scripts that enable you to perform incremental backups of all your Docker volumes using rsync. It is designed to integrate seamlessly with [Kevin's Package Manager](https://github.com/kevinveenbirkenbach/package-manager) under the alias **dobaulo**, making it easy to install and manage. The tool supports both file and database recoveries with a clear, automated backup scheme.
|
||||
|
||||
## scheme
|
||||
It is part of the following scheme:
|
||||
|
||||
Further information you will find [in this blog post](https://www.veen.world/2020/12/26/how-i-backup-dedicated-root-servers/).
|
||||
[](https://www.gnu.org/licenses/agpl-3.0) [](https://www.docker.com) [](https://www.python.org) [](https://github.com/kevinveenbirkenbach/backup-docker-to-local/stargazers)
|
||||
|
||||
## Backup all volumes
|
||||
Execute:
|
||||
## 🎯 Goal
|
||||
|
||||
This project automates the backup of Docker volumes using incremental backups (rsync) and supports recovering both files and database dumps (MariaDB/PostgreSQL). A robust directory stamping mechanism ensures data integrity, and the tool also handles restarting Docker Compose services when necessary.
|
||||
|
||||
## 🚀 Features
|
||||
|
||||
- **Incremental Backups:** Uses rsync with `--link-dest` for efficient, versioned backups.
|
||||
- **Database Backup Support:** Backs up MariaDB and PostgreSQL databases from running containers.
|
||||
- **Volume Recovery:** Provides scripts to recover volumes and databases from backups.
|
||||
- **Docker Compose Integration:** Option to automatically restart Docker Compose services after backup.
|
||||
- **Flexible Configuration:** Easily integrated with your Docker environment with minimal setup.
|
||||
- **Comprehensive Logging:** Detailed command output and error handling for safe operations.
|
||||
|
||||
## 🛠 Requirements
|
||||
|
||||
- **Linux Operating System** (with Docker installed) 🐧
|
||||
- **Python 3.x** 🐍
|
||||
- **Docker & Docker Compose** 🔧
|
||||
- **rsync** installed on your system
|
||||
|
||||
## 📥 Installation
|
||||
|
||||
You can install **Backup Docker Volumes to Local** easily via [Kevin's Package Manager](https://github.com/kevinveenbirkenbach/package-manager) using the alias **dobaulo**:
|
||||
|
||||
```bash
|
||||
pkgman install dobaulo
|
||||
```
|
||||
|
||||
Alternatively, clone the repository directly:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/kevinveenbirkenbach/backup-docker-to-local.git
|
||||
cd backup-docker-to-local
|
||||
```
|
||||
|
||||
## 🚀 Usage
|
||||
|
||||
### Backup All Volumes
|
||||
|
||||
To backup all Docker volumes, simply run:
|
||||
|
||||
```bash
|
||||
./backup-docker-to-local.sh
|
||||
```
|
||||
|
||||
## Recover
|
||||
### Recovery
|
||||
|
||||
### database
|
||||
```bash
|
||||
docker exec -i mysql_container mysql -uroot -psecret database < db.sql
|
||||
```
|
||||
|
||||
### volume
|
||||
Execute:
|
||||
#### Recover Volume Files
|
||||
|
||||
```bash
|
||||
|
||||
bash ./recover-docker-from-local.sh "{{volume_name}}" "$(sha256sum /etc/machine-id | head -c 64)" "{{version_to_recover}}"
|
||||
|
||||
```
|
||||
|
||||
### Database
|
||||
#### Recover Database
|
||||
|
||||
## Debug
|
||||
To checkout what's going on in the mount container type in the following command:
|
||||
For example, to recover a MySQL/MariaDB database:
|
||||
|
||||
```bash
|
||||
docker exec -i mysql_container mysql -uroot -psecret database < db.sql
|
||||
```
|
||||
|
||||
#### Debug Mode
|
||||
|
||||
To inspect what’s happening inside a container:
|
||||
|
||||
```bash
|
||||
docker run -it --entrypoint /bin/sh --rm --volumes-from {{container_name}} -v /Backups/:/Backups/ kevinveenbirkenbach/alpine-rsync
|
||||
```
|
||||
|
||||
## Setup
|
||||
Install pandas
|
||||
## 🔍 Backup Scheme
|
||||
|
||||
## Author
|
||||
The backup mechanism uses incremental backups with rsync and stamps directories with a unique hash. For more details on the backup scheme, check out [this blog post](https://blog.veen.world/blog/2020/12/26/how-i-backup-dedicated-root-servers/).
|
||||
|
||||
|
||||
Kevin Veen-Birkenbach
|
||||
- 📧 Email: [kevin@veen.world](mailto:kevin@veen.world)
|
||||
- 🌍 Website: [https://www.veen.world/](https://www.veen.world/)
|
||||
## 🧑💻 Setup & Dependencies
|
||||
|
||||
## License
|
||||
Make sure you have **pandas** installed:
|
||||
|
||||
This project is licensed under the GNU Affero General Public License v3.0. The full license text is available in the `LICENSE` file of this repository.
|
||||
```bash
|
||||
pip install pandas
|
||||
```
|
||||
|
||||
## More information
|
||||
- https://docs.docker.com/storage/volumes/
|
||||
- https://blog.ssdnodes.com/blog/docker-backup-volumes/
|
||||
- https://www.baculasystems.com/blog/docker-backup-containers/
|
||||
- https://gist.github.com/spalladino/6d981f7b33f6e0afe6bb
|
||||
- https://stackoverflow.com/questions/26331651/how-can-i-backup-a-docker/container/with-its-data-volumes
|
||||
- https://netfuture.ch/2013/08/simple-versioned-timemachine-like-backup-using-rsync/
|
||||
- https://zwischenzugs.com/2016/08/29/bash-to-python-converter/
|
||||
- https://en.wikipedia.org/wiki/Incremental_backup#Incremental
|
||||
- https://unix.stackexchange.com/questions/567837/linux-backup-utility-for-incremental-backups
|
||||
- https://chat.openai.com/share/6d10f143-3f7c-4feb-8ae9-5644c3433a65
|
||||
Also, ensure your system meets all the requirements listed above.
|
||||
|
||||
## 👨💻 Author
|
||||
|
||||
**Kevin Veen-Birkenbach**
|
||||
- 📧 [kevin@veen.world](mailto:kevin@veen.world)
|
||||
- 🌐 [https://www.veen.world/](https://www.veen.world/)
|
||||
|
||||
## 📜 License
|
||||
|
||||
This project is licensed under the **GNU Affero General Public License v3.0**. See the [LICENSE](./LICENSE) file for details.
|
||||
|
||||
## 🔗 More Information
|
||||
|
||||
- [Docker Volumes Documentation](https://docs.docker.com/storage/volumes/)
|
||||
- [Docker Backup Volumes Blog](https://blog.ssdnodes.com/blog/docker-backup-volumes/)
|
||||
- [Backup Strategies](https://en.wikipedia.org/wiki/Incremental_backup#Incremental)
|
||||
|
||||
---
|
||||
|
||||
Happy Backing Up! 🚀🔐
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user