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 3E09161B35 for ; Mon, 7 Sep 2020 17:22:00 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 38485C93D for ; Mon, 7 Sep 2020 17:21:30 +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 861B6C914 for ; Mon, 7 Sep 2020 17:21:27 +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 559EE44A8C for ; Mon, 7 Sep 2020 17:21:27 +0200 (CEST) From: Dylan Whyte To: pbs-devel@lists.proxmox.com Date: Mon, 7 Sep 2020 17:21:12 +0200 Message-Id: <20200907152112.14057-7-d.whyte@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200907152112.14057-1-d.whyte@proxmox.com> References: <20200907152112.14057-1-d.whyte@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.012 Adjusted score from AWL reputation of From: address 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 Subject: [pbs-devel] [PATCH docs 6/6] Sync Jobs: add screenshots and explanation 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: Mon, 07 Sep 2020 15:22:00 -0000 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 560489fc..d672031c 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 -- 2.20.1