mirror of
https://github.com/garraflavatra/docker-volume-s3-backup.git
synced 2025-07-19 08:04:04 +00:00
script cleanup, misc changes
- --blobs by default - always drop and recreate schemas, specified by DROP_SCHEMAS
This commit is contained in:
43
README.md
43
README.md
@ -1,5 +1,5 @@
|
||||
# Overview
|
||||
This project provides Docker containers to backup/restore a PostgreSQL database to/from AWS S3 (or a compatible service like DigitalOcean Spaces). Both one-off and periodic/scheduled backups are supported.
|
||||
# Introduction
|
||||
This project provides Docker images to periodically backup a PostgreSQL database to AWS S3, and to restore from the backup as needed.
|
||||
|
||||
# Credit where due
|
||||
This repository is a fork and re-structuring of schickling's [postgres-backup-s3](https://github.com/schickling/dockerfiles/tree/master/postgres-backup-s3) and [postgres-restore-s3](https://github.com/schickling/dockerfiles/tree/master/postgres-restore-s3).
|
||||
@ -8,8 +8,16 @@ Fork goals:
|
||||
- [x] dedicated repository
|
||||
- [x] automated builds
|
||||
- [x] support multiple PostgreSQL versions
|
||||
- [ ] support encrypted (password-protected) backups
|
||||
- [x] merge backup and restore images?
|
||||
- [x] support encrypted (password-protected) backups
|
||||
- [x] option to restore from specific backup by timestamp
|
||||
|
||||
Other changes:
|
||||
- uses `pg_dump`'s `custom` format (see [docs](https://www.postgresql.org/docs/10/app-pgdump.html))
|
||||
- backup blobs and all schemas by default
|
||||
- recreate all database objects on restore
|
||||
- some env vars renamed
|
||||
- only scheduled backups supported, not ad-hoc
|
||||
|
||||
-------
|
||||
|
||||
@ -17,15 +25,16 @@ Fork goals:
|
||||
## Backup
|
||||
```yaml
|
||||
postgres:
|
||||
image: postgres
|
||||
image: postgres:11
|
||||
environment:
|
||||
POSTGRES_USER: user
|
||||
POSTGRES_PASSWORD: password
|
||||
|
||||
pgbackups3:
|
||||
image: eeshugerman/postgres-backup-s3
|
||||
image: eeshugerman/postgres-backup-s3:11
|
||||
environment:
|
||||
SCHEDULE: '@daily'
|
||||
PASSPHRASE: passphrase
|
||||
S3_REGION: region
|
||||
S3_ACCESS_KEY_ID: key
|
||||
S3_SECRET_ACCESS_KEY: secret
|
||||
@ -34,17 +43,27 @@ pgbackups3:
|
||||
POSTGRES_DATABASE: dbname
|
||||
POSTGRES_USER: user
|
||||
POSTGRES_PASSWORD: password
|
||||
POSTGRES_EXTRA_OPTS: '--schema=public --blobs'
|
||||
```
|
||||
### Notes
|
||||
#### Periodic backups
|
||||
The `SCHEDULE` variable is determines backup frequency. It is optional -- without it, the backup will run once at start up. More information about the scheduling can be found [here](http://godoc.org/github.com/robfig/cron#hdr-Predefined_schedules).
|
||||
|
||||
#### Docker
|
||||
Docker Compose is by no means required, you can use plain ol' Docker too -- just set the required env vars with the `-e` flag.
|
||||
#### PostgreSQL version
|
||||
Images are tagged by the major PostgreSQL version they support: `9`, `10`, `11`, or `12`.
|
||||
#### Scheduling
|
||||
The `SCHEDULE` variable is determines backup frequency. See go-cron schedules documentation [here](http://godoc.org/github.com/robfig/cron#hdr-Predefined_schedules).
|
||||
#### Encrypted backups
|
||||
If `PASSPHRASE` is provided, the backup will be encrypted using GPG.
|
||||
|
||||
## Restore
|
||||
With the container running,
|
||||
> WARNING: DATA LOSS! All database objects will be dropped and recreated.
|
||||
|
||||
### From latest backup (based on unix sort)
|
||||
```sh
|
||||
docker exec <container name> sh restore.sh
|
||||
```
|
||||
#### Notes
|
||||
- If your bucket has more than a 1000 files the latest may not be restored, only one S3 `ls` command is used
|
||||
- Your S3 prefix should only contain backups which you wish to restore - 'latest' is determined based on unix sort with no filtering
|
||||
|
||||
### From specific backup
|
||||
```sh
|
||||
docker exec <container name> sh restore.sh <timestamp>
|
||||
```
|
||||
|
Reference in New Issue
Block a user