Skip to content

Commit 9f81958

Browse files
committed
Update README
1 parent 1a5955f commit 9f81958

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,11 @@ This project strives to be a simple and reliable backup solution for [PostgreSQL
66
In general, pg2s3 dumps a given database and uploads it to an S3-compatible storage bucket.
77
However, there is a bit more nuance involved in bookkeeping, restoration, and pruning.
88

9-
That being said, some features are intentionally left out of scope for this project.
10-
For example, PostgreSQL is the only supported database and S3 is the only supported storage method.
11-
The scheduling of periodic backups is also left out: rely on tools such as [cron](https://wiki.archlinux.org/title/cron) or [systemd timers](https://wiki.archlinux.org/title/Systemd/Timers) to handle the timing and frequency of programmatic backups.
12-
139
## Install
14-
The pg2s3 tool is distributed as a single, static binary.
10+
The pg2s3 tool is distributed as a single, static binary for all major platforms.
11+
It is also released as a `.deb` for Debian-based Linux environments.
1512
Check the [releases page](https://github.com/theandrew168/pg2s3/releases) to find and download the latest version.
13+
1614
Additionally, the environment where pg2s3 is executed must have `pg_dump` and `pg_restore` installed.
1715
These tools are part of the collection of [PostgreSQL Client Applications](https://www.postgresql.org/docs/12/reference-client.html).
1816
On an Ubuntu server, these tools are contained within the package `postgresql-client-<version>` based on the major version of PostgreSQL being used.
@@ -27,7 +25,7 @@ Bucket creation has more configuration and security options than pg2s3 is positi
2725

2826
Additionally, the value defined by `backup_retention` simply refers to the _number_ of backups kept during a prune.
2927
It has nothing to do with a backup's age or total bucket size.
30-
If programmatic backups are in use, you'll want to consider the scheduling frequency when determining an appropriate retention count.
28+
If `backups_schedule` is set, you'll want to consider the scheduling frequency when determining an appropriate retention count.
3129

3230
The following settings are required to run pg2s3:
3331

@@ -40,7 +38,7 @@ The following settings are required to run pg2s3:
4038
| `s3_bucket_name` | Yes | S3-compatible storage bucket name |
4139
| `backup_prefix` | Yes | Prefix attached to the name of each backup |
4240
| `backup_retention` | No | Number of backups to retain after pruning |
43-
| `backup_schedule` | No | Backup schedule as a standard cron expression |
41+
| `backup_schedule` | No | Backup schedule as a standard cron expression (UTC) |
4442

4543
## Encryption
4644
Backups managed by pg2s3 can be optionally encrypted using [age](https://github.com/FiloSottile/age).

0 commit comments

Comments
 (0)