]> git.proxmox.com Git - proxmox-backup.git/blob - docs/package-repositories.rst
docs: update package repositories
[proxmox-backup.git] / 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 buster main contrib
21 deb http://ftp.debian.org/debian buster-updates main contrib
22
23 # security updates
24 deb http://security.debian.org/debian-security buster/updates main contrib
25
26
27 .. FIXME for 7.0: change security update suite to bullseye-security
28
29 In addition, you need a package repository from Proxmox to get Proxmox Backup
30 updates.
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 http://download.proxmox.com/debian/proxmox-ve-release-6.x.gpg -O /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
47
48 Verify the SHA512 checksum afterwards with:
49
50 .. code-block:: console
51
52 # sha512sum /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
53
54 The output should be:
55
56 .. code-block:: console
57
58 acca6f416917e8e11490a08a1e2842d500b3a5d9f322c6319db0927b2901c3eae23cfb5cd5df6facf2b57399d3cfa52ad7769ebdd75d9b204549ca147da52626 /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
59
60 and the md5sum:
61
62 .. code-block:: console
63
64 # md5sum /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
65
66 Here, the output should be:
67
68 .. code-block:: console
69
70 f3f6c5a3a67baf38ad178e5ff1ee270c /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
71
72 `Proxmox Backup`_ Enterprise Repository
73 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74
75 This will be the default, stable, and recommended repository. It is available for
76 all `Proxmox Backup`_ subscription users. It contains the most stable packages,
77 and is suitable for production use. The ``pbs-enterprise`` repository is
78 enabled by default:
79
80 .. code-block:: sources.list
81 :caption: File: ``/etc/apt/sources.list.d/pbs-enterprise.list``
82
83 deb https://enterprise.proxmox.com/debian/pbs buster pbs-enterprise
84
85
86 To never miss important security fixes, the superuser (``root@pam`` user) is
87 notified via email about new packages as soon as they are available. The
88 change-log and details of each package can be viewed in the GUI (if available).
89
90 Please note that you need a valid subscription key to access this
91 repository. More information regarding subscription levels and pricing can be
92 found at https://www.proxmox.com/en/proxmox-backup-server/pricing
93
94 .. note:: You can disable this repository by commenting out the above line
95 using a `#` (at the start of the line). This prevents error messages if you do
96 not have a subscription key. Please configure the ``pbs-no-subscription``
97 repository in that case.
98
99
100 `Proxmox Backup`_ No-Subscription Repository
101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
102
103 As the name suggests, you do not need a subscription key to access
104 this repository. It can be used for testing and non-production
105 use. It is not recommended to use it on production servers, because these
106 packages are not always heavily tested and validated.
107
108 We recommend to configure this repository in ``/etc/apt/sources.list``.
109
110 .. code-block:: sources.list
111 :caption: File: ``/etc/apt/sources.list``
112
113 deb http://ftp.debian.org/debian buster main contrib
114 deb http://ftp.debian.org/debian buster-updates main contrib
115
116 # PBS pbs-no-subscription repository provided by proxmox.com,
117 # NOT recommended for production use
118 deb http://download.proxmox.com/debian/pbs buster pbs-no-subscription
119
120 # security updates
121 deb http://security.debian.org/debian-security buster/updates main contrib
122
123
124 `Proxmox Backup`_ Test Repository
125 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
126
127 This repository contains the latest packages and is heavily used by developers
128 to test new features.
129
130 .. .. warning:: the ``pbstest`` repository should (as the name implies)
131 only be used to test new features or bug fixes.
132
133 You can access this repository by adding the following line to
134 ``/etc/apt/sources.list``:
135
136 .. code-block:: sources.list
137 :caption: sources.list entry for ``pbstest``
138
139 deb http://download.proxmox.com/debian/pbs buster pbstest