Skip to content

Commit f2139d8

Browse files
committed
Update README
1 parent 87c590b commit f2139d8

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

README.md

+15-18
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,23 @@ Configuration for pg2s3 is handled exclusively through a config file written in
2020
By default, pg2s3 will look for a config file named `pg2s3.conf` in the current directory.
2121
This file can be overridden by using the `-conf` flag.
2222

23-
Note that the S3 bucket defined by `s3_bucket_name` must be created outside of this tool.
23+
Note that the S3 bucket defined by `s3_url` must be created outside of this tool.
2424
Bucket creation has more configuration and security options than pg2s3 is positioned to deal with.
2525

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

3030
The following settings are required to run pg2s3:
3131

32-
| Setting | Required? | Description |
33-
| ---------------------- | --------- | ----------- |
34-
| `pg_connection_uri` | Yes | PostgreSQL connection string |
35-
| `s3_endpoint` | Yes | S3-compatible storage endpoint |
36-
| `s3_access_key_id` | Yes | S3-compatible storage access key ID |
37-
| `s3_secret_access_key` | Yes | S3-compatible storage secret access key |
38-
| `s3_bucket_name` | Yes | S3-compatible storage bucket name |
39-
| `backup_prefix` | No | Prefix attached to the name of each backup (default `"pg2s3"`) |
40-
| `backup_retention` | No | Number of backups to retain after pruning |
41-
| `backup_schedule` | No | Backup schedule as a standard cron expression (UTC) |
42-
| `restore_schemas` | No | List of schemas to restore (default `["public"]`) |
32+
| Setting | Required? | Description |
33+
| ------------------ | --------- | ----------- |
34+
| `pg_url` | Yes | PostgreSQL connection string |
35+
| `s3_url` | Yes | S3-compatible storage connection string |
36+
| `backup.prefix` | No | Prefix attached to the name of each backup (default `"pg2s3"`) |
37+
| `backup.retention` | No | Number of backups to retain after pruning |
38+
| `backup.schedule` | No | Backup schedule as a standard cron expression (UTC) |
39+
| `restore.schemas` | No | List of schemas to restore (default `["public"]`) |
4340

4441
## Encryption
4542
Backups managed by pg2s3 can be optionally encrypted using [age](https://github.com/FiloSottile/age).
@@ -48,17 +45,17 @@ Note that the private key associated with this public key must be kept safe and
4845
When restoring a backup, pg2s3 will prompt for the private key.
4946
This key is intentionally absent from pg2s3's configuration in order to require user intervention for any data decryption.
5047

51-
| Setting | Required? | Description |
52-
| ---------------- | --------- | ----------- |
53-
| `age_public_key` | No | Public key for backup encryption |
48+
| Setting | Required? | Description |
49+
| ------------------------ | --------- | ----------- |
50+
| `encryption.public_keys` | No | Public keys for backup encryption |
5451

5552
## Usage
5653
The pg2s3 command-line tool offers three mutually-exclusive actions:
5754
* `pg2s3 -backup` - Create a new backup and upload to S3
5855
* `pg2s3 -restore` - Download the latest backup from S3 and restore
5956
* `pg2s3 -prune` - Prune old backups from S3
6057

61-
If none of these are provided, pg2s3 will attempt to run in scheduled mode: sleeping until `backup_schedule` arrives and then performing a backup + prune.
58+
If none of these are provided, pg2s3 will attempt to run in scheduled mode: sleeping until `backup.schedule` arrives and then performing a backup + prune.
6259

6360
## Local Development
6461
To develop and test locally, containers for [PostgreSQL](https://www.postgresql.org/) and [MinIO](https://min.io/) must be running:

0 commit comments

Comments
 (0)