From: Dylan Whyte <d.whyte@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH docs 6/6] Sync Jobs: add screenshots and explanation
Date: Mon, 7 Sep 2020 17:21:12 +0200 [thread overview]
Message-ID: <20200907152112.14057-7-d.whyte@proxmox.com> (raw)
In-Reply-To: <20200907152112.14057-1-d.whyte@proxmox.com>
Add screenshots of sync jobs panel in web interface
and explain how to carry out related tasks from it.
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---
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 <garbage-collection>` on the
--
2.20.1
next prev parent reply other threads:[~2020-09-07 15:22 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-07 15:21 [pbs-devel] [PATCH docs 0/6] Add GUI screenshots and explain Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 1/6] Add screenshots of web interface Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 2/6] Disk Management: Add screenshots and explanation Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 3/6] Datastore Config: add " Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 4/6] User Management: Add " Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 5/6] Network Config: " Dylan Whyte
2020-09-07 15:21 ` Dylan Whyte [this message]
2020-09-08 4:20 ` [pbs-devel] applied: [PATCH docs 0/6] Add GUI screenshots and explain Dietmar Maurer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200907152112.14057-7-d.whyte@proxmox.com \
--to=d.whyte@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox