From bc0608955e9655fe9fe42c71a47e916c92dc4e2c Mon Sep 17 00:00:00 2001 From: Dylan Whyte Date: Mon, 7 Sep 2020 17:21:12 +0200 Subject: [PATCH] Sync Jobs: add screenshots and explanation Add screenshots of sync jobs panel in web interface and explain how to carry out related tasks from it. Signed-off-by: Dylan Whyte --- docs/administration-guide.rst | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst index 560489fc4..d672031cf 100644 --- a/docs/administration-guide.rst +++ b/docs/administration-guide.rst @@ -631,18 +631,27 @@ of **Configuration** or by using the ``dns`` subcommand of 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`. +`Sync Job`. You can configure remotes in the web interface, under **Configuration +-> Remotes**. Alternatively, you can use the ``remote`` subcommand. + +.. image:: images/screenshots/pbs-gui-remote-add.png +.. image:: images/screenshots/pbs-gui-permissions-add.png + :width: 230 + :align: right + :alt: Add a remote To add a remote, you need its hostname or ip, a userid and password on the remote, and its certificate fingerprint. To get the fingerprint, use the -``proxmox-backup-manager cert info`` command on the remote. +``proxmox-backup-manager cert info`` command on the remote, or navigate to +**Dashboard** in the remote's web interface and select **Show Fingerprint**. .. code-block:: console # proxmox-backup-manager cert info |grep Fingerprint Fingerprint (sha256): 64:d3:ff:3a:50:38:53:5a:9b:f7:50:...:ab:fe -Using the information specified above, add the remote with: +Using the information specified above, you can add a remote from the **Remotes** +configuration panel, or by using the command: .. code-block:: console @@ -666,10 +675,16 @@ Use the ``list``, ``show``, ``update``, ``remove`` subcommands of Sync Jobs ~~~~~~~~~ -Sync jobs are configured to pull the contents of a datastore on a `Remote` to a -local datastore. You can either start the sync job manually on the GUI or -provide it with a :term:`schedule` to run regularly. The -``proxmox-backup-manager sync-job`` command is used to manage sync jobs: +.. image:: images/screenshots/pbs-gui-syncjob-add.png + :width: 230 + :align: right + :alt: Add a remote + +Sync jobs are configured to pull the contents of a datastore on a **Remote** to a +local datastore. You can either start a sync job manually on the GUI or +provide it with a :term:`schedule` to run regularly. You can manage sync jobs +under **Configuration -> Sync Jobs** in the web interface, or using the +``proxmox-backup-manager sync-job`` command: .. code-block:: console @@ -683,6 +698,7 @@ provide it with a :term:`schedule` to run regularly. The └────────────┴───────┴────────┴──────────────┴───────────┴─────────┘ # proxmox-backup-manager sync-job remove pbs2-local + Garbage Collection ~~~~~~~~~~~~~~~~~~ You can monitor and run :ref:`garbage collection ` on the