Skip to content

Commit

Permalink
Update v4.5.x docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed May 7, 2024
1 parent c3ac391 commit f325a28
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 1 deletion.
20 changes: 20 additions & 0 deletions static/docs/v4.5.x/_sources/contents/containers.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
========

Expand Down
16 changes: 16 additions & 0 deletions static/docs/v4.5.x/contents/containers.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<li class="toctree-l2"><a class="reference internal" href="#importing-containers">Importing Containers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#private-registry">Private Registry</a></li>
<li class="toctree-l3"><a class="reference internal" href="#local-files">Local Files</a></li>
<li class="toctree-l3"><a class="reference internal" href="#http-proxies">HTTP proxies</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#syncuser">Syncuser</a></li>
Expand Down Expand Up @@ -239,6 +240,21 @@ <h3>Local Files<a class="headerlink" href="#local-files" title="Link to this hea
</pre></div>
</div>
</section>
<section id="http-proxies">
<h3>HTTP proxies<a class="headerlink" href="#http-proxies" title="Link to this heading"></a></h3>
<p>You can set <code class="docutils literal notranslate"><span class="pre">HTTP_PROXY</span></code>, <code class="docutils literal notranslate"><span class="pre">HTTPS_PROXY</span></code>, and <code class="docutils literal notranslate"><span class="pre">NO_PROXY</span></code> (or their
lower-case versions) to use a proxy during <code class="docutils literal notranslate"><span class="pre">wwctl</span> <span class="pre">container</span> <span class="pre">import</span></code>.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">HTTPS_PROXY</span><span class="o">=</span>squid.localdomain
wwctl<span class="w"> </span>conatiner<span class="w"> </span>import<span class="w"> </span>docker://ghcr.io/warewulf/warewulf-rockylinux:8
</pre></div>
</div>
<p>See <a class="reference external" href="https://pkg.go.dev/net/http#ProxyFromEnvironment">ProxyFromEnvironment</a> For more information.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>OCI and ORAS registries typically use HTTPS, so you probably need to set
<code class="docutils literal notranslate"><span class="pre">HTTPS_PROXY</span></code> or <code class="docutils literal notranslate"><span class="pre">https_proxy</span></code> rather than the <code class="docutils literal notranslate"><span class="pre">HTTP</span></code> variants.</p>
</div>
</section>
</section>
<section id="syncuser">
<h2>Syncuser<a class="headerlink" href="#syncuser" title="Link to this heading"></a></h2>
Expand Down
2 changes: 1 addition & 1 deletion static/docs/v4.5.x/searchindex.js

Large diffs are not rendered by default.

0 comments on commit f325a28

Please sign in to comment.