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