diff --git a/README.md b/README.md index b693c41..8f65ced 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,31 @@ -# dgd-backupper +# DGD Backupper -Backup manager for backing up Docker Containers to Google Drive. \ No newline at end of file +Backup manager for backing up Docker Containers to Mega.nz. + +## Requirement +* MegaCMD [Download](https://mega.nz/cmd) | [GitHub](https://github.com/meganz/MEGAcmd) + +## Usage + +``` +python backupper.py --containers nginx mysql +``` + +## Advantage Usage + +``` +python backupper.py --containers nginx mysql --data /path/to/data/folder --mysql mysql \ +--user root --password ROOT_PASSWORD --upload +``` + +| Arguments | Description | Required| +|---|---|---| +| containers | Name or ID of the containers you want to back up | True | +| data | Data folder path for docker containers | False | +| mysql | Mysql container name or id for backup databases | False | +| user | Mysql username | False | +| password | Mysql password | False | +| upload | Compress all backups and upload to Mega.nz | False | + +## Developer +✔ Muhep Atasoy [Website](https://muhepatasoy.com) | [Gitea](https://git.muhepatasoy.xyz/muhep) | [Twitter](https://twitter.com/Muhepatasoy_98) \ No newline at end of file