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 ("buster" for version 1.x) 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 configurations
  26 (e.g. 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`_ with 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, ext3, xfs or ZFS, and installs the operating
  41   system
  42
  43 * Complete operating system (Debian Linux, 64-bit)
  44
  45 * Our Linux kernel with ZFS support
  46
  47 * Complete tool-set to administer backups and all necessary resources
  48
  49 * Web based GUI management interface
  50
  51 .. note:: During the installation process, the complete server
  52    is used by default and all existing data is removed.
  53
  54
  55 Install `Proxmox Backup`_ server on Debian
  56 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  57
  58 Proxmox ships as a set of Debian packages which can be installed on top of a
  59 standard Debian installation. After configuring the
  60 :ref:`sysadmin_package_repositories`, you need to run:
  61
  62 .. code-block:: console
  63
  64   # apt-get update
  65   # apt-get install proxmox-backup-server
  66
  67 The commands above keep the current (Debian) kernel and install a minimal
  68 set of required packages.
  69
  70 If you want to install the same set of packages as the installer
  71 does, please use the following:
  72
  73 .. code-block:: console
  74
  75   # apt-get update
  76   # apt-get install proxmox-backup
  77
  78 This will install all required packages, the Proxmox kernel with ZFS_
  79 support, and a set of common and useful packages.
  80
  81 .. caution:: Installing `Proxmox Backup`_ on top of an existing Debian_
  82   installation looks easy, but it assumes that the base system and local
  83   storage have been set up correctly. In general this is not trivial, especially
  84   when LVM_ or ZFS_ is used. The network configuration is completely up to you
  85   as well.
  86
  87 .. note:: You can access the web interface of the Proxmox Backup Server with
  88   your web browser, using HTTPS on port 8007. For example at
  89  ``https://<ip-or-dns-name>:8007``
  90
  91 Install Proxmox Backup server on `Proxmox VE`_
  92 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  93
  94 After configuring the
  95 :ref:`sysadmin_package_repositories`, you need to run:
  96
  97 .. code-block:: console
  98
  99   # apt-get update
 100   # apt-get install proxmox-backup-server
 101
 102 .. caution:: Installing the backup server directly on the hypervisor
 103    is not recommended. It is safer to use a separate physical
 104    server to store backups. Should the hypervisor server fail, you can
 105    still access the backups.
 106
 107 .. note::
 108   You can access the web interface of the Proxmox Backup Server with your web
 109   browser, using HTTPS on port 8007. For example at ``https://<ip-or-dns-name>:8007``
 110
 111 Client installation
 112 -------------------
 113
 114 Install `Proxmox Backup`_ client on Debian
 115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 116
 117 Proxmox ships as a set of Debian packages to be installed on
 118 top of a standard Debian installation. After configuring the
 119 :ref:`sysadmin_package_repositories`, you need to run:
 120
 121 .. code-block:: console
 122
 123   # apt-get update
 124   # apt-get install proxmox-backup-client
 125
 126
 127 Installing from source
 128 ~~~~~~~~~~~~~~~~~~~~~~
 129
 130 .. todo:: Add section "Installing from source"
 131
 132 Installing statically linked binary
 133 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 134
 135 .. todo:: Add section "Installing statically linked binary"