romein/docker-volume-s3-backup
1
0
Fork 0
mirror of https://github.com/garraflavatra/docker-volume-s3-backup.git synced 2025-05-17 13:14:38 +00:00
Code Issues

README updates

Browse Source
This commit is contained in:
Elliott Shugerman 2019-11-27 21:24:31 -07:00
parent 3e05233a2a
commit 0be995995b
1 changed files with 9 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,6 +1,8 @@
This is a fork and restructuring 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).
# 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.
See [`backup/README.md`](/backup/README.md) and [`restore/README.md`](/restore/README.md) for further instructions.
# 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).
Fork goals:
- [x] dedicated repository
@ -13,22 +15,6 @@ Fork goals:
# Usage
## Backup
### Docker
```sh
$ docker run \
-e S3_ACCESS_KEY_ID=key \
-e S3_SECRET_ACCESS_KEY=secret \
-e S3_BUCKET=my-bucket \
-e S3_PREFIX=backup \
-e POSTGRES_DATABASE=dbname \
-e POSTGRES_USER=user \
-e POSTGRES_PASSWORD=password \
-e POSTGRES_HOST=localhost \
eeshugerman/postgres-backup-s3
```
### Docker Compose
```yaml
postgres:
image: postgres
@ -38,9 +24,6 @@ postgres:
pgbackups3:
image: eeshugerman/postgres-backup-s3
container_name: pg-backup
links:
- postgres
environment:
SCHEDULE: '@daily'
S3_REGION: region
@ -53,12 +36,12 @@ pgbackups3:
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).
### Automatic Periodic Backups
You can additionally set the `SCHEDULE` environment variable like `-e SCHEDULE="@daily"` to run the backup automatically.
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.
## Restore
With the container running,