docs/deployment-guide.rst

   1 Deployment Guide
   2 ================
   3
   4 The deployment guide.
   5
   6 Backup Server Configuration
   7 ---------------------------
   8
   9 The command line tool to configure and manage the server is called
  10 :command:`proxmox-backup-manager`.
  11
  12
  13 Datastore Configuration
  14 ~~~~~~~~~~~~~~~~~~~~~~~
  15
  16 A :term:`datastore` is a place to store backups. You can configure
  17 several datastores, but you need at least one of them. The datastore is identified by a simple `name` and point to a directory.
  18
  19 The following command creates a new datastore called ``store1`` on :file:`/backup/disk1/store1`
  20
  21 .. code-block:: console
  22
  23   # proxmox-backup-manager datastore create store1 /backup/disk1/store1
  24
  25 To list existing datastores use:
  26
  27 .. code-block:: console
  28
  29   # proxmox-backup-manager datastore list
  30   store1 /backup/disk1/store1
  31
  32 Finally, it is also possible to remove the datastore configuration:
  33
  34 .. code-block:: console
  35
  36   # proxmox-backup-manager datastore remove store1
  37
  38 .. note:: Above command removes the datastore configuration. It does
  39    not delete any data from the underlying directory.
  40
  41
  42
  43 Backup Client Configuration
  44 ---------------------------
  45
  46 The command line client is called :command:`proxmox-backup-client`.
  47
  48 Respository Locations
  49 ~~~~~~~~~~~~~~~~~~~~~
  50
  51 The client uses a special repository notation to specify a datastore
  52 on the backup server.
  53
  54   [[username@]server:]datastore
  55
  56 If you do not specify a ``username`` the default is ``root@pam``. The
  57 default for server is to use the local host (``localhost``).
  58
  59 You can pass the repository by setting the ``--repository`` command
  60 line options, or by setting the ``PBS_REPOSITORY`` environment
  61 variable.
  62
  63
  64 Environment Variables
  65 ~~~~~~~~~~~~~~~~~~~~~~
  66
  67 ``PBS_REPOSITORY``
  68   The default backup repository.
  69
  70 ``PBS_PASSWORD``
  71   When set, this value is used for the password required for the
  72   backup server.
  73
  74 ``PBS_ENCRYPTION_PASSWORD``
  75
  76   When set, this value is used to access the secret encryption key (if
  77   protected by password).
  78
  79
  80 Creating Backups
  81 ~~~~~~~~~~~~~~~~
  82
  83
  84 Encryption
  85 ^^^^^^^^^^
  86
  87
  88 Restoring Data
  89 ~~~~~~~~~~~~~~
  90
  91
  92 `Proxmox VE`_ integration
  93 -------------------------