docs/installation.rst

   1 Installation
   2 ============
   3
   4 `Proxmox Backup`_ is split into a server part and a client part. The
   5 server part comes with it's own graphical installer, but we also
   6 ship Debian_ package repositories, so you can easily install those
   7 packages on any Debian_ based system.
   8
   9 .. include:: package-repositories.rst
  10
  11
  12 Server installation
  13 -------------------
  14
  15 The backup server stores the actual backup data, but also provides a
  16 web based GUI for various management tasks, for example disk
  17 management.
  18
  19 .. note:: You always need a backup server. It is not possible to use
  20    `Proxmox Backup`_ without the server part.
  21
  22 The server is based on Debian, therefore the disk image (ISO file) provided
  23 by us includes a complete Debian system ("buster" for version 1.x) as
  24 well as all necessary backup packages.
  25
  26 Using the installer will guide you through the setup, allowing
  27 you to partition the local disk(s), apply basic system configurations
  28 (e.g. timezone, language, network) and install all required packages.
  29 Using the provided ISO will get you started in just a few minutes,
  30 that's why we recommend this method for new and existing users.
  31
  32 Alternatively, `Proxmox Backup`_ server can be installed on top of an
  33 existing Debian system.
  34
  35 Using the `Proxmox Backup`_ Installer
  36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  37
  38 You can download the ISO from |DOWNLOADS|.
  39 It includes the following:
  40
  41 * Complete operating system (Debian Linux, 64-bit)
  42
  43 * The `Proxmox Backup`_ server installer, which partitions the local
  44   disk(s) with ext4, ext3, xfs or ZFS and installs the operating
  45   system.
  46
  47 * Our Linux kernel with ZFS support.
  48
  49 * Complete toolset for administering backups and all necessary
  50   resources
  51
  52 * Web based management interface for using the toolset
  53
  54 .. note:: During the installation process, the complete server
  55    is used by default and all existing data is removed.
  56
  57
  58 Install `Proxmox Backup`_ server on Debian
  59 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  60
  61 Proxmox ships as a set of Debian packages, so you can install it on
  62 top of a standard Debian installation.  After configuring the
  63 :ref:`sysadmin_package_repositories`, you need to run:
  64
  65 .. code-block:: console
  66
  67   # apt-get update
  68   # apt-get install proxmox-backup-server
  69
  70 Above code keeps the current (Debian) kernel and installs a minimal
  71 set of required packages.
  72
  73 If you want to install the same set of packages as the installer
  74 does, please use the following:
  75
  76 .. code-block:: console
  77
  78   # apt-get update
  79   # apt-get install proxmox-backup
  80
  81 This installs all required packages, the Proxmox kernel with ZFS_
  82 support, and a set of commonly useful packages.
  83
  84 Installing on top of an existing Debian_ installation looks easy, but
  85 it presumes that you have correctly installed the base system, and you
  86 know how you want to configure and use the local storage. Network
  87 configuration is also completely up to you.
  88
  89 In general, this is not trivial, especially when you use LVM_ or
  90 ZFS_.
  91
  92 Install Proxmox Backup server on `Proxmox VE`_
  93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94
  95 After configuring the
  96 :ref:`sysadmin_package_repositories`, you need to run:
  97
  98 .. code-block:: console
  99
 100   # apt-get update
 101   # apt-get install proxmox-backup-server
 102
 103 .. caution:: Installing the backup server directly on the hypervisor
 104    is not recommended. It is more secure to use a separate physical
 105    server to store backups. If the hypervisor server fails, you can
 106    still access your backups.
 107
 108 Client installation
 109 -------------------
 110
 111 Install `Proxmox Backup`_ client on Debian
 112 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 113
 114 Proxmox ships as a set of Debian packages, so you can install it on
 115 top of a standard Debian installation.  After configuring the
 116 :ref:`sysadmin_package_repositories`, you need to run:
 117
 118 .. code-block:: console
 119
 120   # apt-get update
 121   # apt-get install proxmox-backup-client
 122
 123
 124 Installing from source
 125 ~~~~~~~~~~~~~~~~~~~~~~
 126
 127 .. todo:: Add section "Installing from source"
 128
 129 Installing statically linked binary
 130 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 131
 132 .. todo:: Add section "Installing statically linked binary"