From: Dylan Whyte <d.whyte@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH pbs-docs 2/4] Correct erroneous instructions and add clarity
Date: Tue, 18 Aug 2020 12:50:07 +0200 [thread overview]
Message-ID: <20200818105007.6797-1-d.whyte@proxmox.com> (raw)
This patch changes the following:
- Provide extra clarity to instruction and information where
appropriate.
- Fix examples and content that would lead to erroneous behavior
in a command.
- Insert section about installing on Debian into a caution block
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---
docs/administration-guide.rst | 18 +++++++++++-------
docs/installation.rst | 11 +++++------
2 files changed, 16 insertions(+), 13 deletions(-)
diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst
index 7bcefa9b..2be49575 100644
--- a/docs/administration-guide.rst
+++ b/docs/administration-guide.rst
@@ -356,10 +356,10 @@ following roles exist:
Can view datastore settings and list content. But
is not allowed to read the actual data.
-**DataStoreReader**
+**DatastoreReader**
Can Inspect datastore content and can do restores.
-**DataStoreBackup**
+**DatastoreBackup**
Can backup and restore owned backups.
**DatastorePowerUser**
@@ -543,7 +543,9 @@ This will prompt you for a password and then uploads a file archive named
The ``--repository`` option can get quite long and is used by all
commands. You can avoid having to enter this value by setting the
-environment variable ``PBS_REPOSITORY``.
+environment variable ``PBS_REPOSITORY``. Note that if you would like this to remain set
+over multiple sessions, you should instead add the below line to your
+``.bashrc`` file.
.. code-block:: console
@@ -775,7 +777,9 @@ To set up a master key:
backed up. It can happen, for example, that you back up an entire system, using
a key on that system. If the system then becomes inaccessable for any reason
and needs to be restored, this will not be possible as the encryption key will be
- lost along with the broken system.
+ lost along with the broken system. In preparation for the worst case scenario,
+ you should consider keeping a paper copy of this key locked away in
+ a safe place.
Restoring Data
~~~~~~~~~~~~~~
@@ -900,8 +904,8 @@ 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
+ # proxmox-backup-client mount host/backup-client/2020-01-29T11:29:22Z root.pxar /mnt/mountpoint
+ # ls /mnt/mountpoint
bin dev home lib32 libx32 media opt root sbin sys usr
boot etc lib lib64 lost+found mnt proc run srv tmp var
@@ -916,7 +920,7 @@ To unmount the filesystem use the ``umount`` command on the mountpoint:
.. code-block:: console
- # umount /mnt
+ # umount /mnt/mountpoint
Login and Logout
~~~~~~~~~~~~~~~~
diff --git a/docs/installation.rst b/docs/installation.rst
index 8765e381..7d4055b6 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -76,12 +76,11 @@ does, please use the following:
This will install all required packages, the Proxmox kernel with ZFS_
support, and a set of common and useful packages.
-Installing `Proxmox Backup`_ on top of an existing Debian_ installation looks easy, but
-it presumes that the base system and local storage has been set up correctly.
-
-In general this is not trivial, especially when LVM_ or ZFS_ is used.
-
-The network configuration is completely up to you as well.
+.. caution:: Installing `Proxmox Backup`_ on top of an existing Debian_
+ installation looks easy, but it assumes that the base system and local
+ storage have been set up correctly. In general this is not trivial, especially
+ when LVM_ or ZFS_ is used. The network configuration is completely up to you
+ as well.
.. note:: You can access the webinterface of the Proxmox Backup Server with
your web browser, using HTTPS on port 8007. For example at
--
2.20.1
reply other threads:[~2020-08-18 10:50 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200818105007.6797-1-d.whyte@proxmox.com \
--to=d.whyte@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox