jkaninda/pg-bkup
1
0
Fork 0
Code Issues Pull Requests Actions Projects Releases Wiki Activity

docs: add manual gpg decrypt example

Browse Source
This commit is contained in:
Jonas Kaninda
2024-08-03 02:04:58 +02:00
parent 4d7394ca2e
commit f5fd15bad6
4 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/build.yml vendored
View File

@@ -1,7 +1,7 @@
name: Build name: Build
on: on:
push: push:
branches: [ "main","v1.0"] branches: [ "main"]
workflow_dispatch: workflow_dispatch:
inputs: inputs:
docker_tag: docker_tag:
@@ -46,5 +46,7 @@ jobs:
platforms: linux/amd64,linux/arm64,linux/arm/v7 platforms: linux/amd64,linux/arm64,linux/arm/v7
tags: | tags: |
"${{env.BUILDKIT_IMAGE}}:${{env.TAG}}" "${{env.BUILDKIT_IMAGE}}:${{env.TAG}}"
"${{env.BUILDKIT_IMAGE}}:latest"
"ghcr.io/${{env.BUILDKIT_IMAGE}}:${{env.TAG}}" "ghcr.io/${{env.BUILDKIT_IMAGE}}:${{env.TAG}}"
"ghcr.io/${{env.BUILDKIT_IMAGE}}:latest"

2
README.md
View File

@@ -1,5 +1,5 @@
# PostgreSQL Backup # 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. It also supports __encrypting__ your backups using GPG.
--- ---

8
docs/how-tos/encrypt-backup.md
View File

@@ -11,6 +11,14 @@ The image supports encrypting backups using GPG out of the box. In case a `GPG_P
{: .warning } {: .warning }
To restore an encrypted backup, you need to provide the same GPG passphrase used during backup process. 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 ### Backup
```yml ```yml

2
docs/index.md
View File

@@ -6,7 +6,7 @@ nav_order: 1
# About pg-bkup # About pg-bkup
{:.no_toc} {:.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. It also supports __encrypting__ your backups using GPG.
We are open to receiving stars, PRs, and issues! We are open to receiving stars, PRs, and issues!