[thumbnail="pmg-gui-backup.png", big=1]
endif::manvolnum[]
-{pmg} includes the ability to backup and restore the
+{pmg} includes the ability to back up and restore the
configuration. This includes the complete config from `/etc/pmg/`, the
-mail filter rules and the statistic database.
+mail filter rules, and the statistic database.
-NOTE: The backup does not include the network setup, and also no mail
-data from the postfix queue or the spam or virus quarantine.
+NOTE: The backup does not include the network setup, nor does it
+contain mail data from the postfix queue or the spam and virus
+quarantines.
Backups can be created locally or stored on a
-https://www.proxmox.com/en/proxmox-backup-server[Proxmox Backup Server]
+https://www.proxmox.com/en/proxmox-backup-server/overview[Proxmox Backup Server]
instance.
Local Backups
-------------
You can create a backup by simply pressing the 'Backup' button in the 'Local
-Backup/Restore' tab on the GUI, or by using the command line interface:
+Backup/Restore' tab on the GUI, or by using the command-line interface:
----
# pmgbackup backup
----
Restores are also possible using the GUI or command line, and you can
-select what parts you want to restore:
+select which parts you want to restore:
System Configuration::
restore finished
----
+[[pmgbackup_pbs]]
Proxmox Backup Server
---------------------
-In order to backup your {pmg} configuration on a Proxmox Backup Server you
-need configure the instance as backup 'remote'. You can then directly create
-and restore backups, as well as create a scheduled 'backup job' to run
-regular backups.
+In order to back up your {pmg} configuration on a Proxmox Backup
+Server, you first need to configure the instance as a backup 'remote'.
+You can then directly create and restore backups, as well as create a
+scheduled 'backup job' to run regular backups.
+[[pmgbackup_pbs_remotes]]
Remotes
~~~~~~~
ifndef::manvolnum[]
-[thumbnail="pmg-gui-pbs-remote.png", big=1]
+[thumbnail="pmg-gui-pbs-remote.png"]
endif::manvolnum[]
+
A Proxmox Backup Server remote can be configured using the 'Proxmox Backup
Server' panel in the 'Backup/Restore' menu of the GUI, or by using the
-`remote` subcommand of `pmgbackup`:
+`remote` subcommand of `pmgbackup`.
+
+NOTE: You can use API Tokens in place of a username/password combination.
+.Example addition of a Proxmox Backup Server remote with id 'archive'.
----
-# pmgbackup remote add backup --datastore big --server backup.proxmox.com --user 'pmgbackup@pbs!token' --password --fingerprint 09:54:ef:..snip..:88:af:47:fe:4c:3b:cf:8b:26:88:0b:4e:3c:b2
+# pmgbackup proxmox-backup remote add archive --datastore big --server backup.proxmox.com --user 'pmgbackup@pbs!token' --password --fingerprint 09:54:ef:..snip..:88:af:47:fe:4c:3b:cf:8b:26:88:0b:4e:3c:b2
Enter new password: ******
Retype new password: ******
----
-You can use API Tokens in place of a username/password combination.
+The fingerprint is optional, if the certificate of the Proxmox Backup Server
+remote is signed by a CA trusted by {pmg}.
-If the remote certificate is signed by a CA trusted by {pmg} the fingerprint
-is not required.
-
-Additionally you can configure `prune-settings` for each remote to control
-how many backups should be stored on the Proxmox Backup Server:
+Additionally, you can configure `prune-settings` for each remote, giving you
+flexible control over how many backups should be stored on the Proxmox Backup
+Server over a specific period of time.
+.Setting the prune options for the Proxmox Backup Server remote with id 'archive'.
----
-# pmgbackup remote set backup --keep-last 5 --keep-daily 30 --keep-yearly 5
+# pmgbackup remote set archive --keep-last 3 --keep-daily 14 --keep-weekly 8 --keep-monthly 12 --keep-yearly 7
----
-The backup-group is pruned after each successful backup according to the
-configured settings.
-The public settings are stored in `/etc/pmg/pbs/pbs.conf`, sensitive settings,
+If prune settings are configured, the backup-group of {pmg} is pruned
+automatically after each successful backup.
+
+The `notify` and `include-statistics` settings of a remote define the defaults
+for notifications and whether to include the statistic database in backups.
+They are also used for xref:pmgbackup_pbs_schedule[scheduled backups].
+
+The public settings are stored in `/etc/pmg/pbs/pbs.conf`. Sensitive settings,
like passwords are stored in individual files named after the remote inside
`/etc/pmg/pbs/`:
.Configuration Example (`/etc/pmg/pbs/pbs.conf`)
----
-pbs: backup
+pbs: archive
datastore big
server backup.proxmox.com
fingerprint 09:54:ef:..snip..:88:af:47:fe:4c:3b:cf:8b:26:88:0b:4e:3c:b2
username pmgbackup@pbs!token
----
+[[pmgbackup_pbs_jobs]]
Backup Jobs
~~~~~~~~~~~
-With a configured remote you can create backups using the GUI or the
-`pbsjob` subcommand of `pmgbackup`:
+ifndef::manvolnum[]
+[thumbnail="pmg-gui-pbs-backup.png", big=1]
+endif::manvolnum[]
+With a configured remote, you can create backups using the GUI or the
+`proxmox-backup backup` subcommand of the `pmgbackup` CLI tool.
+
+.Creating a new backup on the Proxmox Backup Server remote with id 'archive'.
----
-# pmgbackup pbsjob run backup
+# pmgbackup proxmox-backup backup archive
starting update of current backup state
Starting backup: host/pmg/2020-11-16T16:38:39Z
Client name: pmg
prune finished
----
-For restoring you can optionally select a particular backup-snapshot to return
-to the state of configuration and rules at that time. If you don't provide one
-the latest backup is restored:
+For restoring, you can optionally select a particular backup-snapshot to return
+to the state of configuration and rules at that time.
+
+From the command line, you can get a list of available backup snapshots using
+the `proxmox-backup list` subcommand:
+
+.Listing available backups from the Proxmox Backup Server remote with id 'archive'.
+----
+# pmgbackup proxmox-backup list archive
+┌────────────┬──────────────────────┬────────┐
+│ backup-id │ backup-time │ size │
+╞════════════╪══════════════════════╪════════╡
+│ pmg │ 2020-11-16T14:03:04Z │ 121910 │
+├────────────┼──────────────────────┼────────┤
+ ...
+└────────────┴──────────────────────┴────────┘
+----
+.Restoring a specific backup snapshot
----
-# pmgbackup pbsjob restore backup --backup-time 2020-11-16T14:03:04Z
+# pmgbackup proxmox-backup restore archive pmg 2020-11-16T14:03:04Z
starting restore of host/pmg/2020-11-16T14:03:04Z from backup
..snip..
restore finished
----
-You can mark a particular snapshot for garbage collection by Proxmox Backup
-Server, by forgetting it:
+You can remove a particular snapshot by using the `forget` subcommand. This
+allows the Proxmox Backup Server to remove it during garbage collection.
----
-# pmgbackup pbsjob forget backup 2020-11-16T14:03:04Z
+# pmgbackup proxmox-backup forget archive pmg 2020-11-16T14:03:04Z
----
+TIP: You can configure and access all backup-related functionality on
+both the web interface and the command-line interface.
+
+[[pmgbackup_pbs_schedule]]
Scheduled Backups
^^^^^^^^^^^^^^^^^
delay of 15 minutes each day:
----
-# pmgbackup pbsjob create backup --schedule '*-*-* 03:50:00' --delay '15 minutes'
+# pmgbackup proxmox-backup job create archive --schedule '*-*-* 03:50:00' --delay '15 minutes'
----
The randomized delay can help to prevent load-peaks on the backup server, if
-you have multiple backups, which all should start around the same time.
+you have multiple backups which should all start around the same time.
-The schedules are `systemd.timer` units. See the `systemd.time(7)` man page for
+The schedules are `systemd.timer` units. See the `systemd.time(7)` man page for
details on the time specification used.
projects / pmg-docs.git / blobdiff