From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH proxmox-offline-mirror 2/2] docs: document `ALL_PROXY` environment variable
Date: Thu, 19 Jan 2023 11:40:41 +0100 [thread overview]
Message-ID: <20230119104041.264052-2-l.wagner@proxmox.com> (raw)
In-Reply-To: <20230119104041.264052-1-l.wagner@proxmox.com>
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
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@]<host>[: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 <acl>``
+ (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
next prev parent reply other threads:[~2023-01-19 10:41 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-19 10:40 [pve-devel] [PATCH proxmox-offline-mirror 1/2] fix #4445: mirror: subscription: add proxy support Lukas Wagner
2023-01-19 10:40 ` Lukas Wagner [this message]
2023-01-27 10:25 ` [pve-devel] applied-series: " Fabian Grünbichler
2023-01-27 11:04 ` Lukas Wagner
2023-02-08 10:01 ` Lukas Wagner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230119104041.264052-2-l.wagner@proxmox.com \
--to=l.wagner@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox