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 E9AD6959CC for ; Thu, 19 Jan 2023 11:41:14 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id C377A2ABED for ; Thu, 19 Jan 2023 11:40:44 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (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 firstgate.proxmox.com (Proxmox) with ESMTPS for ; Thu, 19 Jan 2023 11:40:43 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 448ED448DE for ; Thu, 19 Jan 2023 11:40:43 +0100 (CET) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Thu, 19 Jan 2023 11:40:41 +0100 Message-Id: <20230119104041.264052-2-l.wagner@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230119104041.264052-1-l.wagner@proxmox.com> References: <20230119104041.264052-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.142 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 SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [squid-cache.org] Subject: [pve-devel] [PATCH proxmox-offline-mirror 2/2] docs: document `ALL_PROXY` environment variable X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 19 Jan 2023 10:41:15 -0000 Signed-off-by: Lukas Wagner --- docs/command-syntax.rst | 3 +++ docs/offline-mirror.rst | 24 ++++++++++++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/docs/command-syntax.rst b/docs/command-syntax.rst index bd91d46..272e6bd 100644 --- a/docs/command-syntax.rst +++ b/docs/command-syntax.rst @@ -4,6 +4,9 @@ Command Syntax ``proxmox-offline-mirror`` -------------------------- +For supported environment variables please refer to +:ref:`env_vars` . + .. include:: proxmox-offline-mirror/synopsis.rst diff --git a/docs/offline-mirror.rst b/docs/offline-mirror.rst index fde27ed..aa4780e 100644 --- a/docs/offline-mirror.rst +++ b/docs/offline-mirror.rst @@ -86,3 +86,27 @@ Space Management After removing a snapshot with ``proxmox-offline-mirror mirror snapshot remove``, a ``proxmox-offline-mirror mirror gc`` invocation is needed to trigger the garbage collection to actually remove any contents from the underlying hard link pool that are no longer needed. + +.. _env_vars : + +Environment Variables +--------------------- + + +``ALL_PROXY`` + When set, the client uses the specified HTTP proxy for all connections to the + backup server. Currently only HTTP proxies are supported. Valid proxy + configurations have the following format: + `[http://][user:password@][:port]`. Default `port` is 1080, if not + otherwise specified. + +.. Note:: The proxy server must allow ``HTTP CONNECT`` for all ports that are used + to connect to mirrors (e.g. port 80 for HTTP mirrors). For Squid, + the appropriate configuration parameter is ``http_access allow CONNECT `` + (http://www.squid-cache.org/Doc/config/http_access/). By default, Squid only + allows ``HTTP CONNECT`` for port 443. + + +.. Note:: Passwords must be valid UTF-8 and may not contain newlines. For your + convenience, Proxmox Backup Server only uses the first line as password, so + you can add arbitrary comments after the first newline. -- 2.30.2