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 B074B9DBE3 for ; Fri, 24 Nov 2023 18:44:39 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 92D1C134E2 for ; Fri, 24 Nov 2023 18:44:09 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (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 for ; Fri, 24 Nov 2023 18:44:07 +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 D738743D13 for ; Fri, 24 Nov 2023 18:44:06 +0100 (CET) From: Alexander Zeidler To: pbs-devel@lists.proxmox.com Date: Fri, 24 Nov 2023 18:43:43 +0100 Message-Id: <20231124174347.200266-2-a.zeidler@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20231124174347.200266-1-a.zeidler@proxmox.com> References: <20231124174347.200266-1-a.zeidler@proxmox.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.354 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_ASCII_DIVIDERS 0.8 Email that uses ascii formatting dividers and possible spam tricks KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pbs-devel] [PATCH proxmox-backup 2/6] docs: improve the occurrence of product website hyperlinks 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, 24 Nov 2023 17:44:39 -0000 Place hyperlinks only at the beginning of a chapter and where it makes sense, so as not to be distracted by redundant hyperlinks Signed-off-by: Alexander Zeidler --- docs/backup-client.rst | 2 +- docs/backup-protocol.rst | 2 +- docs/calendarevents.rst | 6 +++--- docs/certificate-management.rst | 34 ++++++++++++++++----------------- docs/configuration-files.rst | 2 +- docs/faq.rst | 2 +- docs/gui.rst | 2 +- docs/installation.rst | 12 ++++++------ docs/introduction.rst | 4 ++-- docs/local-zfs.rst | 8 ++++---- docs/maintenance.rst | 2 +- docs/managing-remotes.rst | 10 +++++----- docs/markdown-primer.rst | 2 +- docs/network-management.rst | 4 ++-- docs/package-repositories.rst | 2 +- docs/pve-integration.rst | 4 ++-- docs/pxar/description.rst | 4 ++-- docs/storage.rst | 2 +- docs/sysadmin.rst | 6 +++--- docs/system-booting.rst | 12 ++++++------ docs/tape-backup.rst | 2 +- docs/technical-overview.rst | 4 ++-- docs/terminology.rst | 2 +- docs/user-management.rst | 2 +- 24 files changed, 66 insertions(+), 66 deletions(-) diff --git a/docs/backup-client.rst b/docs/backup-client.rst index f132c357..8559e64d 100644 --- a/docs/backup-client.rst +++ b/docs/backup-client.rst @@ -1,7 +1,7 @@ Backup Client Usage =================== -The command-line client for Proxmox Backup Server is called +The command-line client for `Proxmox Backup`_ Server is called :command:`proxmox-backup-client`. .. _client_repository: diff --git a/docs/backup-protocol.rst b/docs/backup-protocol.rst index 47f6a6bc..ae56bae0 100644 --- a/docs/backup-protocol.rst +++ b/docs/backup-protocol.rst @@ -1,7 +1,7 @@ Backup Protocol =============== -Proxmox Backup Server uses a REST-based API. While the management +`Proxmox Backup`_ Server uses a REST-based API. While the management interface uses normal HTTP, the actual backup and restore interface uses HTTP/2 for improved performance. Both HTTP and HTTP/2 are well known standards, so the following section assumes that you are familiar with diff --git a/docs/calendarevents.rst b/docs/calendarevents.rst index 82e252fc..88b6747b 100644 --- a/docs/calendarevents.rst +++ b/docs/calendarevents.rst @@ -7,7 +7,7 @@ Introduction and Format ----------------------- Certain tasks, for example pruning and garbage collection, need to be -performed on a regular basis. Proxmox Backup Server uses a format inspired +performed on a regular basis. `Proxmox Backup`_ Server uses a format inspired by the systemd Time and Date Specification (see `systemd.time manpage`_) called `calendar events` for its schedules. @@ -89,11 +89,11 @@ Not all features of systemd calendar events are implemented: Notes on Scheduling ------------------- -In `Proxmox Backup`_, scheduling for most tasks is done in the +In Proxmox Backup, scheduling for most tasks is done in the `proxmox-backup-proxy`. This daemon checks all job schedules every minute, to see if any are due. This means that even though `calendar events` can contain seconds, it will only be checked once per minute. Also, all schedules will be checked against the timezone set -in the `Proxmox Backup`_ server. +in the Proxmox Backup Server. diff --git a/docs/certificate-management.rst b/docs/certificate-management.rst index 81e2b574..1c884630 100644 --- a/docs/certificate-management.rst +++ b/docs/certificate-management.rst @@ -9,7 +9,7 @@ own (self-signed) certificate. This certificate is used for encrypted communication with the host’s ``proxmox-backup-proxy`` service, for any API call between a user or backup-client and the web-interface. -Certificate verification when sending backups to a `Proxmox Backup`_ server +Certificate verification when sending backups to a Proxmox Backup Server is either done based on pinning the certificate fingerprints in the storage/remote configuration, or by using certificates, signed by a trusted certificate authority. @@ -18,7 +18,7 @@ configuration, or by using certificates, signed by a trusted certificate authori Certificates for the API and SMTP ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`Proxmox Backup`_ stores its certificate and key in: +Proxmox Backup stores its certificate and key in: - ``/etc/proxmox-backup/proxy.pem`` @@ -33,11 +33,11 @@ You have the following options for the certificate: commercial Certificate Authority (CA)). 3. Use an ACME provider like Let’s Encrypt to get a trusted certificate - with automatic renewal; this is also integrated in the `Proxmox Backup`_ + with automatic renewal; this is also integrated in the Proxmox Backup API and web interface. -Certificates are managed through the `Proxmox Backup`_ -web-interface/API or using the the ``proxmox-backup-manager`` CLI tool. +Certificates are managed through the Proxmox Backup +web-interface/API or using the ``proxmox-backup-manager`` CLI tool. .. _sysadmin_certs_upload_custom: @@ -61,9 +61,9 @@ Note that any certificate key files must not be password protected. Trusted certificates via Let’s Encrypt (ACME) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`Proxmox Backup`_ includes an implementation of the **A**\ utomatic +Proxmox Backup includes an implementation of the **A**\ utomatic **C**\ ertificate **M**\ anagement **E**\ nvironment (**ACME**) -protocol, allowing `Proxmox Backup`_ admins to use an ACME provider +protocol, allowing Proxmox Backup admins to use an ACME provider like Let’s Encrypt for easy setup of TLS certificates, which are accepted and trusted by modern operating systems and web browsers out of the box. @@ -112,7 +112,7 @@ ACME Plugins ^^^^^^^^^^^^ The ACME plugin’s role is to provide automatic verification that you, -and thus the `Proxmox Backup`_ server under your operation, are the +and thus the Proxmox Backup Server under your operation, are the real owner of a domain. This is the basic building block of automatic certificate management. @@ -129,7 +129,7 @@ DNS record in the domain’s zone. :align: right :alt: Create ACME Account -`Proxmox Backup`_ supports both of those challenge types out of the +Proxmox Backup supports both of those challenge types out of the box, you can configure plugins either over the web interface under ``Certificates -> ACME Challenges``, or using the ``proxmox-backup-manager acme plugin add`` command. @@ -180,7 +180,7 @@ with Let’s Encrypts ACME. - There **must** be no other listener on port 80. - The requested (sub)domain needs to resolve to a public IP of the - `Proxmox Backup`_ host. + Proxmox Backup host. .. _sysadmin_certs_acme_dns_challenge: @@ -197,7 +197,7 @@ allows provisioning of ``TXT`` records via an API. Configuring ACME DNS APIs for validation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -`Proxmox Backup`_ re-uses the DNS plugins developed for the +Proxmox Backup re-uses the DNS plugins developed for the ``acme.sh`` [1]_ project. Please refer to its documentation for details on configuration of specific APIs. @@ -215,7 +215,7 @@ and entering the credential data to access your account over their API. your provider. Configuration values do not need to be quoted with single or double quotes; for some plugins that is even an error. -As there are many DNS providers and API endpoints, `Proxmox Backup`_ +As there are many DNS providers and API endpoints, Proxmox Backup automatically generates the form for the credentials, but not all providers are annotated yet. For those you will see a bigger text area, into which you simply need to copy all the credential’s @@ -231,7 +231,7 @@ domain/DNS server, in case your primary/real DNS does not support provisioning via an API. Manually set up a permanent ``CNAME`` record for ``_acme-challenge.domain1.example`` pointing to ``_acme-challenge.domain2.example``, and set the ``alias`` property in -the `Proxmox Backup`_ node configuration file ``/etc/proxmox-backup/node.cfg`` +the Proxmox Backup node configuration file ``/etc/proxmox-backup/node.cfg`` to ``domain2.example`` to allow the DNS server of ``domain2.example`` to validate all challenges for ``domain1.example``. @@ -284,7 +284,7 @@ Manually Change Certificate over the Command Line If you want to get rid of certificate verification warnings, you have to generate a valid certificate for your server. -Log in to your `Proxmox Backup`_ via ssh or use the console: +Log in to your Proxmox Backup via ssh or use the console: :: @@ -309,9 +309,9 @@ Follow the instructions on the screen, for example: After you have finished the certificate request, you have to send the file ``req.pem`` to your Certification Authority (CA). The CA will issue the certificate (BASE64 encoded), based on your request – save this file -as ``cert.pem`` to your `Proxmox Backup`_. +as ``cert.pem`` to your Proxmox Backup. -To activate the new certificate, do the following on your `Proxmox Backup`_ +To activate the new certificate, do the following on your Proxmox Backup :: @@ -328,7 +328,7 @@ Test your new certificate, using your browser. .. note:: - To transfer files to and from your `Proxmox Backup`_, you can use + To transfer files to and from your Proxmox Backup, you can use secure copy: If your desktop runs Linux, you can use the ``scp`` command-line tool. If your desktop PC runs windows, please use an scp client like WinSCP (see https://winscp.net/). diff --git a/docs/configuration-files.rst b/docs/configuration-files.rst index 0540d0b1..ba54a7b0 100644 --- a/docs/configuration-files.rst +++ b/docs/configuration-files.rst @@ -1,7 +1,7 @@ Configuration Files =================== -All Proxmox Backup Server configuration files reside in the directory +All `Proxmox Backup`_ Server configuration files reside in the directory ``/etc/proxmox-backup/``. diff --git a/docs/faq.rst b/docs/faq.rst index 80220675..342174f9 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -4,7 +4,7 @@ FAQ What distribution is Proxmox Backup Server (PBS) based on? ---------------------------------------------------------- -Proxmox Backup Server is based on `Debian GNU/Linux `_. +`Proxmox Backup`_ Server is based on `Debian GNU/Linux `_. Which platforms are supported as a backup source (client)? diff --git a/docs/gui.rst b/docs/gui.rst index 5ccfd1ae..9547c73f 100644 --- a/docs/gui.rst +++ b/docs/gui.rst @@ -1,7 +1,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 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 diff --git a/docs/installation.rst b/docs/installation.rst index a3367d17..44c28067 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -16,10 +16,10 @@ The backup server stores the actual backed up data and provides a web based GUI for various management tasks such as disk management. .. note:: You always need a backup server. It is not possible to use - `Proxmox Backup`_ without the server part. + Proxmox Backup without the server part. The disk image (ISO file) provided by Proxmox includes a complete Debian system -as well as all necessary packages for the `Proxmox Backup`_ Server. +as well as all necessary packages for the Proxmox Backup Server. The installer will guide you through the setup process and allow you to partition the local disk(s), apply basic system configuration @@ -27,7 +27,7 @@ you to partition the local disk(s), apply basic system configuration The provided ISO will get you started in just a few minutes, and is the recommended method for new and existing users. -Alternatively, `Proxmox Backup`_ Server can be installed on top of an +Alternatively, Proxmox Backup Server can be installed on top of an existing Debian system. Install `Proxmox Backup`_ Server using the Installer @@ -36,7 +36,7 @@ Install `Proxmox Backup`_ Server using the Installer Download the ISO from |DOWNLOADS|. It includes the following: -* The `Proxmox Backup`_ Server installer, which partitions the local +* The Proxmox Backup Server installer, which partitions the local disk(s) with ext4, xfs or ZFS, and installs the operating system * Complete operating system (Debian Linux, 64-bit) @@ -77,7 +77,7 @@ 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. -.. caution:: Installing `Proxmox Backup`_ on top of an existing Debian_ +.. 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 @@ -110,7 +110,7 @@ After configuring the 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 top of a standard diff --git a/docs/introduction.rst b/docs/introduction.rst index ebec543c..5859fac9 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -4,8 +4,8 @@ Introduction What is Proxmox Backup Server? ------------------------------ -Proxmox Backup Server is an enterprise-class, client-server backup solution that -is capable of backing up :term:`virtual machine`\ s, +`Proxmox Backup`_ Server is an enterprise-class, client-server backup solution +that is capable of backing up :term:`virtual machine`\ s, :term:`container`\ s, and physical hosts. It is specially optimized for the `Proxmox Virtual Environment`_ platform and allows you to back up your data securely, even between remote sites, providing easy management through a diff --git a/docs/local-zfs.rst b/docs/local-zfs.rst index dec9166f..bef3cf8a 100644 --- a/docs/local-zfs.rst +++ b/docs/local-zfs.rst @@ -172,7 +172,7 @@ Changing a failed device Changing a failed bootable device ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Depending on how Proxmox Backup was installed, it is either using `grub` or +Depending on how `Proxmox Backup`_ was installed, it is either using `grub` or `systemd-boot` as a bootloader. In either case, the first steps of copying the partition table, reissuing GUIDs @@ -195,7 +195,7 @@ With `systemd-boot`: # proxmox-boot-tool init .. NOTE:: `ESP` stands for EFI System Partition, which is setup as partition #2 on - bootable disks setup by the `Proxmox Backup`_ installer. For details, see + bootable disks setup by the Proxmox Backup installer. For details, see :ref:`Setting up a new partition for use as synced ESP `. With `grub`: @@ -214,7 +214,7 @@ Activate e-mail notification ZFS comes with an event daemon, ``ZED``, which monitors events generated by the ZFS kernel module. The daemon can also send emails upon ZFS events, such as pool errors. Newer ZFS packages ship the daemon in a separate package ``zfs-zed``, -which should already be installed by default in `Proxmox Backup`_. +which should already be installed by default in Proxmox Backup. You can configure the daemon via the file ``/etc/zfs/zed.d/zed.rc``, using your preferred editor. The required setting for email notfication is @@ -224,7 +224,7 @@ preferred editor. The required setting for email notfication is ZED_EMAIL_ADDR="root" -Please note that `Proxmox Backup`_ forwards mails to `root` to the email address +Please note that Proxmox Backup forwards mails to `root` to the email address configured for the root user. diff --git a/docs/maintenance.rst b/docs/maintenance.rst index 2d6abbe2..d8a9d27a 100644 --- a/docs/maintenance.rst +++ b/docs/maintenance.rst @@ -171,7 +171,7 @@ start. GC Background ^^^^^^^^^^^^^ -In Proxmox Backup Server, backup data is not saved directly, but rather as +In `Proxmox Backup`_ Server, backup data is not saved directly, but rather as chunks that are referred to by the indexes of each backup snapshot. This approach enables reuse of chunks through deduplication, among other benefits that are detailed in the :ref:`tech_design_overview`. diff --git a/docs/managing-remotes.rst b/docs/managing-remotes.rst index 1c52e120..f8dcff6d 100644 --- a/docs/managing-remotes.rst +++ b/docs/managing-remotes.rst @@ -6,11 +6,11 @@ Managing Remotes & Sync :term:`Remote` -------------- -A remote refers to a separate Proxmox Backup Server installation and a user on that -installation, from which you can `sync` datastores to a local datastore with a -`Sync Job`. You can configure remotes in the web interface, under **Configuration --> Remotes**. Alternatively, you can use the ``remote`` subcommand. The -configuration information for remotes is stored in the file +A remote refers to a separate `Proxmox Backup`_ Server installation and a user +on that installation, from which you can `sync` datastores to a local datastore +with a `Sync Job`. You can configure remotes in the web interface, under +**Configuration -> Remotes**. Alternatively, you can use the ``remote`` +subcommand. The configuration information for remotes is stored in the file ``/etc/proxmox-backup/remote.cfg``. .. image:: images/screenshots/pbs-gui-remote-add.png diff --git a/docs/markdown-primer.rst b/docs/markdown-primer.rst index acdbd9ac..c7465af3 100644 --- a/docs/markdown-primer.rst +++ b/docs/markdown-primer.rst @@ -10,7 +10,7 @@ Markdown Primer -- John Gruber, https://daringfireball.net/projects/markdown/ -The "Notes" panel of the Proxmox Backup Server web-interface supports +The "Notes" panel of the `Proxmox Backup`_ Server web-interface supports rendering Markdown text. Proxmox Backup Server supports CommonMark with most extensions of GFM (GitHub diff --git a/docs/network-management.rst b/docs/network-management.rst index 624883ba..5ae19e56 100644 --- a/docs/network-management.rst +++ b/docs/network-management.rst @@ -8,8 +8,8 @@ Network Management :align: right :alt: System and Network Configuration Overview -Proxmox Backup Server provides both a web interface and a command-line tool for -network configuration. You can find the configuration options in the web +`Proxmox Backup`_ Server provides both a web interface and a command-line tool +for network configuration. You can find the configuration options in the web interface under the **Network Interfaces** section of the **Configuration** menu tree item. The command-line tool is accessed via the ``network`` subcommand. These interfaces allow you to carry out some basic network management tasks, diff --git a/docs/package-repositories.rst b/docs/package-repositories.rst index 360e3aa3..8f0473e5 100644 --- a/docs/package-repositories.rst +++ b/docs/package-repositories.rst @@ -70,7 +70,7 @@ and the md5sum, with the expected output below: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This is the stable, recommended repository. It is available for -all `Proxmox Backup`_ subscription users. It contains the most stable packages, +all Proxmox Backup subscription users. It contains the most stable packages, and is suitable for production use. The ``pbs-enterprise`` repository is enabled by default: diff --git a/docs/pve-integration.rst b/docs/pve-integration.rst index 35b28eb3..e3a91af3 100644 --- a/docs/pve-integration.rst +++ b/docs/pve-integration.rst @@ -3,8 +3,8 @@ `Proxmox VE`_ Integration ------------------------- -Proxmox Backup Server can be integrated into a Proxmox VE standalone or cluster -setup, by adding it as a storage in Proxmox VE. +`Proxmox Backup`_ Server can be integrated into a Proxmox VE standalone or +cluster setup, by adding it as a storage in Proxmox VE. See also the `Proxmox VE Storage - Proxmox Backup Server `_ section diff --git a/docs/pxar/description.rst b/docs/pxar/description.rst index ac8473bc..61f9c882 100644 --- a/docs/pxar/description.rst +++ b/docs/pxar/description.rst @@ -3,8 +3,8 @@ It is inspired by `casync file archive format `_, 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 hard links. +The ``.pxar`` format is adapted to fulfill the specific needs of the +`Proxmox Backup`_ Server, for example, efficient storage of hard links. The format is designed to reduce the required storage on the server by achieving a high level of deduplication. diff --git a/docs/storage.rst b/docs/storage.rst index 100e8ecd..0eb3df7d 100644 --- a/docs/storage.rst +++ b/docs/storage.rst @@ -11,7 +11,7 @@ Disk Management :align: right :alt: List of disks -Proxmox Backup Server comes with a set of disk utilities, which are +`Proxmox Backup`_ Server comes with a set of disk utilities, which are accessed using the ``disk`` subcommand or the web interface. This subcommand allows you to initialize disks, create various filesystems, and get information about the disks. diff --git a/docs/sysadmin.rst b/docs/sysadmin.rst index 88bf256f..114ad4cb 100644 --- a/docs/sysadmin.rst +++ b/docs/sysadmin.rst @@ -9,7 +9,7 @@ Debian packages, and that the base system is well documented. The `Debian Administrator's Handbook`_ is available online, and provides a comprehensive introduction to the Debian operating system. -A standard `Proxmox Backup`_ installation uses the default +A standard Proxmox Backup installation uses the default repositories from Debian, so you get bug fixes and security updates through that channel. In addition, we provide our own package repository to roll out all Proxmox related packages. This includes @@ -19,8 +19,8 @@ We also deliver a specially optimized Linux kernel, based on the Ubuntu kernel. This kernel includes drivers for ZFS_. The following sections will concentrate on backup related topics. They -will explain things which are different on `Proxmox Backup`_, or -tasks which are commonly used on `Proxmox Backup`_. For other topics, +will explain things which are different on Proxmox Backup, or +tasks which are commonly used on Proxmox Backup. For other topics, please refer to the standard Debian documentation. diff --git a/docs/system-booting.rst b/docs/system-booting.rst index b9631c9e..0b1043bf 100644 --- a/docs/system-booting.rst +++ b/docs/system-booting.rst @@ -17,7 +17,7 @@ also applies to systems which are installed on top of Debian). Partitioning Scheme Used by the Installer ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The `Proxmox Backup`_ installer creates 3 partitions on all disks selected for +The Proxmox Backup installer creates 3 partitions on all disks selected for installation. The created partitions are: @@ -96,7 +96,7 @@ For example, to format an empty partition ``/dev/sda2`` as ESP, run the followin # proxmox-boot-tool format /dev/sda2 To setup an existing, unmounted ESP located on ``/dev/sda2`` for inclusion in -`Proxmox Backup`_'s kernel update synchronization mechanism, use the following: +Proxmox Backup's kernel update synchronization mechanism, use the following: .. code-block:: console @@ -187,7 +187,7 @@ Determine which Bootloader is Used :alt: Grub boot screen The simplest and most reliable way to determine which bootloader is used, is to -watch the boot process of the `Proxmox Backup`_ node. +watch the boot process of the Proxmox Backup node. You will either see the blue box of ``grub`` or the simple black on white @@ -265,8 +265,8 @@ Systemd-boot ``systemd-boot`` is a lightweight EFI bootloader. It reads the kernel and initrd images directly from the EFI Service Partition (ESP) where it is installed. The main advantage of directly loading the kernel from the ESP is that it does -not need to reimplement the drivers for accessing the storage. In `Proxmox -Backup`_, :ref:`proxmox-boot-tool ` is used to +not need to reimplement the drivers for accessing the storage. In Proxmox +Backup, :ref:`proxmox-boot-tool ` is used to keep the configuration on the ESPs synchronized. .. _systembooting-systemd-boot-config: @@ -342,7 +342,7 @@ would run: # proxmox-boot-tool kernel pin 5.15.30-1-pve -.. TIP:: The pinning functionality works for all `Proxmox Backup`_ systems, not only those using +.. TIP:: The pinning functionality works for all Proxmox Backup systems, not only those using ``proxmox-boot-tool`` to synchronize the contents of the ESPs, if your system does not use ``proxmox-boot-tool`` for synchronizing, you can also skip the ``proxmox-boot-tool refresh`` call in the end. diff --git a/docs/tape-backup.rst b/docs/tape-backup.rst index 30ff6049..a6d3298d 100644 --- a/docs/tape-backup.rst +++ b/docs/tape-backup.rst @@ -65,7 +65,7 @@ tape compression feature has no advantage. Supported Hardware ------------------ -Proxmox Backup Server supports `Linear Tape-Open`_ generation 5 (LTO-5) +`Proxmox Backup`_ Server supports `Linear Tape-Open`_ generation 5 (LTO-5) or later and has best-effort support for generation 4 (LTO-4). While many LTO-4 systems are known to work, some might need firmware updates or do not implement necessary features to work with Proxmox Backup Server. diff --git a/docs/technical-overview.rst b/docs/technical-overview.rst index 1f0fef71..89835a7c 100644 --- a/docs/technical-overview.rst +++ b/docs/technical-overview.rst @@ -234,8 +234,8 @@ Restore without a Running Proxmox Backup Server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ It's possible to restore specific files from a snapshot, without a running -Proxmox Backup Server instance, using the ``recover`` subcommand, provided you -have access to the intact index and chunk files. Note that you also need the +`Proxmox Backup`_ Server instance, using the ``recover`` subcommand, provided +you have access to the intact index and chunk files. Note that you also need the corresponding key file if the backup was encrypted. .. code-block:: console diff --git a/docs/terminology.rst b/docs/terminology.rst index 1ba7d463..7ba8910c 100644 --- a/docs/terminology.rst +++ b/docs/terminology.rst @@ -17,7 +17,7 @@ backup virtual machine images. Variable sized chunking needs more CPU power, but is essential to get good deduplication rates for file archives. -The Proxmox Backup Server supports both strategies. +The `Proxmox Backup`_ Server supports both strategies. Image Archives: ``.img`` diff --git a/docs/user-management.rst b/docs/user-management.rst index 822443f9..44040217 100644 --- a/docs/user-management.rst +++ b/docs/user-management.rst @@ -12,7 +12,7 @@ User Configuration :align: right :alt: User management -Proxmox Backup Server supports several authentication realms, and you need to +`Proxmox Backup`_ Server supports several authentication realms, and you need to choose the realm when you add a new user. Possible realms are: :pam: Linux PAM standard authentication. Use this if you want to -- 2.39.2