[pbs-devel] [PATCH docs] Add section "FAQ"

[pbs-devel] [PATCH docs] Add section "FAQ"

[Dylan Whyte]

Adds an FAQ to the docs, based on question that have
been appearing on the forum.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---
 docs/faq.rst   | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/index.rst |  1 +
 2 files changed, 71 insertions(+)
 create mode 100644 docs/faq.rst

diff --git a/docs/faq.rst b/docs/faq.rst
new file mode 100644
index 00000000..c1b97e73
--- /dev/null
+++ b/docs/faq.rst
@@ -0,0 +1,70 @@
+FAQ
+===
+
+What distribution is Proxmox Backup Server (PBS) based on?
+----------------------------------------------------------
+
+Proxmox Backup Server is based on `Debian GNU/Linux <https://www.debian.org/>`_.
+
+
+Which platforms are supported as a backup source (client)?
+----------------------------------------------------------
+
+The client tool works on most modern Linux systems, meaning you are not limited
+to Debian-based backups.
+
+
+Will Proxmox Backup Server run on a 32-bit processor?
+-----------------------------------------------------
+
+Proxmox Backup Server only supports 64-bit CPUs (AMD or Intel). There are no
+future plans to support 32-bit processors.
+
+
+How long will my Proxmox Backup Server version be supported?
+------------------------------------------------------------
+
++------------+--------------------+---------------+------------+---------+
+|PBS Version | Debian Version     | First Release | Debian EOL | PBS EOL |
++============+====================+===============+============+=========+
+|PBS 1.x     | Debian 10 (Buster) | tba           | tba        | tba     |
++------------+--------------------+---------------+------------+---------+
+
+
+Can I copy or synchronize my datastore to another location?
+-----------------------------------------------------------
+
+Proxmox Backup Server allows you to copy or synchroize datastores to other
+locations, through the use of *Remotes* and *Sync Jobs*. *Remote* is the term
+given to a separate server, which has a datastore that can be synced to a local store.
+A *Sync Job* is the process which is used to pull the contents of a datastore from
+a *Remote* to a local datastore.
+
+
+Can Proxmox Backup Server verify data integrity of a backup archive?
+--------------------------------------------------------------------
+
+PBS uses a built-in SHA-256 checksum algorithm, to ensure data integrity. Within
+each backup, a manifest file (index.json) is created, which contains a list of
+all the backup files, along with their sizes and checksums. This manifest file
+is used to verify the integrity of each backup.
+
+
+When backing up to remote servers, do I have to trust the remote server?
+------------------------------------------------------------------------
+
+PBS supports client-side encryption, meaning your data is encrypted before
+it reaches the server. Thus, in the event that an attacker gains access to the
+server, they will not be able to read the data.
+
+.. note:: Encryption is not enabled by default. To set up encryption, see the
+  `Encryption
+  <https://pbs.proxmox.com/docs/administration-guide.html#encryption>`_ section
+  of the PBS Administration Guide.
+
+
+Is the backup incremental/deduplicated?
+---------------------------------------
+
+With PBS, backups are incremental and data is deduplicated. This minimizes both
+the storage consumed and the network impact.
diff --git a/docs/index.rst b/docs/index.rst
index 70897a24..dfa60cb9 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -24,6 +24,7 @@ in the section entitled "GNU Free Documentation License".
    installation.rst
    administration-guide.rst
    sysadmin.rst
+   faq.rst
 
 .. raw:: latex
 
-- 
2.20.1

[pbs-devel] applied: [PATCH docs] Add section "FAQ"

[Thomas Lamprecht]

On 10.09.20 11:05, Dylan Whyte wrote:
> Adds an FAQ to the docs, based on question that have
> been appearing on the forum.
> 
> Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
> ---
>  docs/faq.rst   | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++
>  docs/index.rst |  1 +
>  2 files changed, 71 insertions(+)
>  create mode 100644 docs/faq.rst
> 
>

applied, thanks! Spelled out PBS as Proxmox Backup Server in a followup.