[pve-devel] [PATCH proxmox-offline-mirror 2/2] docs: document `ALL_PROXY` environment variable

[Lukas Wagner]

Signed-off-by: Lukas Wagner <l.wagner at 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