docs/package-repositories.rst

   1 .. _sysadmin_package_repositories:
   2
   3 Debian Package Repositories
   4 ---------------------------
   5
   6 All Debian based systems use APT_ as a package management tool. The lists of
   7 repositories are defined in ``/etc/apt/sources.list`` and the ``.list`` files found
   8 in the ``/etc/apt/sources.d/`` directory. Updates can be installed directly
   9 with the ``apt`` command line tool, or via the GUI.
  10
  11 APT_ ``sources.list`` files list one package repository per line, with the most
  12 preferred source listed first. Empty lines are ignored and a ``#`` character
  13 anywhere on a line marks the remainder of that line as a comment. The
  14 information available from the configured sources is acquired by ``apt
  15 update``.
  16
  17 .. code-block:: sources.list
  18   :caption: File: ``/etc/apt/sources.list``
  19
  20   deb http://ftp.debian.org/debian bullseye main contrib
  21   deb http://ftp.debian.org/debian bullseye-updates main contrib
  22
  23   # security updates
  24   deb http://security.debian.org/debian-security bullseye-security main contrib
  25
  26
  27 In addition, you need a package repository from Proxmox to get Proxmox Backup
  28 updates.
  29
  30 .. _package_repos_secure_apt:
  31
  32 SecureApt
  33 ~~~~~~~~~
  34
  35 The `Release` files in the repositories are signed with GnuPG. APT is using
  36 these signatures to verify that all packages are from a trusted source.
  37
  38 If you install Proxmox Backup Server from an official ISO image, the
  39 verification key is already installed.
  40
  41 If you install Proxmox Backup Server on top of Debian, download and install the
  42 key with the following commands:
  43
  44 .. code-block:: console
  45
  46  # wget https://enterprise.proxmox.com/debian/proxmox-release-bullseye.gpg -O /etc/apt/trusted.gpg.d/proxmox-release-bullseye.gpg
  47
  48 Verify the SHA512 checksum afterwards with the expected output below:
  49
  50 .. code-block:: console
  51
  52  # sha512sum /etc/apt/trusted.gpg.d/proxmox-release-bullseye.gpg
  53  7fb03ec8a1675723d2853b84aa4fdb49a46a3bb72b9951361488bfd19b29aab0a789a4f8c7406e71a69aabbc727c936d3549731c4659ffa1a08f44db8fdcebfa  /etc/apt/trusted.gpg.d/proxmox-release-bullseye.gpg
  54
  55 and the md5sum, with the expected output below:
  56
  57 .. code-block:: console
  58
  59  # md5sum /etc/apt/trusted.gpg.d/proxmox-release-bullseye.gpg
  60  bcc35c7173e0845c0d6ad6470b70f50e /etc/apt/trusted.gpg.d/proxmox-release-bullseye.gpg
  61
  62 .. _sysadmin_package_repos_enterprise:
  63
  64 `Proxmox Backup`_ Enterprise Repository
  65 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  66
  67 This is the stable, recommended repository. It is available for
  68 all `Proxmox Backup`_ subscription users. It contains the most stable packages,
  69 and is suitable for production use. The ``pbs-enterprise`` repository is
  70 enabled by default:
  71
  72 .. code-block:: sources.list
  73   :caption: File: ``/etc/apt/sources.list.d/pbs-enterprise.list``
  74
  75   deb https://enterprise.proxmox.com/debian/pbs bullseye pbs-enterprise
  76
  77
  78 To never miss important security fixes, the superuser (``root@pam`` user) is
  79 notified via email about new packages as soon as they are available. The
  80 change-log and details of each package can be viewed in the GUI (if available).
  81
  82 Please note that you need a valid subscription key to access this
  83 repository. More information regarding subscription levels and pricing can be
  84 found at https://www.proxmox.com/en/proxmox-backup-server/pricing
  85
  86 .. note:: You can disable this repository by commenting out the above line
  87  using a `#` (at the start of the line). This prevents error messages if you do
  88  not have a subscription key. Please configure the ``pbs-no-subscription``
  89  repository in that case.
  90
  91
  92 `Proxmox Backup`_ No-Subscription Repository
  93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94
  95 As the name suggests, you do not need a subscription key to access
  96 this repository. It can be used for testing and non-production
  97 use. It is not recommended to use it on production servers, because these
  98 packages are not always heavily tested and validated.
  99
 100 We recommend to configure this repository in ``/etc/apt/sources.list``.
 101
 102 .. code-block:: sources.list
 103   :caption: File: ``/etc/apt/sources.list``
 104
 105   deb http://ftp.debian.org/debian bullseye main contrib
 106   deb http://ftp.debian.org/debian bullseye-updates main contrib
 107
 108   # PBS pbs-no-subscription repository provided by proxmox.com,
 109   # NOT recommended for production use
 110   deb http://download.proxmox.com/debian/pbs bullseye pbs-no-subscription
 111
 112   # security updates
 113   deb http://security.debian.org/debian-security bullseye-security main contrib
 114
 115
 116 `Proxmox Backup`_ Test Repository
 117 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 118
 119 This repository contains the latest packages and is heavily used by developers
 120 to test new features.
 121
 122 .. .. warning:: the ``pbstest`` repository should (as the name implies)
 123   only be used to test new features or bug fixes.
 124
 125 You can access this repository by adding the following line to
 126 ``/etc/apt/sources.list``:
 127
 128 .. code-block:: sources.list
 129   :caption: sources.list entry for ``pbstest``
 130
 131   deb http://download.proxmox.com/debian/pbs bullseye pbstest
 132
 133 .. _package_repositories_client_only:
 134
 135 Proxmox Backup Client-only Repository
 136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 137
 138 If you want to :ref:`use the the Proxmox Backup Client <client_creating_backups>`
 139 on systems using a Linux distribution not based on Proxmox projects, you can
 140 use the client-only repository.
 141
 142 Currently there's only a client-repository for APT based systems.
 143
 144 .. _package_repositories_client_only_apt:
 145
 146 APT-based Proxmox Backup Client Repository
 147 ++++++++++++++++++++++++++++++++++++++++++
 148
 149 For modern Linux distributions using `apt` as package manager, like all Debian
 150 and Ubuntu Derivative do, you may be able to use the APT-based repository.
 151
 152 In order to configure this repository you need to first :ref:`setup the Proxmox
 153 release key <package_repos_secure_apt>`. After that, add the repository URL to
 154 the APT sources lists.
 155
 156 **Repositories for Debian 11 (Bullseye) based releases**
 157
 158 This repository is tested with:
 159
 160 - Debian Bullseye
 161
 162 Edit the file ``/etc/apt/sources.list.d/pbs-client.list`` and add the following
 163 snipped
 164
 165 .. code-block:: sources.list
 166   :caption: File: ``/etc/apt/sources.list``
 167
 168   deb http://download.proxmox.com/debian/pbs-client bullseye main
 169
 170 **Repositories for Debian 10 (Buster) based releases**
 171
 172 This repository is tested with:
 173
 174 - Debian Buster
 175 - Ubuntu 20.04 LTS
 176
 177 It may work with older, and should work with more recent released versions.
 178
 179 Edit the file ``/etc/apt/sources.list.d/pbs-client.list`` and add the following
 180 snipped
 181
 182 .. code-block:: sources.list
 183   :caption: File: ``/etc/apt/sources.list``
 184
 185   deb http://download.proxmox.com/debian/pbs-client buster main
 186
 187 .. _node_options_http_proxy:
 188
 189 Repository Access Behind HTTP Proxy
 190 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 191
 192 Some setups have restricted access to the internet, sometimes only through a
 193 central proxy. You can setup a HTTP proxy through the Proxmox Backup Server's
 194 web-interface in the `Configuration -> Authentication` tab.
 195
 196 Once configured this proxy will be used for apt network requests and for
 197 checking a Proxmox Backup Server support subscription.
 198
 199 Standard HTTP proxy configurations are accepted, `[http://]<host>[:port]` where
 200 the `<host>` part may include an authorization, for example:
 201 `http://user:pass@proxy.example.org:12345`