docs: Debian installation based on add_bareos_repository.sh script

1 files changed, 39 insertions, 23 deletions

diff --git a/docs/manuals/source/IntroductionAndTutorial/InstallingBareos.rst b/docs/manuals/source/IntroductionAndTutorial/InstallingBareos.rst
index 851498d39..bb8403333 100644
--- a/docs/manuals/source/IntroductionAndTutorial/InstallingBareos.rst
+++ b/docs/manuals/source/IntroductionAndTutorial/InstallingBareos.rst
@@ -154,38 +154,54 @@ Debian / Ubuntu
    single: Platform; Debian
    single: Platform; Ubuntu
 
-.. code-block:: sh
-   :caption: Shell example script for Bareos installation on Debian / Ubuntu
+Adding an Debian/Ubuntu repository requires multiple steps:
 
-   #!/bin/sh
+* Storing the Bareos signature key of the repository.
+* Storing the Bareos repository configuration file in :file:`/etc/apt/sources.list.d/`, which references to the repository server a the local key file.
+* If you're a Bareos subscription customer, you also need your login credentials for https://download.bareos.com/ in :file:`/etc/apt/auth.conf.d/`.
 
-   # See https://download.bareos.org/bareos/release/
-   # for applicable releases and distributions
+To simplify this, the each Debian/Ubuntu repository on https://download.bareos.org/ and https://download.bareos.com/ contain a script named :file:`add_bareos_repository.sh`.
 
-   DIST=Debian_11
-   # or
-   # DIST=Debian_10
-   # DIST=Debian_9.0
-   # DIST=xUbuntu_20.04
-   # DIST=xUbuntu_18.04
+Download the :file:`add_bareos_repository.sh` script
+matching the requested Bareos release
+and the distribution of the target system.
 
-   RELEASE=release/21
-   # or
-   # RELEASE=experimental/nightly
+Copy the script onto the target system and execute it with a shell (:command:`sh`) as root (e.g. using :command:`sudo`),
+or manually perform the steps that are documented in the script.
 
-   URL=https://download.bareos.org/bareos/$RELEASE/$DIST
+For example the script URL for bareos-21 and Debian 11 is:
 
-   # add the Bareos repository
-   wget -O /etc/apt/sources.list.d/bareos.list $URL/bareos.list
+* https://download.bareos.org/bareos/release/21/Debian_11/add_bareos_repository.sh
+* or for Bareos subscription customers:
 
-   # add package key
-   wget -q $URL/Release.key -O- | apt-key add -
+   * https://download.bareos.com/bareos/release/21/Debian_11/add_bareos_repository.sh
+   * .. note::
 
-   # install Bareos packages
-   apt-get update
-   apt-get install bareos bareos-database-postgresql
+        To download :file:`add_bareos_repository.sh` you must authenticate against https://download.bareos.com. If this is inconvenient, you can alternatively download :file:`add_bareos_repository_template.sh` and replace ``BAREOS_USERNAME`` and ``BAREOS_PASSWORD`` in there manually.
 
-If you use the versions of Bareos directly integrated into the distributions, please note that there are some differences, see :ref:`section-DebianOrgLimitations`.
+The :file:`add_bareos_repository.sh` script will:
+
+* Create a Bareos signature key file :file:`/etc/apt/keyrings/bareos-keyring.gpg`.
+* Create the Bareos repository configuration file :file:`/etc/apt/sources.list.d/bareos.sources`
+
+   * This file refers to the Bareos repository on the download server and to the local :file:`/etc/apt/keyrings/bareos-keyring.gpg` file.
+
+* If using https://download.bareos.com, it stores your credentials in :file:`/etc/apt/auth.conf.d/download_bareos_com.conf` file.
+
+.. code-block:: sh
+   :caption: Shell example script for Bareos installation on Debian / Ubuntu
+
+   #!/bin/sh
+
+   # download the matching add_bareos_repository.sh script from
+   # https://download.bareos.org/bareos/release/
+   # or https://download.bareos.com/bareos/release/
+
+   sudo sh ./add_bareos_repository.sh
+
+   # install Bareos packages
+   sudo apt-get update
+   sudo apt-get install bareos
 
 
 .. _section-FreeBSD: