You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-7
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,11 @@ This project strives to be a simple and reliable backup solution for [PostgreSQL
6
6
In general, pg2s3 dumps a given database and uploads it to an S3-compatible storage bucket.
7
7
However, there is a bit more nuance involved in bookkeeping, restoration, and pruning.
8
8
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
-
13
9
## 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.
15
12
Check the [releases page](https://github.com/theandrew168/pg2s3/releases) to find and download the latest version.
13
+
16
14
Additionally, the environment where pg2s3 is executed must have `pg_dump` and `pg_restore` installed.
17
15
These tools are part of the collection of [PostgreSQL Client Applications](https://www.postgresql.org/docs/12/reference-client.html).
18
16
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
27
25
28
26
Additionally, the value defined by `backup_retention` simply refers to the _number_ of backups kept during a prune.
29
27
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.
31
29
32
30
The following settings are required to run pg2s3:
33
31
@@ -40,7 +38,7 @@ The following settings are required to run pg2s3:
40
38
|`s3_bucket_name`| Yes | S3-compatible storage bucket name |
41
39
|`backup_prefix`| Yes | Prefix attached to the name of each backup |
42
40
|`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) |
44
42
45
43
## Encryption
46
44
Backups managed by pg2s3 can be optionally encrypted using [age](https://github.com/FiloSottile/age).
0 commit comments