tyler/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Correct erroneous instructions and add clarity

Browse Source 
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>
This commit is contained in:
Dylan Whyte 2020-08-18 12:50:07 +02:00 committed by Thomas Lamprecht
parent 4cda7603c4
commit 74fc844787
2 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/administration-guide.rst
View File

@ -356,10 +356,10 @@ following roles exist:
Can view datastore settings and list content. But Can view datastore settings and list content. But
is not allowed to read the actual data. is not allowed to read the actual data.
**DataStoreReader** **DatastoreReader**
Can Inspect datastore content and can do restores. Can Inspect datastore content and can do restores.
**DataStoreBackup** **DatastoreBackup**
Can backup and restore owned backups. Can backup and restore owned backups.
**DatastorePowerUser** **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 The ``--repository`` option can get quite long and is used by all
commands. You can avoid having to enter this value by setting the 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 .. 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 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 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 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 Restoring Data
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
@ -900,8 +904,8 @@ file archive as a read-only filesystem to a mountpoint on your host.
.. code-block:: console .. code-block:: console
# proxmox-backup-client mount host/backup-client/2020-01-29T11:29:22Z root.pxar /mnt # proxmox-backup-client mount host/backup-client/2020-01-29T11:29:22Z root.pxar /mnt/mountpoint
# ls /mnt # ls /mnt/mountpoint
bin dev home lib32 libx32 media opt root sbin sys usr bin dev home lib32 libx32 media opt root sbin sys usr
boot etc lib lib64 lost+found mnt proc run srv tmp var 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 .. code-block:: console
# umount /mnt # umount /mnt/mountpoint
Login and Logout Login and Logout
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~

11
docs/installation.rst
View File

@ -76,12 +76,11 @@ does, please use the following:
This will install all required packages, the Proxmox kernel with ZFS_ This will install all required packages, the Proxmox kernel with ZFS_
support, and a set of common and useful packages. support, and a set of common and useful packages.
Installing `Proxmox Backup`_ on top of an existing Debian_ installation looks easy, but .. caution:: Installing `Proxmox Backup`_ on top of an existing Debian_
it presumes that the base system and local storage has been set up correctly. 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
In general this is not trivial, especially when LVM_ or ZFS_ is used. when LVM_ or ZFS_ is used. The network configuration is completely up to you
as well.
The network configuration is completely up to you as well.
.. note:: You can access the webinterface of the Proxmox Backup Server with .. note:: You can access the webinterface of the Proxmox Backup Server with
your web browser, using HTTPS on port 8007. For example at your web browser, using HTTPS on port 8007. For example at