lightweight/docker-compose-dbbackup
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Dave Lane 2022-06-09 07:21:28 +00:00
parent 004a6d54e4
commit 1bef97e05c
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,3 +1,13 @@
The purpose of this script is to backup the contents of Docker container-based database (either PostgreSQL or MariaDB) to a local 'dump' file (SQL format), which is then compressed to conserve disk space.
The system is designed to be run regularly (perhaps hourly, or daily) via cron, and to keep a pre-determined (via configuration) number of past, deleting excess backup files to conserve disk space.
## To install
To install this script, by our convention on Docker Compose hosts, we clone it into `/home/data/scripts` (creating the directory if necessary), via `git clone git@git.oeru.org:oeru/docker-compose-dbbackup.git`.
Then, in that directory, we copy the relevant '\*.conf-sample' configuration file and copy it to a '\*.conf' file and adjust its values. You can try running the backup to test it by running (for example)
`./mariadbbackup-docker-compose --hourly`
which should, if the configuration is valid, create an hourly database backup (starting with the database name with '-hourly' affixed, e.g. )