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 BAF9F615C7 for ; Tue, 18 Aug 2020 12:49:30 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id A8801124AA for ; Tue, 18 Aug 2020 12:49:00 +0200 (CEST) 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 3A272124A0 for ; Tue, 18 Aug 2020 12:48:59 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id F06764466C for ; Tue, 18 Aug 2020 12:48:58 +0200 (CEST) From: Dylan Whyte To: pbs-devel@lists.proxmox.com Date: Tue, 18 Aug 2020 12:48:49 +0200 Message-Id: <20200818104849.6348-1-d.whyte@proxmox.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 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 URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [proxmox.com] Subject: [pbs-devel] [PATCH pbs-docs 1/4] minor language and 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: Tue, 18 Aug 2020 10:49:30 -0000 this fixes minor grammatical errors throughout the pbs docs and rewords certain sections for improved readability. Signed-off-by: Dylan Whyte --- docs/administration-guide.rst | 12 ++++++------ docs/installation.rst | 16 ++++++++-------- docs/introduction.rst | 3 ++- docs/package-repositories.rst | 23 +++++++++++------------ docs/pxar/description.rst | 16 ++++++++-------- 5 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst index 9c75c904..7bcefa9b 100644 --- a/docs/administration-guide.rst +++ b/docs/administration-guide.rst @@ -344,10 +344,10 @@ following roles exist: Disable Access - nothing is allowed. **Admin** - The Administrator can do anything. + Can do anything. **Audit** - An Auditor can view things, but is not allowed to change settings. + Can view things, but is not allowed to change settings. **DatastoreAdmin** Can do anything on datastores. @@ -578,7 +578,7 @@ Excluding files/folders from a backup ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Sometimes it is desired to exclude certain files or folders from a backup archive. -To tell the Proxmox backup client when and how to ignore files and directories, +To tell the Proxmox Backup client when and how to ignore files and directories, place a text file called ``.pxarexclude`` in the filesystem hierarchy. Whenever the backup client encounters such a file in a directory, it interprets each line as glob match patterns for files and directories that are to be excluded @@ -818,7 +818,7 @@ backup. # proxmox-backup-client restore host/elsa/2019-12-03T09:35:01Z root.pxar /target/path/ -To get the contents of any archive, you can restore the ``ìndex.json`` file in the +To get the contents of any archive, you can restore the ``index.json`` file in the repository to the target path '-'. This will dump the contents to the standard output. .. code-block:: console @@ -959,8 +959,8 @@ command: snapshot. They will be inaccessible and unrecoverable. -The manual removal is sometimes required, but normally the prune -command is used to systematically delete older backups. Prune lets +Although manual removal is sometimes required, the ``prune`` +command is normally used to systematically delete older backups. Prune lets you specify which backup snapshots you want to keep. The following retention options are available: diff --git a/docs/installation.rst b/docs/installation.rst index 169b1b36..8765e381 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -19,9 +19,9 @@ for various management tasks such as disk management. The disk image (ISO file) provided by Proxmox includes a complete Debian system ("buster" for version 1.x) as well as all necessary packages for the `Proxmox Backup`_ server. -The installer will guide you through the setup process and allows +The installer will guide you through the setup process and allow you to partition the local disk(s), apply basic system configurations -(e.g. timezone, language, network), and installs all required packages. +(e.g. timezone, language, network), and install all required packages. The provided ISO will get you started in just a few minutes, and is the recommended method for new and existing users. @@ -36,11 +36,11 @@ It includes the following: * The `Proxmox Backup`_ server installer, which partitions the local disk(s) with ext4, ext3, xfs or ZFS, and installs the operating - system. + system * Complete operating system (Debian Linux, 64-bit) -* Our Linux kernel with ZFS support. +* Our Linux kernel with ZFS support * Complete tool-set to administer backups and all necessary resources @@ -54,7 +54,7 @@ Install `Proxmox Backup`_ server on Debian ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Proxmox ships as a set of Debian packages which can be installed on top of a -standard Debian installation. After configuring the +standard Debian installation. After configuring the :ref:`sysadmin_package_repositories`, you need to run: .. code-block:: console @@ -103,9 +103,9 @@ After configuring the server to store backups. Should the hypervisor server fail, you can still access the backups. -.. note:: You can access the webinterface of the Proxmox Backup Server with - your web browser, using HTTPS on port 8007. For example at - ``https://:8007`` +.. note:: + You can access the webinterface of the Proxmox Backup Server with your web + browser, using HTTPS on port 8007. For example at ``https://:8007`` Client installation ------------------- diff --git a/docs/introduction.rst b/docs/introduction.rst index 9df0762f..0b0e3ae3 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -22,7 +22,7 @@ Architecture ------------ Proxmox Backup Server uses a `client-server model`_. The server stores the -backup data and provides an API to create backups and restore data. With the +backup data and provides an API to create and manage data stores. With the API, it's also possible to manage disks and other server-side resources. The backup client uses this API to access the backed up data. With the command @@ -143,6 +143,7 @@ Mailing Lists Proxmox Backup Server is fully open-source and contributions are welcome! Here is the primary communication channel for developers: + :Mailing list for developers: `PBS Development List`_ Bug Tracker diff --git a/docs/package-repositories.rst b/docs/package-repositories.rst index c60a75ed..c3883b8b 100644 --- a/docs/package-repositories.rst +++ b/docs/package-repositories.rst @@ -3,8 +3,8 @@ Debian Package Repositories --------------------------- -All Debian based systems use APT_ as package management tool. The list of -repositories is defined in ``/etc/apt/sources.list`` and ``.list`` files found +All Debian based systems use APT_ as a package management tool. The lists of +repositories are defined in ``/etc/apt/sources.list`` and the ``.list`` files found in the ``/etc/apt/sources.d/`` directory. Updates can be installed directly with the ``apt`` command line tool, or via the GUI. @@ -26,11 +26,10 @@ update``. .. FIXME for 7.0: change security update suite to bullseye-security -In addition, you need a package repositories from Proxmox to get the backup -server updates. +In addition, you need a package repository from Proxmox to get Proxmox Backup updates. -During the Proxmox Backup beta phase only one repository (pbstest) will be -available. Once released, a Enterprise repository for production use and a +During the Proxmox Backup beta phase, only one repository (pbstest) will be +available. Once released, an Enterprise repository for production use and a no-subscription repository will be provided. SecureApt @@ -39,8 +38,8 @@ SecureApt The `Release` files in the repositories are signed with GnuPG. APT is using these signatures to verify that all packages are from a trusted source. -If you install Proxmox Backup Server from an official ISO image, the key for -verification is already installed. +If you install Proxmox Backup Server from an official ISO image, the +verification key is already installed. If you install Proxmox Backup Server on top of Debian, download and install the key with the following commands: @@ -136,17 +135,17 @@ During the public beta, there is a repository called ``pbstest``. This one contains the latest packages and is heavily used by developers to test new features. -.. .. warning:: the ``pbstest`` repository should (as the name implies) +.. .. warning:: the ``pbstest`` repository should (as the name implies) only be used to test new features or bug fixes. -You can configure this using ``/etc/apt/sources.list`` by adding the following -line: +You can access this repository by adding the following line to +``/etc/apt/sources.list``: .. code-block:: sources.list :caption: sources.list entry for ``pbstest`` deb http://download.proxmox.com/debian/pbs buster pbstest -If you installed Proxmox Backup Server from the official beta ISO you should +If you installed Proxmox Backup Server from the official beta ISO, you should have this repository already configured in ``/etc/apt/sources.list.d/pbstest-beta.list`` diff --git a/docs/pxar/description.rst b/docs/pxar/description.rst index cad1a830..856ffd51 100644 --- a/docs/pxar/description.rst +++ b/docs/pxar/description.rst @@ -9,7 +9,7 @@ which caters to a similar use-case. The ``.pxar`` format is adapted to fulfill the specific needs of the Proxmox Backup Server, for example, efficient storage of hardlinks. The format is designed to reduce storage space needed on the server by achieving -a high level of de-duplication. +a high level of deduplication. Creating an Archive ^^^^^^^^^^^^^^^^^^^ @@ -29,7 +29,7 @@ This will create a new archive called ``archive.pxar`` with the contents of the By default, ``pxar`` will skip certain mountpoints and will not follow device boundaries. This design decision is based on the primary use case of creating -archives for backups. It is sensible to not back up the contents of certain +archives for backups. It makes sense to not back up the contents of certain temporary or system specific files. To alter this behavior and follow device boundaries, use the ``--all-file-systems`` flag. @@ -66,7 +66,7 @@ All the glob patterns are relative to the ``source`` directory. previous ones. Permutations of the same patterns lead to different results. ``pxar`` will store the list of glob match patterns passed as parameters via the -command line in a file called ``.pxarexclude-cli`` and stores it at the root of +command line, in a file called ``.pxarexclude-cli`` at the root of the archive. If a file with this name is already present in the source folder during archive creation, this file is not included in the archive and the file containing the @@ -85,23 +85,23 @@ The behavior is the same as described in :ref:`creating-backups`. Extracting an Archive ^^^^^^^^^^^^^^^^^^^^^ -An existing archive ``archive.pxar`` is extracted to a ``target`` directory +An existing archive, ``archive.pxar``, is extracted to a ``target`` directory with the following command: .. code-block:: console - # pxar extract archive.pxar --target target + # pxar extract archive.pxar /path/to/target If no target is provided, the content of the archive is extracted to the current working directory. -In order to restore only parts of an archive, single files and/or folders, +In order to restore only parts of an archive, single files, and/or folders, it is possible to pass the corresponding glob match patterns as additional -parameters or use the patterns stored in a file: +parameters or to use the patterns stored in a file: .. code-block:: console - # pxar extract etc.pxar '**/*.conf' --target /restore/target/etc + # pxar extract etc.pxar /restore/target/etc --pattern '**/*.conf' The above example restores all ``.conf`` files encountered in any of the sub-folders in the archive ``etc.pxar`` to the target ``/restore/target/etc``. -- 2.20.1