From 7391b4cf713c4a983babb4ba3ab718eb40eead7c Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Mon, 11 Nov 2019 12:28:04 +0100 Subject: [PATCH] package-repositories.rst: new file --- docs/epilog.rst | 2 + docs/installation.rst | 2 + docs/package-repositories.rst | 102 ++++++++++++++++++++++++++++++++++ 3 files changed, 106 insertions(+) create mode 100644 docs/package-repositories.rst diff --git a/docs/epilog.rst b/docs/epilog.rst index 307dc785..4fac62a8 100644 --- a/docs/epilog.rst +++ b/docs/epilog.rst @@ -11,8 +11,10 @@ .. _LZ4: https://en.wikipedia.org/wiki/LZ4_(compression_algorithm) .. _Proxmox: https://www.proxmox.com .. _Proxmox Virtual Environment: https://www.proxmox.com/proxmox-ve +.. _Proxmox Backup: https://www.proxmox.com/proxmox-backup .. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html .. _Rust: https://www.rust-lang.org/ .. _SHA-256: https://en.wikipedia.org/wiki/SHA-2 .. _Sphinx: https://www.sphinx-doc.org .. _Virtual machine: https://en.wikipedia.org/wiki/Virtual_machine +.. _APT: http://en.wikipedia.org/wiki/Advanced_Packaging_Tool diff --git a/docs/installation.rst b/docs/installation.rst index f5717cac..3aaab3a0 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -3,6 +3,8 @@ Installation sdfsd dfgfd dgd +.. include:: package-repositories.rst + This aasd safd -------------- diff --git a/docs/package-repositories.rst b/docs/package-repositories.rst new file mode 100644 index 00000000..d11ff1b9 --- /dev/null +++ b/docs/package-repositories.rst @@ -0,0 +1,102 @@ +Debian Package Repositories +--------------------------- + +All Debian based systems use APT_ as package +management tool. The list of repositories is defined in +``/etc/apt/sources.list`` and ``.list`` files found inside +``/etc/apt/sources.d/``. Updates can be installed directly using +the ``apt`` command line tool, or via the GUI. + +APT_ ``sources.list`` files list one package repository per line, with +the most preferred source listed first. Empty lines are ignored, and a +``#`` character anywhere on a line marks the remainder of that line as a +comment. The information available from the configured sources is +acquired by ``apt update``. + +.. code-block:: sources.list + :caption: File: ``/etc/apt/sources.list`` + + deb http://ftp.debian.org/debian buster main contrib + deb http://ftp.debian.org/debian buster-updates main contrib + + # security updates + deb http://security.debian.org/debian-security buster/updates main contrib + + +.. FIXME for 7.0: change security update suite to bullseye-security + +In addition, Proxmox provides three different package repositories for +the backup server binaries. + +`Proxmox Backup`_ Enterprise Repository +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This is the default, stable and recommended repository, available for +all `Proxmox Backup`_ subscription users. It contains the most stable packages, +and is suitable for production use. The ``pbs-enterprise`` repository is +enabled by default: + +.. code-block:: sources.list + :caption: File: ``/etc/apt/sources.list.d/pbs-enterprise.list`` + + deb https://enterprise.proxmox.com/debian/pbs buster pbs-enterprise + + +As soon as updates are available, the superuser (``root@pam`` user) is +notified via email about the available new packages. On the GUI, the +change-log of each package can be viewed (if available), showing all +details of the update. So you will never miss important security +fixes. + +Please note that you need a valid subscription key to access this +repository. We offer different support levels, and you can find further +details at https://www.proxmox.com/en/proxmox-backup/pricing. + +.. note:: You can disable this repository by commenting out the above + line using a `#` (at the start of the line). This prevents error + messages if you do not have a subscription key. Please configure the + ``pbs-no-subscription`` repository in that case. + + +`Proxmox Backup`_ No-Subscription Repository +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +As the name suggests, you do not need a subscription key to access +this repository. It can be used for testing and non-production +use. Its not recommended to run on production servers, as these +packages are not always heavily tested and validated. + +We recommend to configure this repository in ``/etc/apt/sources.list``. + +.. code-block:: sources.list + :caption: File: ``/etc/apt/sources.list`` + + deb http://ftp.debian.org/debian buster main contrib + deb http://ftp.debian.org/debian buster-updates main contrib + + # PBS pbs-no-subscription repository provided by proxmox.com, + # NOT recommended for production use + deb http://download.proxmox.com/debian/bps buster pbs-no-subscription + + # security updates + deb http://security.debian.org/debian-security buster/updates main contrib + + +`Proxmox Backup`_ Test Repository +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Finally, there is a repository called ``pbstest``. This one contains the +latest packages and is heavily used by developers to test new +features. + +.. warning:: the ``pbstest`` repository should (as the name implies) + only be used for testing new features or bug fixes. + +As usual, you can configure this using ``/etc/apt/sources.list`` by +adding the following line: + +.. code-block:: sources.list + :caption: sources.list entry for ``pbstest`` + + deb http://download.proxmox.com/debian/bps buster pbstest +