tyler/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: simplify list of ENV var alternative

Browse Source 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2021-07-22 10:21:40 +02:00
parent 99a73fad15
commit 65ab4ca976
1 changed files with 8 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/backup-client.rst
View File

@ -49,36 +49,19 @@ Environment Variables
When set, this value is used for the password required for the backup server. When set, this value is used for the password required for the backup server.
You can also set this to a API token secret. You can also set this to a API token secret.
.. Note:: if not set, we also query ``PBS_PASSWORD_FD``, ``PBS_PASSWORD_FD``, ``PBS_PASSWORD_FILE``, ``PBS_PASSWORD_CMD``
``PBS_PASSWORD_FILE`` and ``PBS_PASSWORD_CMD`` (in that order) Like ``PBS_PASSWORD``, but read data from an open file descriptor, a file
and return the first value set. name or from the `stdout` of a command, respectively. The first defined
environment variable from the order above is preferred.
``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`` ``PBS_ENCRYPTION_PASSWORD``
When set, this value is used to access the secret encryption key (if When set, this value is used to access the secret encryption key (if
protected by password). protected by password).
.. Note:: if not set, we also query ``PBS_ENCRYPTION_PASSWORD_FD``, ``PBS_ENCRYPTION_PASSWORD_FD``, ``PBS_ENCRYPTION_PASSWORD_FILE``, ``PBS_ENCRYPTION_PASSWORD_CMD``
``PBS_ENCRYPTION_PASSWORD_FILE`` and Like ``PBS_ENCRYPTION_PASSWORD``, but read data from an open file descriptor,
``PBS_ENCRYPTION_PASSWORD_CMD`` (in that order) and return the a file name or from the `stdout` of a command, respectively. The first
first value set. defined environment variable from the order above is preferred.
``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 ``PBS_FINGERPRINT`` When set, this value is used to verify the server
certificate (only used if the system CA certificates cannot validate the certificate (only used if the system CA certificates cannot validate the