From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 42CA677819 for ; Wed, 21 Jul 2021 12:00:28 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 36CEC12915 for ; Wed, 21 Jul 2021 11:59:58 +0200 (CEST) Received: from elsa.proxmox.com (unknown [94.136.29.99]) by firstgate.proxmox.com (Proxmox) with ESMTP id 6D2BE12903 for ; Wed, 21 Jul 2021 11:59:57 +0200 (CEST) Received: by elsa.proxmox.com (Postfix, from userid 0) id 4B149AE05D2; Wed, 21 Jul 2021 11:59:57 +0200 (CEST) From: Dietmar Maurer To: pbs-devel@lists.proxmox.com Date: Wed, 21 Jul 2021 11:59:55 +0200 Message-Id: <20210721095955.841384-2-dietmar@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210721095955.841384-1-dietmar@proxmox.com> References: <20210721095955.841384-1-dietmar@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.453 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RDNS_NONE 0.793 Delivered to internal network by a host with no rDNS SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH proxmox-backup v2 2/2] doc: Document new environment vars to specify secret values X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 21 Jul 2021 10:00:28 -0000 --- 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 ------------- -- 2.30.2