Skip to content

Commit

Permalink
Update main userdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Mar 12, 2024
1 parent e86036c commit 1ba947a
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
10 changes: 10 additions & 0 deletions public/docs/user/main/_sources/build_a_container.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ Because ``build`` can accept an existing container as a target and
create a container in either supported format, you can use it to convert
existing containers from one format to another.


.. note::
{Project} leverages the user namespace kernel feature to give the illusion
of elevated privileges while building containers. On some systems, the user
namespace may be incompletely configured for individual users. In this case,
{Project} may bind mount the ``fakeroot`` program from the host into the
container during the build, and this might fail in some containers with
mismatching libraries. See the :ref:`fakeroot documentation <fakeroot>` for
more details.

*************************************************
Downloading an existing container from Docker Hub
*************************************************
Expand Down
10 changes: 10 additions & 0 deletions public/docs/user/main/build_a_container.html
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,16 @@ <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this head
<p>Because <code class="docutils literal notranslate"><span class="pre">build</span></code> can accept an existing container as a target and
create a container in either supported format, you can use it to convert
existing containers from one format to another.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Apptainer leverages the user namespace kernel feature to give the illusion
of elevated privileges while building containers. On some systems, the user
namespace may be incompletely configured for individual users. In this case,
Apptainer may bind mount the <code class="docutils literal notranslate"><span class="pre">fakeroot</span></code> program from the host into the
container during the build, and this might fail in some containers with
mismatching libraries. See the <a class="reference internal" href="fakeroot.html#fakeroot"><span class="std std-ref">fakeroot documentation</span></a> for
more details.</p>
</div>
</div>
<div class="section" id="downloading-an-existing-container-from-docker-hub">
<h2>Downloading an existing container from Docker Hub<a class="headerlink" href="#downloading-an-existing-container-from-docker-hub" title="Permalink to this heading"></a></h2>
Expand Down
2 changes: 1 addition & 1 deletion public/docs/user/main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 1ba947a

Please sign in to comment.