From f5fd15bad6568d6dac6fdf5361a2fb2d005f982f Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Sat, 3 Aug 2024 02:04:58 +0200 Subject: [PATCH] docs: add manual gpg decrypt example --- .github/workflows/build.yml | 4 +++- README.md | 2 +- docs/how-tos/encrypt-backup.md | 8 ++++++++ docs/index.md | 2 +- 4 files changed, 13 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c28f510..5465d2f 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,7 +1,7 @@ name: Build on: push: - branches: [ "main","v1.0"] + branches: [ "main"] workflow_dispatch: inputs: docker_tag: @@ -46,5 +46,7 @@ jobs: platforms: linux/amd64,linux/arm64,linux/arm/v7 tags: | "${{env.BUILDKIT_IMAGE}}:${{env.TAG}}" + "${{env.BUILDKIT_IMAGE}}:latest" "ghcr.io/${{env.BUILDKIT_IMAGE}}:${{env.TAG}}" + "ghcr.io/${{env.BUILDKIT_IMAGE}}:latest" diff --git a/README.md b/README.md index dc86835..6076720 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # PostgreSQL Backup -pg-bkup it's a Docker container image that can be used to backup and restore Postgres database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH compatible storage. +pg-bkup is a Docker container image that can be used to backup and restore Postgres database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH compatible storage. It also supports __encrypting__ your backups using GPG. --- diff --git a/docs/how-tos/encrypt-backup.md b/docs/how-tos/encrypt-backup.md index 2065dca..8213aaf 100644 --- a/docs/how-tos/encrypt-backup.md +++ b/docs/how-tos/encrypt-backup.md @@ -11,6 +11,14 @@ The image supports encrypting backups using GPG out of the box. In case a `GPG_P {: .warning } To restore an encrypted backup, you need to provide the same GPG passphrase used during backup process. +To decrypt manually, you need to install gpg + +```shell +gpg --batch --passphrase "my-passphrase" \ +--output database_20240730_044201.sql.gz \ +--decrypt database_20240730_044201.sql.gz.gpg +``` + ### Backup ```yml diff --git a/docs/index.md b/docs/index.md index 0e4f20e..03fe288 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,7 @@ nav_order: 1 # About pg-bkup {:.no_toc} -pg-bkup it's a Docker container image that can be used to backup and restore Postgres database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH compatible storage. +pg-bkup is a Docker container image that can be used to backup and restore Postgres database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, and SSH compatible storage. It also supports __encrypting__ your backups using GPG. We are open to receiving stars, PRs, and issues!