kevinveenbirkenbach/docker-volume-backup-cleanup
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/docker-volume-backup-cleanup.git synced 2024-11-22 13:41:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Kevin Veen-Birkenbach 2023-06-19 13:11:57 +02:00 committed by GitHub
parent d5f3c7c613
commit 372597fdfa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,2 +1,30 @@
# docker-volume-backup-cleanup # Docker Volume Backup Cleanup
This script is a directory management tool written in Bash. It operates by traversing subdirectories within a specific main directory and, under certain conditions, proposing their deletion to the user.
This repository hosts a Bash script designed for cleaning up directories within the Docker Volume Backup system. It is intended to be used in conjunction with the [Docker Volume Backup](https://github.com/kevinveenbirkenbach/docker-volume-backup) project.
## Description
This script operates by traversing subdirectories within a specific main directory and, under certain conditions, proposes their deletion to the user. It is useful in managing backup directories, especially when certain directories can be cleaned up based on the absence of a particular subdirectory and the name of the directories themselves.
The script takes two arguments: a backup hash and a trigger directory. It constructs the main directory path using the given backup hash, and then iterates over all items within the main directory. If a directory's name matches a specific date-time-stamp pattern and lacks the specified trigger directory, the script will list its contents and ask for user confirmation to delete the directory.
For more detailed information about the script's workings, refer to the comments within the `cleanup.sh` script file.
## Usage
To use this script, clone this repository to your local system and run the script with the necessary arguments. The command should be structured as follows:
```bash
bash cleanup.sh BACKUP_HASH TRIGGER_DIRECTORY
```
Replace ```BACKUP_HASH``` and ```TRIGGER_DIRECTORY``` with your actual values.
## License
This project is licensed under the GNU Affero General Public License v3.0. See the LICENSE file for more information.
## Author
This script is developed by Kevin Veen-Birkenbach. You can reach out to him at kevin@veen.world or visit his website at https://www.veen.world.
## Created with Chat GPT
https://chat.openai.com/share/01222e15-8e1d-436d-b05b-29f406adb2ea