diff --git a/README.md b/README.md index da935b5..b474f94 100644 --- a/README.md +++ b/README.md @@ -2,26 +2,26 @@ * Takes the dump of the Postgres database * Uploads it to AWS' object storage service S3 -* Reports to WebGazer Pulse (optional) +* Reports to [WebGazer](https://www.webgazer.io) (optional) ## Usage ### Environment variables -| Variable | Required | Default value | Description | -|-----------------------|:--------:|---------------|-------------------------------------------------------------------------------------------------------------------------------| -| AWS_ACCESS_KEY_ID | ✔ | | Access key id for the AWS account | -| AWS_REGION | ✔ | | Region for the AWS bucket | -| AWS_S3_ENDPOINT | ✔ | | AWS S3 endpoint with bucket and path (e.g. "my-bucket/postgres-backup") | -| AWS_S3_STORAGE_CLASS | | STANDARD_IA | AWS S3 storage class (see https://aws.amazon.com/s3/storage-classes/ and https://rclone.org/s3/#s3-storage-class for options. | -| AWS_SECRET_ACCESS_KEY | ✔ | | Secret access key for the AWS account | -| POSTGRES_DB | ✔ | | Postgres server database | -| POSTGRES_HOST | | postgres | Postgres server host | -| POSTGRES_PASSWORD | ✔ | | Postgres server password | -| POSTGRES_PORT | | 5432 | Postgres server port | -| POSTGRES_USER | | postgres | Postgres server user | -| POSTGRES_VERSION | | 16 | Postgres server version (13, 14, 15 or 16) | -| WEBGAZER_PULSE_URL | | | [WebGazer Pulse](https://www.webgazer.io/pulse) URL | +| Variable | Required | Default value | Description | +|------------------------|:--------:|---------------|-------------------------------------------------------------------------------------------------------------------------------| +| AWS_ACCESS_KEY_ID | ✔ | | Access key id for the AWS account | +| AWS_REGION | ✔ | | Region for the AWS bucket | +| AWS_S3_ENDPOINT | ✔ | | AWS S3 endpoint with bucket and path (e.g. "my-bucket/postgres-backup") | +| AWS_S3_STORAGE_CLASS | | STANDARD_IA | AWS S3 storage class (see https://aws.amazon.com/s3/storage-classes/ and https://rclone.org/s3/#s3-storage-class for options. | +| AWS_SECRET_ACCESS_KEY | ✔ | | Secret access key for the AWS account | +| POSTGRES_DB | ✔ | | Postgres server database | +| POSTGRES_HOST | | postgres | Postgres server host | +| POSTGRES_PASSWORD | ✔ | | Postgres server password | +| POSTGRES_PORT | | 5432 | Postgres server port | +| POSTGRES_USER | | postgres | Postgres server user | +| POSTGRES_VERSION | | 16 | Postgres server version (13, 14, 15 or 16) | +| WEBGAZER_HEARTBEAT_URL | | | [WebGazer Heartbeat Monitor](https://www.webgazer.io/services/cron-job-monitoring) URL | ### Running @@ -37,7 +37,7 @@ -e POSTGRES_PORT= \ -e POSTGRES_USER= \ -e POSTGRES_VERSION= \ - -e WEBGAZER_PULSE_URL= + -e WEBGAZER_HEARTBEAT_URL= ### Example @@ -53,7 +53,7 @@ -e POSTGRES_PORT=5432 \ -e POSTGRES_USER=postgres_user \ -e POSTGRES_VERSION=15 \ - -e WEBGAZER_PULSE_URL=https://pulse.webgazer.io/1-8f713c75d659 + -e WEBGAZER_HEARTBEAT_URL=https://heartbeat.webgazer.io/1-8f713c75d659 ## Shameless plug diff --git a/docker-entrypoint.sh b/docker-entrypoint.sh index 593bec0..3e190aa 100644 --- a/docker-entrypoint.sh +++ b/docker-entrypoint.sh @@ -47,6 +47,6 @@ rclone copyto \ ":s3,access_key_id=${AWS_ACCESS_KEY_ID},provider=AWS,region=${AWS_REGION},secret_access_key=${AWS_SECRET_ACCESS_KEY},storage_class=${AWS_S3_STORAGE_CLASS}:${AWS_S3_ENDPOINT}/${BACKUP_FILE_NAME}" echo "Uploading to S3... Done." -if [ -n "${WEBGAZER_PULSE_URL}" ]; then - curl "${WEBGAZER_PULSE_URL}?seconds=${SECONDS}" +if [ -n "${WEBGAZER_HEARTBEAT_URL}" ]; then + curl "${WEBGAZER_HEARTBEAT_URL}?seconds=${SECONDS}" fi