From 87c7d0dda3a46dccdbc9d09454b8a5899d18d0df Mon Sep 17 00:00:00 2001 From: Jonathon Anderson Date: Mon, 6 May 2024 23:43:07 -0600 Subject: [PATCH] Document HTTP proxy environment variables For use in wwctl container import. Signed-off-by: Jonathon Anderson --- CHANGELOG.md | 3 ++- userdocs/contents/containers.rst | 20 ++++++++++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e68703c7..24f96688 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -50,7 +50,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ### Added - Document warewulf.conf:paths. #635 -- New "Overlay" template variable contains the name of the overlay being built. #1052 +- New "Overlay" template variable contains the name of the overlay being built. #1052 +- Documented HTTP proxy environment variables for `wwctl container import`. #1214 ### Changed diff --git a/userdocs/contents/containers.rst b/userdocs/contents/containers.rst index c7ef5539..aa8385eb 100644 --- a/userdocs/contents/containers.rst +++ b/userdocs/contents/containers.rst @@ -125,6 +125,26 @@ directly. $ apptainer build --sandbox ./rockylinux-8/ docker://ghcr.io/warewulf/warewulf-rockylinux:8 $ sudo wwctl container import ./rockylinux-8/ rockylinux-8 +HTTP proxies +------------ + +You can set ``HTTP_PROXY``, ``HTTPS_PROXY``, and ``NO_PROXY`` (or their +lower-case versions) to use a proxy during ``wwctl container import``. + +.. code-block:: shell + + export HTTPS_PROXY=squid.localdomain + wwctl conatiner import docker://ghcr.io/warewulf/warewulf-rockylinux:8 + +See ProxyFromEnvironment_ For more information. + +.. _ProxyFromEnvironment: https://pkg.go.dev/net/http#ProxyFromEnvironment + +.. note:: + + OCI and ORAS registries typically use HTTPS, so you probably need to set + ``HTTPS_PROXY`` or ``https_proxy`` rather than the ``HTTP`` variants. + Syncuser ========