[pbs-devel] [PATCH proxmox-backup] docs: substitute `Proxmox Backup` with full `Proxmox Backup Server`
Gabriel Goller
g.goller at proxmox.com
Mon Aug 12 13:58:08 CEST 2024
Sometimes we use `Proxmox Backup` although the `Proxmox Backup Server`
is meant. Use the full name as mentioned in our brand guideline.
Signed-off-by: Gabriel Goller <g.goller at proxmox.com>
---
Note: Not sure if we want to do this, most occurences seemed fitting to
me though. `Proxmox Backup` alone is also kind of ambiguous.
docs/certificate-management.rst | 18 ++++++++--------
docs/local-zfs.rst | 4 ++--
docs/notifications.rst | 2 +-
docs/sysadmin.rst | 8 +++----
docs/system-booting.rst | 37 +++++++++++++++++----------------
docs/system-requirements.rst | 8 +++----
docs/user-management.rst | 4 ++--
7 files changed, 41 insertions(+), 40 deletions(-)
diff --git a/docs/certificate-management.rst b/docs/certificate-management.rst
index 1c8846304d48..4ec4ecaf0221 100644
--- a/docs/certificate-management.rst
+++ b/docs/certificate-management.rst
@@ -4,7 +4,7 @@ Certificate Management
----------------------
Access to the API and thus the web-based administration interface is always
-encrypted through ``https``. Each `Proxmox Backup`_ host creates by default its
+encrypted through ``https``. Each `Proxmox Backup`_ Server host creates by default its
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.
@@ -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 Server stores its certificate and key in:
- ``/etc/proxmox-backup/proxy.pem``
@@ -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 Server 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 Server 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.
@@ -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 Server 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 Server 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 Server re-uses the DNS plugins developed for the
``acme.sh`` [1]_ project. Please refer to its documentation for details
on configuration of specific APIs.
@@ -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 Server 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 Server via ssh or use the console:
::
diff --git a/docs/local-zfs.rst b/docs/local-zfs.rst
index 83f89e704105..98d3dd4d3700 100644
--- a/docs/local-zfs.rst
+++ b/docs/local-zfs.rst
@@ -195,7 +195,7 @@ With `systemd-boot`:
# proxmox-boot-tool init <new ESP>
.. 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 Server installer. For details, see
:ref:`Setting up a new partition for use as synced ESP <systembooting-proxmox-boot-setup>`.
With `grub`:
@@ -224,7 +224,7 @@ preferred editor. The required setting for email notification is
ZED_EMAIL_ADDR="root"
-Please note that Proxmox Backup forwards mails to `root` to the email address
+Please note that Proxmox Backup Server forwards mails to `root` to the email address
configured for the root user.
diff --git a/docs/notifications.rst b/docs/notifications.rst
index 4ba8db86d295..6aed2175c56b 100644
--- a/docs/notifications.rst
+++ b/docs/notifications.rst
@@ -152,7 +152,7 @@ The following severities are in use:
Notification Events
-------------------
-The following table contains a list of all notification events in Proxmox Backup server, their
+The following table contains a list of all notification events in Proxmox Backup Server, their
type, severity and additional metadata fields. ``type`` as well as any other metadata field
may be used in ``match-field`` match rules.
diff --git a/docs/sysadmin.rst b/docs/sysadmin.rst
index d42b6a9b2af1..9655d19ffee4 100644
--- a/docs/sysadmin.rst
+++ b/docs/sysadmin.rst
@@ -3,13 +3,13 @@
Host System Administration
==========================
-`Proxmox Backup`_ is based on the famous Debian_ Linux
+`Proxmox Backup`_ Server is based on the famous Debian_ Linux
distribution. This means that you have access to the entire range of
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 Server 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 Server, or
+tasks which are commonly used on Proxmox Backup Server. For other topics,
please refer to the standard Debian documentation.
diff --git a/docs/system-booting.rst b/docs/system-booting.rst
index bef0dec74951..fb4e433c1e67 100644
--- a/docs/system-booting.rst
+++ b/docs/system-booting.rst
@@ -4,8 +4,8 @@
Host Bootloader
---------------
-`Proxmox Backup`_ currently uses one of two bootloaders, depending on the disk setup
-selected in the installer.
+`Proxmox Backup`_ Server currently uses one of two bootloaders, depending on
+the disk setup selected in the installer.
For EFI Systems installed with ZFS as the root filesystem ``systemd-boot`` is
used, unless Secure Boot is enabled. All other deployments use the standard
@@ -18,8 +18,8 @@ on top of Debian).
Partitioning Scheme Used by the Installer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The Proxmox Backup installer creates 3 partitions on all disks selected for
-installation.
+The Proxmox Backup Server installer creates 3 partitions on all disks selected
+for installation.
The created partitions are:
@@ -98,7 +98,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 Server's kernel update synchronization mechanism, use the following:
.. code-block:: console
@@ -198,7 +198,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 Server node.
You will either see the blue box of ``grub`` or the simple black on white
@@ -359,10 +359,11 @@ 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
- ``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.
+.. TIP:: The pinning functionality works for all Proxmox Backup Server 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.
You can also set a kernel version to be booted on the next system boot only.
This is useful, for example, to test if an updated kernel has resolved an issue,
@@ -400,8 +401,8 @@ content and configuration on the ESPs by running the ``refresh`` subcommand.
Secure Boot
~~~~~~~~~~~
-Since Proxmox Backup 3.1, Secure Boot is supported out of the box via signed
-packages and integration in ``proxmox-boot-tool``.
+Since Proxmox Backup Server 3.1, Secure Boot is supported out of the box via
+signed packages and integration in ``proxmox-boot-tool``.
The following packages need to be installed for Secure Boot to be enabled:
@@ -411,8 +412,8 @@ The following packages need to be installed for Secure Boot to be enabled:
* ``proxmox-kernel-6.X.Y-Z-pve-signed`` (Kernel image, signed by Proxmox)
Only Grub as bootloader is supported out of the box, since there are no other
-pre-signed bootloader packages available. Any new installation of Proxmox Backup
-will automatically have all of the above packages included.
+pre-signed bootloader packages available. Any new installation of Proxmox
+Backup Server will automatically have all of the above packages included.
More details about how Secure Boot works, and how to customize the setup, are
available in `our wiki <https://pve.proxmox.com/wiki/Secure_Boot_Setup>`_.
@@ -426,10 +427,10 @@ Switching an Existing Installation to Secure Boot
.. WARNING:: This can lead to an unbootable installation in some cases if not
done correctly. Reinstalling the host will setup Secure Boot automatically if
available, without any extra interactions. **Make sure you have a working and
- well-tested backup of your Proxmox Backup host!**
+ well-tested backup of your Proxmox Backup Server host!**
An existing UEFI installation can be switched over to Secure Boot if desired,
-without having to reinstall Proxmox Backup from scratch.
+without having to reinstall Proxmox Backup Server from scratch.
First, ensure all your system is up-to-date. Next, install all the required
pre-signed packages as listed above. Grub automatically creates the needed EFI
@@ -442,8 +443,8 @@ boot entry for booting via the default shim.
If ``systemd-boot`` is used as a bootloader (see
:ref:`Determine which Bootloader is used <systembooting-determine-bootloader>`),
-some additional setup is needed. This is only the case if Proxmox Backup was
-installed with ZFS-on-root.
+some additional setup is needed. This is only the case if Proxmox Backup Server
+was installed with ZFS-on-root.
To check the latter, run:
diff --git a/docs/system-requirements.rst b/docs/system-requirements.rst
index 023003c3a1f5..71575683cc71 100644
--- a/docs/system-requirements.rst
+++ b/docs/system-requirements.rst
@@ -1,10 +1,10 @@
System Requirements
-------------------
-We recommend using high quality server hardware when running Proxmox Backup in
-production. To further decrease the impact of a failed host, you can set up
-periodic, efficient, incremental :ref:`datastore synchronization <syncjobs>`
-from other Proxmox Backup Server instances.
+We recommend using high quality server hardware when running Proxmox Backup
+Server in production. To further decrease the impact of a failed host, you can
+set up periodic, efficient, incremental :ref:`datastore synchronization
+<syncjobs>` from other Proxmox Backup Server instances.
Minimum Server Requirements, for Evaluation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/user-management.rst b/docs/user-management.rst
index c670cbf6ae36..7a69529550c2 100644
--- a/docs/user-management.rst
+++ b/docs/user-management.rst
@@ -336,8 +336,8 @@ Some examples are:
:align: left
=========================== =========================================================
- ``/datastore`` Access to *all* datastores on a Proxmox Backup server
- ``/datastore/{store}`` Access to a specific datastore on a Proxmox Backup server
+ ``/datastore`` Access to *all* datastores on a Proxmox Backup Server
+ ``/datastore/{store}`` Access to a specific datastore on a Proxmox Backup Server
``/datastore/{store}/{ns}`` Access to a specific namespace on a specific datastore
``/remote`` Access to all remote entries
``/system/network`` Access to configure the host network
--
2.39.2
More information about the pbs-devel
mailing list