Add more information to README
This commit is contained in:
parent
7a9c97e4e0
commit
f30ddb4b43
1 changed files with 26 additions and 0 deletions
26
README.md
26
README.md
|
@ -1,3 +1,29 @@
|
|||
# Postgresql backuper
|
||||
|
||||
A small program for creating postgresql backups at certain intervals.
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
| Env variable | Description | Default in docker |
|
||||
| --- | --- | --- |
|
||||
| BACKUPS_DIR | | /backups |
|
||||
| PGDUMP_BINARY | | pg_dumpall |
|
||||
| CUSTOM_ARGS | Arguments passed to PGDUMP_BINARY. Don't use `-f`. | |
|
||||
| BACKUP_INTERVAL | Time between backups. | 24h |
|
||||
| RETENTION | Backups older than the RETENTION period will be deleted. | 168h |
|
||||
|
||||
The duration must be in a format understood by the golang's `time` package.
|
||||
|
||||
|
||||
## Docker-compose example
|
||||
|
||||
```yml
|
||||
services:
|
||||
backuper:
|
||||
image: git.comfycamp.space/lumin/postgresql-backuper
|
||||
environment:
|
||||
CUSTOM_ARGS: "-U postgres -h postgresql --no-password"
|
||||
volumes:
|
||||
- postgresql-backups:/backups
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue