diff --git a/docs/how-tos/encrypt-backup.md b/docs/how-tos/encrypt-backup.md index 7137e4c..b7600f3 100644 --- a/docs/how-tos/encrypt-backup.md +++ b/docs/how-tos/encrypt-backup.md @@ -1,29 +1,39 @@ --- -title: Encrypt backups using GPG +title: Encrypt backups layout: default parent: How Tos nav_order: 8 --- # Encrypt backup -The image supports encrypting backups using GPG out of the box. In case a `GPG_PASSPHRASE` environment variable is set, the backup archive will be encrypted using the given key and saved as a sql.gpg file instead or sql.gz.gpg. +The image supports encrypting backups using one of two available methods: GPG with passphrase or GPG with a public key + +## Using GPG passphrase + +The image supports encrypting backups using GPG out of the box. In case a `GPG_PASSPHRASE` or `GPG_PUBLIC_KEY` environment variable is set, the backup archive will be encrypted using the given key and saved as a sql.gpg file instead or sql.gz.gpg. {: .warning } -To restore an encrypted backup, you need to provide the same GPG passphrase or key used during backup process. +To restore an encrypted backup, you need to provide the same GPG passphrase used during backup process. - GPG home directory `/config/gnupg` - Cipher algorithm `aes256` -- -To decrypt manually, you need to install `gnupg` -### Decrypt backup +{: .note } +The backup encrypted using `GPG passphrase` method can be restored automatically, no need to decrypt it before restoration. + + +To decrypt manually, you need to install `gnupg` ```shell gpg --batch --passphrase "my-passphrase" \ --output database_20240730_044201.sql.gz \ --decrypt database_20240730_044201.sql.gz.gpg ``` +Using your private key +```shell +gpg --output database_20240730_044201.sql.gz --decrypt database_20240730_044201.sql.gz.gpg +``` ### Backup ```yml