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