docs: Add documentation for mounting pxar archives via FUSE.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst
index f20be1b3057ffc1f11ef2b5b706030a087b33659..e6092813b9cf26f4bb693da52683fea5c11aa9d0 100644 (file)
--- a/docs/administration-guide.rst
+++ b/docs/administration-guide.rst
@@ -429,6 +429,31 @@ files ending in ``.conf``.
 
 .. todo:: Explain interactive restore in more detail
 
+Mounting of Archives via FUSE
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The :term:`FUSE` implementation for the pxar archive allows you to mount a
+file archive as a read-only filesystem to a mountpoint on your host.
+
+.. code-block:: console
+
+  # proxmox-backup-client mount host/backup-client/2020-01-29T11:29:22Z root.pxar /mnt
+  # ls /mnt
+  bin   dev  home  lib32  libx32      media  opt   root  sbin  sys  usr
+  boot  etc  lib   lib64  lost+found  mnt    proc  run   srv   tmp  var
+
+This allows you to access the full content of the archive in a seamless manner.
+
+.. note:: As the FUSE connection needs to fetch and decrypt chunks from the
+    backup servers datastore, this can cause some additional network and CPU
+    load on your host, depending on the operations you perform on the mounted
+    filesystem.
+
+To unmount the filesystem simply use the ``umount`` command on the mountpoint:
+
+.. code-block:: console
+
+  # umount /mnt
 
 Login and Logout
 ~~~~~~~~~~~~~~~~

diff --git a/docs/epilog.rst b/docs/epilog.rst
index 3d996558ad49b2e8545ffd19fba9b579090ef5e4..71ae2ed81064679bf5017eaa58357e7769ba78e6 100644 (file)
--- a/docs/epilog.rst
+++ b/docs/epilog.rst
@@ -20,6 +20,7 @@
 .. _Virtual machine: https://en.wikipedia.org/wiki/Virtual_machine
 .. _APT: http://en.wikipedia.org/wiki/Advanced_Packaging_Tool
 .. _QEMU: https://www.qemu.org/
+.. _FUSE: https://en.wikipedia.org/wiki/Filesystem_in_Userspace
 
 .. _Client-server model: https://en.wikipedia.org/wiki/Client-server_model
 .. _AE: https://en.wikipedia.org/wiki/Authenticated_encryption

diff --git a/docs/glossary.rst b/docs/glossary.rst
index 65bac6c98e3bb897d653a1af9b430fa5e42a7bbc..1c199dedcb028157d7c829353197f93eef99958e 100644 (file)
--- a/docs/glossary.rst
+++ b/docs/glossary.rst
@@ -40,3 +40,11 @@ Glossary
 
       Is an easy-to-read, what-you-see-is-what-you-get plaintext
       markup syntax and parser system.
+
+   `FUSE`_
+
+      Filesystem in Userspace (FUSE) defines an interface which allows to
+      implement a filesystem in userspace as opposed to implementing it
+      in the kernel. The fuse kernel driver handles filesystem requests and
+      sends them to an userspace application for reply.
+