docs/installation.rst

   1 Installation
   2 ============
   3
   4 `Proxmox Backup`_ is split into a server and client part. The server part
   5 can either be installed with a graphical installer or on top of
   6 Debian_ from the provided package repository.
   7
   8 .. include:: system-requirements.rst
   9
  10 .. include:: package-repositories.rst
  11
  12 Server Installation
  13 -------------------
  14
  15 The backup server stores the actual backed up data and provides a web based GUI
  16 for various management tasks such as disk management.
  17
  18 .. note:: You always need a backup server. It is not possible to use
  19    `Proxmox Backup`_ without the server part.
  20
  21 The disk image (ISO file) provided by Proxmox includes a complete Debian system
  22 as well as all necessary packages for the `Proxmox Backup`_ Server.
  23
  24 The installer will guide you through the setup process and allow
  25 you to partition the local disk(s), apply basic system configuration
  26 (for example timezone, language, network), and install all required packages.
  27 The provided ISO will get you started in just a few minutes, and is the
  28 recommended method for new and existing users.
  29
  30 Alternatively, `Proxmox Backup`_ Server can be installed on top of an
  31 existing Debian system.
  32
  33 Install `Proxmox Backup`_ Server using the Installer
  34 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35
  36 Download the ISO from |DOWNLOADS|.
  37 It includes the following:
  38
  39 * The `Proxmox Backup`_ Server installer, which partitions the local
  40   disk(s) with ext4, xfs or ZFS, and installs the operating system
  41
  42 * Complete operating system (Debian Linux, 64-bit)
  43
  44 * Proxmox Linux kernel with ZFS support
  45
  46 * Complete tool-set to administer backups and all necessary resources
  47
  48 * Web based management interface
  49
  50 .. note:: During the installation process, the complete server
  51    is used by default and all existing data is removed.
  52
  53
  54 Install `Proxmox Backup`_ Server on Debian
  55 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  56
  57 Proxmox ships as a set of Debian packages which can be installed on top of a
  58 standard Debian installation. After configuring the
  59 :ref:`sysadmin_package_repositories`, you need to run:
  60
  61 .. code-block:: console
  62
  63   # apt-get update
  64   # apt-get install proxmox-backup-server
  65
  66 The above commands keep the current (Debian) kernel and install a minimal
  67 set of required packages.
  68
  69 If you want to install the same set of packages as the installer
  70 does, please use the following:
  71
  72 .. code-block:: console
  73
  74   # apt-get update
  75   # apt-get install proxmox-backup
  76
  77 This will install all required packages, the Proxmox kernel with ZFS_
  78 support, and a set of common and useful packages.
  79
  80 .. caution:: Installing `Proxmox Backup`_ on top of an existing Debian_
  81   installation looks easy, but it assumes that the base system and local
  82   storage have been set up correctly. In general this is not trivial, especially
  83   when LVM_ or ZFS_ is used. The network configuration is completely up to you
  84   as well.
  85
  86 .. Note:: You can access the web interface of the Proxmox Backup Server with
  87    your web browser, using HTTPS on port 8007. For example at
  88    ``https://<ip-or-dns-name>:8007``
  89
  90 Install Proxmox Backup Server on `Proxmox VE`_
  91 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92
  93 After configuring the
  94 :ref:`sysadmin_package_repositories`, you need to run:
  95
  96 .. code-block:: console
  97
  98   # apt-get update
  99   # apt-get install proxmox-backup-server
 100
 101 .. caution:: Installing the backup server directly on the hypervisor
 102    is not recommended. It is safer to use a separate physical
 103    server to store backups. Should the hypervisor server fail, you can
 104    still access the backups.
 105
 106 .. Note:: You can access the web interface of the Proxmox Backup Server with
 107    your web browser, using HTTPS on port 8007. For example at
 108    ``https://<ip-or-dns-name>:8007``
 109
 110 Client Installation
 111 -------------------
 112
 113 Install `Proxmox Backup`_ Client on Debian
 114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 115
 116 Proxmox ships as a set of Debian packages to be installed on top of a standard
 117 Debian installation. After configuring the :ref:`package_repositories_client_only_apt`,
 118 you need to run:
 119
 120 .. code-block:: console
 121
 122   # apt-get update
 123   # apt-get install proxmox-backup-client
 124
 125
 126 .. note:: The client-only repository should be usable by most recent Debian and
 127    Ubuntu derivatives.
 128