Skip to content

Commit e588318

Browse files
authored
v3.1.5 (#100)
Documentation updates * Adding sample compose file * Updating environment variables in README.md * Adding link to Nu duration definitions
1 parent 8901302 commit e588318

File tree

3 files changed

+33
-12
lines changed

3 files changed

+33
-12
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
[Docker Repository](https://hub.docker.com/r/bfren/postgresql) - [bfren ecosystem](https://github.com/bfren/docker)
66

7-
[PostgreSQL](https://www.postgresql.org/) comes pre-installed (12, 13, 14 or 15) with automatic backups built-in.
7+
[PostgreSQL](https://www.postgresql.org/) comes pre-installed (12, 13, 14, 15 or 16) with automatic backups built-in.
88

99
## Contents
1010

@@ -40,19 +40,19 @@ See [For Backups](#for-backups) for configuration variables.
4040

4141
### For Backups
4242

43-
| Variable | Values | Description | Default |
44-
| ----------------------------- | ------------- | ----------------------------------------------------- | --------- |
45-
| `PG_BACKUP_COMPRESS_FILES` | 0 or 1 | Whether or not to compress backup files (using bzip). | 0 |
46-
| `BF_PG_BACKUP_KEEP_FOR` | Nu duration | The length of time to keep backups. | 28day |
43+
| Variable | Values | Description | Default |
44+
| ----------------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------- | --------- |
45+
| `BF_PG_BACKUP_COMPRESS_FILES` | 0 or 1 | Whether or not to compress backup files (using bzip). | 0 |
46+
| `BF_PG_BACKUP_KEEP_FOR` | [Nu duration](https://www.nushell.sh/book/types_of_data.html#durations) | The length of time to keep backups. | 28day |
4747

4848
### For Database
4949

50-
| Variable | Values | Description | Default |
51-
| ----------------- | ------ | -------------------------------------------------------------------------------------------------------- | --------- |
52-
| `PG_APPLICATION` | string | Application name - will be used as `PG_DATABASE`, `PG_PASSWORD` and `PG_USERNAME` if they are not set. | *None* |
53-
| `PG_DATABASE` | string | Database name(s) - multiple databases can be separated by a comma. | *None* |
54-
| `PG_PASSWORD` | string | Application password. | *None* |
55-
| `PG_USERNAME` | string | Application username. | *None* |
50+
| Variable | Values | Description | Default |
51+
| --------------------- | ------ | ---------------------------------------------------------------------------------------------------------------- | --------- |
52+
| `BF_PG_APPLICATION` | string | Application name - will be used as `BF_PG_DATABASE`, `BF_PG_PASSWORD` and `BF_PG_USERNAME` if they are not set. | *None* |
53+
| `BF_PG_DATABASE` | string | Database name(s) - multiple databases can be separated by a comma. | *None* |
54+
| `BF_PG_PASSWORD` | string | Application password. | *None* |
55+
| `BF_PG_USERNAME` | string | Application username. | *None* |
5656

5757
## Helper Functions
5858

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.1.4
1+
3.1.5

docker-compose.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
version: "3.8"
2+
3+
services:
4+
pgsql:
5+
image: bfren/postgresql:postgresql16
6+
container_name: pgsql
7+
restart: unless-stopped
8+
environment:
9+
- BF_PG_BACKUP_COMPRESS_FILES=1
10+
- BF_PG_BACKUP_KEEP_FOR=2month
11+
- BF_PG_APPLICATION=test
12+
volumes:
13+
- ./v/db:/data
14+
- ./v/db-backup:/backup
15+
networks:
16+
- pgsql
17+
18+
networks:
19+
pgsql:
20+
driver: bridge
21+
name: pgsql

0 commit comments

Comments
 (0)