offen/docker-volume-backup
2
0
Fork 0
mirror of https://github.com/offen/docker-volume-backup.git synced 2025-02-23 08:20:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Configuration reference on age encryption is lacking

Browse Source
This commit is contained in:
Frederik Ring 2025-02-04 16:34:10 +01:00
parent e628f09122
commit 40b12b9d07
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/how-tos/encrypt-backups.md
View File

@ -21,6 +21,10 @@ gpg -o backup.tar.gz -d backup.tar.gz.gpg
## Using age encryption ## Using age encryption
{: .note }
Even though the `age` CLI tools supports encryption using SSH keys, this is not supported by this tool.
`AGE_PUBLIC_KEYS` currently expects `age` keys to be given.
age allows backups to be encrypted with either a symmetric key (password) or a public key. One of those options are available for use. age allows backups to be encrypted with either a symmetric key (password) or a public key. One of those options are available for use.
Given `AGE_PASSPHRASE` being provided, the backup archive will be encrypted with the passphrase and saved as a `.age` file instead. Refer to age documentation for how to properly decrypt. Given `AGE_PASSPHRASE` being provided, the backup archive will be encrypted with the passphrase and saved as a `.age` file instead. Refer to age documentation for how to properly decrypt.

13
docs/reference/index.md
View File

@ -337,6 +337,9 @@ You can populate below template according to your requirements and use it as you
########### BACKUP ENCRYPTION ########### BACKUP ENCRYPTION
# All of the encryption options are mutually exclusive. Provide a single option
# for the encryption scheme of your choice.
# Backups can be encrypted symmetrically using gpg in case a passphrase is given. # Backups can be encrypted symmetrically using gpg in case a passphrase is given.
# GPG_PASSPHRASE="<xxx>" # GPG_PASSPHRASE="<xxx>"
@ -350,6 +353,16 @@ You can populate below template according to your requirements and use it as you
#... #...
#-----END PGP PUBLIC KEY BLOCK----- #-----END PGP PUBLIC KEY BLOCK-----
# Backups can be encrypted symmetrically using age in case a passphrase is given.
# AGE_PASSPHRASE="<xxx>"
# Backups can be encrypted asymmetrically using age in case publickeys are given.
# Multiple keys need to be provided as a comma separated list. Right now, this only
# support passing age keys, with no support for ssh keys.
# AGE_PUBLIC_KEYS="<xxx>"
########### STOPPING CONTAINERS AND SERVICES DURING BACKUP ########### STOPPING CONTAINERS AND SERVICES DURING BACKUP
# Containers or services can be stopped by applying a # Containers or services can be stopped by applying a