From 99a73fad157e497e8dc1cdf99bc894ada0bd5d5b Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Wed, 21 Jul 2021 11:59:55 +0200 Subject: [PATCH] doc: Document new environment variabless to specify secret values Signed-off-by: Thomas Lamprecht --- docs/backup-client.rst | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/docs/backup-client.rst b/docs/backup-client.rst index bd0fdfed..df98d540 100644 --- a/docs/backup-client.rst +++ b/docs/backup-client.rst @@ -49,15 +49,48 @@ Environment Variables When set, this value is used for the password required for the backup server. You can also set this to a API token secret. + .. Note:: if not set, we also query ``PBS_PASSWORD_FD``, + ``PBS_PASSWORD_FILE`` and ``PBS_PASSWORD_CMD`` (in that order) + and return the first value set. + +``PBS_PASSWORD_FD`` + Like ``PBS_PASSWORD``, but read data from Unix file descriptor. + +``PBS_PASSWORD_FILE`` + Like ``PBS_PASSWORD``, but read data from specified file name. + +``PBS_PASSWORD_CMD`` + Like ``PBS_PASSWORD``, but read data from specified command (stdout). + ``PBS_ENCRYPTION_PASSWORD`` When set, this value is used to access the secret encryption key (if protected by password). + .. Note:: if not set, we also query ``PBS_ENCRYPTION_PASSWORD_FD``, + ``PBS_ENCRYPTION_PASSWORD_FILE`` and + ``PBS_ENCRYPTION_PASSWORD_CMD`` (in that order) and return the + first value set. + +``PBS_ENCRYPTION_PASSWORD_FD`` + Like ``PBS_ENCRYPTION_PASSWORD``, but read data from Unix file descriptor. + +``PBS_ENCRYPTION_PASSWORD_FILE`` + Like ``PBS_ENCRYPTION_PASSWORD``, but read data from specified file name. + +``PBS_ENCRYPTION_PASSWORD_CMD`` + Like ``PBS_ENCRYPTION_PASSWORD``, but read data from specified command (stdout). + ``PBS_FINGERPRINT`` When set, this value is used to verify the server certificate (only used if the system CA certificates cannot validate the certificate). +.. Note:: Passwords must be valid UTF8 an may not contain + newlines. For your convienience, we just use the first line as + password, so you can add arbitrary comments after the + first newline. + + Output Format -------------