]> git.proxmox.com Git - proxmox-backup.git/blob - docs/package-repositories.rst
implement subscription handling and api
[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 updates.
30
31 During the Proxmox Backup beta phase, only one repository (pbstest) will be
32 available. Once released, an Enterprise repository for production use and a
33 no-subscription repository will be provided.
34
35 SecureApt
36 ~~~~~~~~~
37
38 The `Release` files in the repositories are signed with GnuPG. APT is using
39 these signatures to verify that all packages are from a trusted source.
40
41 If you install Proxmox Backup Server from an official ISO image, the
42 verification key is already installed.
43
44 If you install Proxmox Backup Server on top of Debian, download and install the
45 key with the following commands:
46
47 .. code-block:: console
48
49 # wget http://download.proxmox.com/debian/proxmox-ve-release-6.x.gpg -O /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
50
51 Verify the SHA512 checksum afterwards with:
52
53 .. code-block:: console
54
55 # sha512sum /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
56
57 The output should be:
58
59 .. code-block:: console
60
61 acca6f416917e8e11490a08a1e2842d500b3a5d9f322c6319db0927b2901c3eae23cfb5cd5df6facf2b57399d3cfa52ad7769ebdd75d9b204549ca147da52626 /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
62
63 and the md5sum:
64
65 .. code-block:: console
66
67 # md5sum /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
68
69 Here, the output should be:
70
71 .. code-block:: console
72
73 f3f6c5a3a67baf38ad178e5ff1ee270c /etc/apt/trusted.gpg.d/proxmox-ve-release-6.x.gpg
74
75 .. comment
76 `Proxmox Backup`_ Enterprise Repository
77 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78
79 This will be the default, stable, and recommended repository. It is available for
80 all `Proxmox Backup`_ subscription users. It contains the most stable packages,
81 and is suitable for production use. The ``pbs-enterprise`` repository is
82 enabled by default:
83
84 .. note:: During the Proxmox Backup beta phase only one repository (pbstest)
85 will be available.
86
87 .. code-block:: sources.list
88 :caption: File: ``/etc/apt/sources.list.d/pbs-enterprise.list``
89
90 deb https://enterprise.proxmox.com/debian/pbs buster pbs-enterprise
91
92
93 To never miss important security fixes, the superuser (``root@pam`` user) is
94 notified via email about new packages as soon as they are available. The
95 change-log and details of each package can be viewed in the GUI (if available).
96
97 Please note that you need a valid subscription key to access this
98 repository. More information regarding subscription levels and pricing can be
99 found at https://www.proxmox.com/en/proxmox-backup/pricing.
100
101 .. note:: You can disable this repository by commenting out the above
102 line using a `#` (at the start of the line). This prevents error
103 messages if you do not have a subscription key. Please configure the
104 ``pbs-no-subscription`` repository in that case.
105
106
107 `Proxmox Backup`_ No-Subscription Repository
108 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109
110 As the name suggests, you do not need a subscription key to access
111 this repository. It can be used for testing and non-production
112 use. It is not recommended to use it on production servers, because these
113 packages are not always heavily tested and validated.
114
115 We recommend to configure this repository in ``/etc/apt/sources.list``.
116
117 .. code-block:: sources.list
118 :caption: File: ``/etc/apt/sources.list``
119
120 deb http://ftp.debian.org/debian buster main contrib
121 deb http://ftp.debian.org/debian buster-updates main contrib
122
123 # PBS pbs-no-subscription repository provided by proxmox.com,
124 # NOT recommended for production use
125 deb http://download.proxmox.com/debian/pbs buster pbs-no-subscription
126
127 # security updates
128 deb http://security.debian.org/debian-security buster/updates main contrib
129
130
131 `Proxmox Backup`_ Beta Repository
132 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133
134 During the public beta, there is a repository called ``pbstest``. This one
135 contains the latest packages and is heavily used by developers to test new
136 features.
137
138 .. .. warning:: the ``pbstest`` repository should (as the name implies)
139 only be used to test new features or bug fixes.
140
141 You can access this repository by adding the following line to
142 ``/etc/apt/sources.list``:
143
144 .. code-block:: sources.list
145 :caption: sources.list entry for ``pbstest``
146
147 deb http://download.proxmox.com/debian/pbs buster pbstest
148
149 If you installed Proxmox Backup Server from the official beta ISO, you should
150 have this repository already configured in
151 ``/etc/apt/sources.list.d/pbstest-beta.list``