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

installation & gui: Formatting fixup

Browse Source 
Fix some minor formatting errors in the docs

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
This commit is contained in:
Dylan Whyte 2020-11-06 15:46:24 +01:00 committed by Dietmar Maurer
parent b59c308219
commit 8f1d972149
2 changed files with 16 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/gui.rst
View File

@ -4,7 +4,7 @@ Graphical User Interface
Proxmox Backup Server offers an integrated, web-based interface to manage the Proxmox Backup Server offers an integrated, web-based interface to manage the
server. This means that you can carry out all administration tasks through your server. This means that you can carry out all administration tasks through your
web browser, and that you don't have to worry about installing extra management web browser, and that you don't have to worry about installing extra management
tools. The web interface also provides a built in console, so if you prefer the tools. The web interface also provides a built-in console, so if you prefer the
command line or need some extra control, you have this option. command line or need some extra control, you have this option.
The web interface can be accessed via https://youripaddress:8007. The default The web interface can be accessed via https://youripaddress:8007. The default
@ -28,7 +28,6 @@ Login
----- -----
.. image:: images/screenshots/pbs-gui-login-window.png .. image:: images/screenshots/pbs-gui-login-window.png
:width: 250
:align: right :align: right
:alt: PBS login window :alt: PBS login window
@ -44,7 +43,6 @@ GUI Overview
------------ ------------
.. image:: images/screenshots/pbs-gui-dashboard.png .. image:: images/screenshots/pbs-gui-dashboard.png
:width: 250
:align: right :align: right
:alt: PBS GUI Dashboard :alt: PBS GUI Dashboard
@ -79,18 +77,17 @@ Configuration
The Configuration section contains some system configuration options, such as The Configuration section contains some system configuration options, such as
time and network configuration. It also contains the following subsections: time and network configuration. It also contains the following subsections:
* **User Management**: Add users and manage accounts * **Access Control**: Add and manage users, API tokens, and the permissions
* **Permissions**: Manage permissions for various users associated with these items
* **Remotes**: Add, edit and remove remotes (see :term:`Remote`) * **Remotes**: Add, edit and remove remotes (see :term:`Remote`)
* **Sync Jobs**: Manage and run sync jobs to remotes * **Subscription**: Upload a subscription key, view subscription status and
* **Subscription**: Upload a subscription key and view subscription status access a text-based system report.
Administration Administration
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
.. image:: images/screenshots/pbs-gui-administration-serverstatus.png .. image:: images/screenshots/pbs-gui-administration-serverstatus.png
:width: 250
:align: right :align: right
:alt: Administration: Server Status overview :alt: Administration: Server Status overview
@ -105,7 +102,6 @@ tasks and information. These are:
* **Tasks**: Task history with multiple filter options * **Tasks**: Task history with multiple filter options
.. image:: images/screenshots/pbs-gui-disks.png .. image:: images/screenshots/pbs-gui-disks.png
:width: 250
:align: right :align: right
:alt: Administration: Disks :alt: Administration: Disks

22
docs/installation.rst
View File

@ -9,7 +9,7 @@ Debian_ from the provided package repository.
.. include:: package-repositories.rst .. include:: package-repositories.rst
Server installation Server Installation
------------------- -------------------
The backup server stores the actual backed up data and provides a web based GUI The backup server stores the actual backed up data and provides a web based GUI
@ -52,7 +52,7 @@ It includes the following:
is used by default and all existing data is removed. is used by default and all existing data is removed.
Install `Proxmox Backup`_ server on Debian Install `Proxmox Backup`_ Server on Debian
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Proxmox ships as a set of Debian packages which can be installed on top of a Proxmox ships as a set of Debian packages which can be installed on top of a
@ -84,11 +84,11 @@ support, and a set of common and useful packages.
when LVM_ or ZFS_ is used. The network configuration is completely up to you when LVM_ or ZFS_ is used. The network configuration is completely up to you
as well. as well.
.. note:: You can access the web interface of the Proxmox Backup Server with .. Note:: You can access the web interface 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
``https://<ip-or-dns-name>:8007`` ``https://<ip-or-dns-name>:8007``
Install Proxmox Backup server on `Proxmox VE`_ Install Proxmox Backup Server on `Proxmox VE`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
After configuring the After configuring the
@ -104,14 +104,14 @@ After configuring the
server to store backups. Should the hypervisor server fail, you can server to store backups. Should the hypervisor server fail, you can
still access the backups. still access the backups.
.. note:: .. Note:: You can access the web interface of the Proxmox Backup Server with
You can access the web interface of the Proxmox Backup Server with your web your web browser, using HTTPS on port 8007. For example at
browser, using HTTPS on port 8007. For example at ``https://<ip-or-dns-name>:8007`` ``https://<ip-or-dns-name>:8007``
Client installation Client Installation
------------------- -------------------
Install `Proxmox Backup`_ client on Debian Install `Proxmox Backup`_ Client on Debian
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Proxmox ships as a set of Debian packages to be installed on Proxmox ships as a set of Debian packages to be installed on