From 654c56e05d7085bae968170be0b3eb19efadc282 Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Thu, 25 Mar 2021 10:31:47 +0100 Subject: [PATCH] docs: client benchmark: note that tls is only done if repo is set and remove misleading note about no network involved in tls speedtest, as normally there is! Signed-off-by: Thomas Lamprecht --- docs/backup-client.rst | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/backup-client.rst b/docs/backup-client.rst index 598fd55d2..07826a759 100644 --- a/docs/backup-client.rst +++ b/docs/backup-client.rst @@ -3,6 +3,7 @@ Backup Client Usage The command line client is called :command:`proxmox-backup-client`. +.. _client_repository: Repository Locations -------------------- @@ -691,8 +692,15 @@ Benchmarking ------------ The backup client also comes with a benchmarking tool. This tool measures -various metrics relating to compression and encryption speeds. You can run a -benchmark using the ``benchmark`` subcommand of ``proxmox-backup-client``: +various metrics relating to compression and encryption speeds. If a Proxmox +Backup repository (remote or local) is specified, the TLS upload speed will get +measured too. + +You can run a benchmark using the ``benchmark`` subcommand of +``proxmox-backup-client``: + +.. note:: The TLS speed test is only included if a :ref:`backup server + repository is specified `. .. code-block:: console @@ -723,8 +731,7 @@ benchmark using the ``benchmark`` subcommand of ``proxmox-backup-client``: .. note:: The percentages given in the output table correspond to a - comparison against a Ryzen 7 2700X. The TLS test connects to the - local host, so there is no network involved. + comparison against a Ryzen 7 2700X. You can also pass the ``--output-format`` parameter to output stats in ``json``, rather than the default table format.