From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 3124F667EE for ; Fri, 6 Nov 2020 15:46:43 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 1DE2723690 for ; Fri, 6 Nov 2020 15:46:43 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 7155023680 for ; Fri, 6 Nov 2020 15:46:42 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 3A4D146059 for ; Fri, 6 Nov 2020 15:46:42 +0100 (CET) From: Dylan Whyte To: pbs-devel@lists.proxmox.com Date: Fri, 6 Nov 2020 15:46:24 +0100 Message-Id: <20201106144630.21538-2-d.whyte@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20201106144630.21538-1-d.whyte@proxmox.com> References: <20201106144630.21538-1-d.whyte@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.381 Adjusted score from AWL reputation of From: address KAM_ASCII_DIVIDERS 0.8 Spam that uses ascii formatting tricks KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH docs 1/7] installation & gui: Formatting fixup X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 06 Nov 2020 14:46:43 -0000 Fix some minor formatting errors in the docs Signed-off-by: Dylan Whyte --- docs/gui.rst | 14 +++++--------- docs/installation.rst | 22 +++++++++++----------- 2 files changed, 16 insertions(+), 20 deletions(-) diff --git a/docs/gui.rst b/docs/gui.rst index 2c857059..23aab68a 100644 --- a/docs/gui.rst +++ b/docs/gui.rst @@ -4,7 +4,7 @@ Graphical User Interface 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 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. 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 - :width: 250 :align: right :alt: PBS login window @@ -44,7 +43,6 @@ GUI Overview ------------ .. image:: images/screenshots/pbs-gui-dashboard.png - :width: 250 :align: right :alt: PBS GUI Dashboard @@ -79,18 +77,17 @@ Configuration The Configuration section contains some system configuration options, such as time and network configuration. It also contains the following subsections: -* **User Management**: Add users and manage accounts -* **Permissions**: Manage permissions for various users +* **Access Control**: Add and manage users, API tokens, and the permissions + associated with these items * **Remotes**: Add, edit and remove remotes (see :term:`Remote`) -* **Sync Jobs**: Manage and run sync jobs to remotes -* **Subscription**: Upload a subscription key and view subscription status +* **Subscription**: Upload a subscription key, view subscription status and + access a text-based system report. Administration ^^^^^^^^^^^^^^ .. image:: images/screenshots/pbs-gui-administration-serverstatus.png - :width: 250 :align: right :alt: Administration: Server Status overview @@ -105,7 +102,6 @@ tasks and information. These are: * **Tasks**: Task history with multiple filter options .. image:: images/screenshots/pbs-gui-disks.png - :width: 250 :align: right :alt: Administration: Disks diff --git a/docs/installation.rst b/docs/installation.rst index 731aadf8..8a2bcde4 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -9,7 +9,7 @@ Debian_ from the provided package repository. .. include:: package-repositories.rst -Server installation +Server Installation ------------------- 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. -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 @@ -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 as well. -.. note:: You can access the web interface of the Proxmox Backup Server with - your web browser, using HTTPS on port 8007. For example at - ``https://:8007`` +.. Note:: You can access the web interface of the Proxmox Backup Server with + your web browser, using HTTPS on port 8007. For example at + ``https://:8007`` -Install Proxmox Backup server on `Proxmox VE`_ +Install Proxmox Backup Server on `Proxmox VE`_ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ After configuring the @@ -104,14 +104,14 @@ After configuring the server to store backups. Should the hypervisor server fail, you can still access the backups. -.. note:: - You can access the web interface of the Proxmox Backup Server with your web - browser, using HTTPS on port 8007. For example at ``https://:8007`` +.. Note:: You can access the web interface of the Proxmox Backup Server with + your web browser, using HTTPS on port 8007. For example at + ``https://: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 -- 2.20.1