docs: fix some typos

[proxmox-backup.git] / docs / managing-remotes.rst

diff --git a/docs/managing-remotes.rst b/docs/managing-remotes.rst
index e8495db18a9f953f63a541919de14fba2070c7b5..7d47d8be2472bef02195f5a58b665a022ef9ab67 100644 (file)
--- a/docs/managing-remotes.rst
+++ b/docs/managing-remotes.rst
@@ -17,8 +17,8 @@ configuration information for remotes is stored in the file
   :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
+To add a remote, you need its hostname or IP address, 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, or navigate to
 **Dashboard** in the remote's web interface and select **Show Fingerprint**.
 
@@ -59,13 +59,14 @@ Sync Jobs
   :alt: Add a Sync Job
 
 Sync jobs are configured to pull the contents of a datastore on a **Remote** to
-a local datastore. You can manage sync jobs under **Configuration -> Sync Jobs**
-in the web interface, or using the ``proxmox-backup-manager sync-job`` command.
-The configuration information for sync jobs is stored at
+a local datastore. You can manage sync jobs in the web interface, from the
+**Sync Jobs** tab of the **Datastore** panel or from that of the Datastore
+itself. Alternatively, you can manage them with the ``proxmox-backup-manager
+sync-job`` command. The configuration information for sync jobs is stored at
 ``/etc/proxmox-backup/sync.cfg``. To create a new sync job, click the add button
 in the GUI, or use the ``create`` subcommand. After creating a sync job, you can
-either start it manually on the GUI or provide it with a schedule (see
-:ref:`calendar-events`) to run regularly.
+either start it manually from the GUI or provide it with a schedule (see
+:ref:`calendar-event-scheduling`) to run regularly.
 
 .. code-block:: console
 
@@ -79,4 +80,48 @@ either start it manually on the GUI or provide it with a schedule (see
   └────────────┴───────┴────────┴──────────────┴───────────┴─────────┘
   # proxmox-backup-manager sync-job remove pbs2-local
 
+To set up sync jobs, the configuring user needs the following permissions:
 
+#. ``Remote.Read`` on the ``/remote/{remote}/{remote-store}`` path
+#. At least ``Datastore.Backup`` on the local target datastore (``/datastore/{store}``)
+
+.. note:: A sync job can only sync backup groups that the configured remote's
+  user/API token can read. If a remote is configured with a user/API token that
+  only has ``Datastore.Backup`` privileges, only the limited set of accessible
+  snapshots owned by that user/API token can be synced.
+
+If the ``remove-vanished`` option is set, ``Datastore.Prune`` is required on
+the local datastore as well. If the ``owner`` option is not set (defaulting to
+``root@pam``) or is set to something other than the configuring user,
+``Datastore.Modify`` is required as well.
+
+If the ``group-filter`` option is set, only backup groups matching at least one
+of the specified criteria are synced. The available criteria are:
+
+* backup type, for example to only sync groups of the `ct` (Container) type:
+    .. code-block:: console
+
+     # proxmox-backup-manager sync-job update ID --group-filter type:ct
+* full group identifier
+    .. code-block:: console
+
+     # proxmox-backup-manager sync-job update ID --group-filter group:vm/100
+* regular expression matched against the full group identifier
+.. todo:: add example for regex
+
+The same filter is applied to local groups for handling of the
+``remove-vanished`` option.
+
+.. note:: The ``protected`` flag of remote backup snapshots will not be synced.
+
+Bandwidth Limit
+^^^^^^^^^^^^^^^
+
+Syncing a datastore to an archive can produce lots of traffic and impact other
+users of the network. So, to avoid network or storage congestion you can limit
+the bandwidth of the sync job by setting the ``rate-in`` option either in the
+web interface or using the ``proxmox-backup-manager`` command-line tool:
+
+.. code-block:: console
+
+    # proxmox-backup-manager sync-job update ID --rate-in 20MiB