Skip to content

Commit

Permalink
docs: add POSTBACKUPSCRIPT variable and usage instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jmaddington committed Nov 24, 2024
1 parent 9e663b3 commit 84a86d8
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ KEY="
pgpkey
...
"
POSTBACKUPSCRIPT="/scripts/post-backup.sh"
```

For example, if you back up both a development and production database, each would have their
Expand All @@ -50,6 +51,9 @@ ever touch the disk.** The backup is piped to gzip, then to gpg, then to the mou

PGPKey needs to be an actual, public, PGP key. Everything will be encrypted with this key.

`POSTBACKUPSCRIPT` is optional. If set, the script will be run after the backup completes __successfully__. The first and only argument to the script will be the full path to the backup file. A sample script is included in the `scripts` directory.
- You can add your own scripts to the `scripts` directory and mount them to the container at `/scripts` to use them.

## Docker Compose
Edit your docker-compose file to create a service for each database backup configuration you
want to run. For example:
Expand Down

0 comments on commit 84a86d8

Please sign in to comment.