From fe6b6f4386447bf1d884454048e74280e02efe72 Mon Sep 17 00:00:00 2001 From: Daan Date: Fri, 10 Jul 2026 10:32:52 +0200 Subject: [PATCH 1/7] chore: multiple changes: - The Docker installation has been removed from the Greenbone docs, since its best left to Docker themselves to detail that. (our current docs were drifting already) - The documentation has been enrichted with more hyperlinks to applications which are detailed - Minor grammar changes - The DOWNLOAD_DIR variable has been renamed to greenbone-ce, the abbreviation --- src/22.4/container/preamble.md | 8 +- src/22.4/container/prerequisites.md | 147 +++++----------------------- 2 files changed, 30 insertions(+), 125 deletions(-) diff --git a/src/22.4/container/preamble.md b/src/22.4/container/preamble.md index da887c7c..4c29a7d7 100644 --- a/src/22.4/container/preamble.md +++ b/src/22.4/container/preamble.md @@ -1,11 +1,11 @@ Running the Greenbone Community Edition from containers requires knowledge about: -* Using a terminal -* Using [docker] -* Running services via [docker compose][docker-compose] +* Using a terminal/shell (e.g. [bash] or [sh]). +* Using [docker](https://www.docker.com/) and/or [podman](https://podman.io/). +* Running services via [docker compose](https://docs.docker.com/compose/). Additionally, a basic knowledge about the {doc}`architecture ` -of the Greenbone Community Edition is required to understand the setup. +of the Greenbone Community Edition is required to understand the setup and inner workings. ```{note} This guide is intended for users who want to test the newest features diff --git a/src/22.4/container/prerequisites.md b/src/22.4/container/prerequisites.md index c547dd3b..1d31aeef 100644 --- a/src/22.4/container/prerequisites.md +++ b/src/22.4/container/prerequisites.md @@ -1,162 +1,67 @@ ## Prerequisites ```{note} -Please follow the guide step by step. Later steps might require settings or -output of a previous command. +Please follow the guide step by step. +Later steps might require settings or output of a previous command. ``` -The command {command}`sudo` is used for executing commands that require privileged -access on the system. +The `sudo`-command is used for executing commands and binaries that require privileged access on the system. -### Install dependencies - -There are a few dependencies required for the following steps like [curl](https://curl.se/), which is required for downloading files from this guide. +### Dependencies +There are a few dependencies required for the following steps like [curl](https://curl.se/) +(alternatively [wget](https://www.gnu.org/software/wget/)) and [docker](https://www.docker.com/), +of which the former is required to downloading files from this guide. +[curl](https://curl.se/) can be separately downloaded through the instructions below, +but it will also be installed when following the Docker engine installation docs. `````{tabs} ````{tab} Debian/Ubuntu ```{code-block} shell --- -caption: Install ca-certificates, curl and gnupg Debian/Ubuntu packages +caption: Install ca-certificates and curl Debian/Ubuntu packages --- -sudo apt install ca-certificates curl gnupg +sudo apt install ca-certificates curl ``` ```` ````{tab} Fedora/CentOS ```{code-block} shell --- -caption: Install ca-certificates, curl and gnupg Fedora/CentOS packages +caption: Install ca-certificates and curl Fedora/CentOS packages --- -sudo dnf install ca-certificates curl gnupg +sudo dnf install ca-certificates curl ``` ```` ````` ### Installing Docker -[docker] is required for running the services within containers. Docker can be -installed by running the following commands (taken from the Docker Engine [install guide](https://docs.docker.com/engine/install/)): +[Docker](https://www.docker.com/) (alternatively [podman](https://podman.io/)) +is the application with which the Greenbone stack will be deployed. +Docker can be installed by following the instructions provided directly by them. +Please refer to the: [Official Docker Engine Installation Guide](https://docs.docker.com/engine/install/)): -`````{tabs} -````{tab} Debian -```{code-block} shell ---- -caption: Uninstall conflicting Debian packages ---- -for pkg in docker.io docker-doc docker-compose podman-docker containerd runc; do sudo apt remove $pkg; done -``` -```{code-block} shell ---- -caption: Set up the Docker repository ---- -sudo install -m 0755 -d /etc/apt/keyrings -curl -fsSL https://download.docker.com/linux/debian/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg -sudo chmod a+r /etc/apt/keyrings/docker.gpg -echo \ - "deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian \ - "$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \ - sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -sudo apt update -``` -```{code-block} shell ---- -caption: Install Docker Debian packages ---- -sudo apt install docker-ce docker-ce-cli containerd.io docker-compose-plugin -``` -```` -````{tab} Ubuntu -```{code-block} shell ---- -caption: Uninstall conflicting Ubuntu packages ---- -for pkg in docker.io docker-doc docker-compose podman-docker containerd runc; do sudo apt remove $pkg; done -``` -```{code-block} shell ---- -caption: Set up the Docker repository ---- -sudo install -m 0755 -d /etc/apt/keyrings -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg -sudo chmod a+r /etc/apt/keyrings/docker.gpg -echo \ - "deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \ - "$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \ - sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -sudo apt update -``` -```{code-block} shell ---- -caption: Install Docker Ubuntu packages ---- -sudo apt install docker-ce docker-ce-cli containerd.io docker-compose-plugin -``` -```` -````{tab} Fedora -```{code-block} shell ---- -caption: Uninstall conflicting Fedora packages ---- -sudo dnf remove docker docker-client docker-client-latest docker-common docker-latest docker-latest-logrotate docker-logrotate docker-selinux docker-engine-selinux docker-engine -``` -```{code-block} shell ---- -caption: Install docker Fedora package ---- -sudo dnf -y install dnf-plugins-core -sudo dnf config-manager addrepo --from-repofile=https://download.docker.com/linux/fedora/docker-ce.repo -sudo dnf install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin -``` -```{code-block} shell ---- -caption: Start Docker ---- -sudo systemctl start docker -``` -```` -````{tab} CentOS -```{code-block} shell ---- -caption: Uninstall conflicting CentOS packages ---- -sudo dnf remove docker docker-client docker-client-latest docker-common docker-latest docker-latest-logrotate docker-logrotate docker-selinux docker-engine-selinux docker-engine -``` -```{code-block} shell ---- -caption: Install Docker CentOS package ---- -sudo dnf -y install dnf-plugins-core -sudo dnf config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo -sudo dnf install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin -``` -```{code-block} shell ---- -caption: Start Docker ---- -sudo systemctl start docker -``` -```` -````` -### Setup +### Setting up Docker -To allow the current user to run {command}`docker` and therefore start the -containers, they must be added to the *docker* user group. To make the group change -effective, either logout and login again or use {command}`su`. +To allow the current user to run `docker`-commands and therefore start the containers, +they must be added to the *docker* user group (or be run as root). +To make the group change effective, either logout and login again or use the `su`-command. ```{code-block} shell --- -caption: Add current user to docker group and apply group changes for the current shell environment +caption: Add current user to docker group and apply group changes for the current shell environment --- + sudo usermod -aG docker $USER && su $USER ``` -For downloading the Greenbone Community Edition docker compose file, a -destination directory should be created. +For downloading the Greenbone Community Edition docker compose file, +a destination directory should be created. ```{code-block} shell --- caption: Create download directory --- -export DOWNLOAD_DIR=$HOME/greenbone-community-container && mkdir -p $DOWNLOAD_DIR +export DOWNLOAD_DIR=$HOME/greenbone-ce && mkdir -p $DOWNLOAD_DIR ``` From a2def09b438f332cdf6bbf527b762616a4e4e239 Mon Sep 17 00:00:00 2001 From: Daan Date: Fri, 10 Jul 2026 10:37:29 +0200 Subject: [PATCH 2/7] chore: add changelog line --- src/changelog.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/changelog.md b/src/changelog.md index 02885ddc..e10eda45 100644 --- a/src/changelog.md +++ b/src/changelog.md @@ -23,6 +23,7 @@ and this project adheres to [Calendar Versioning](https://calver.org). * Use [`restart_policy`](https://docs.docker.com/reference/compose-file/deploy/#restart_policy) for container services * Use `compose.yaml` instead of `docker-compose.yml` everywhere in the docs * Use environment variables for the settings of gsad +* Rewrite the containre pre-requisites and -amble files ## 26.2.0 - 2026-02-24 From cf23d099e4695a166588308348dfa53aaa6653a1 Mon Sep 17 00:00:00 2001 From: DaanSelen <80752476+DaanSelen@users.noreply.github.com> Date: Fri, 10 Jul 2026 11:04:03 +0200 Subject: [PATCH 3/7] Update src/22.4/container/prerequisites.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Björn Ricks --- src/22.4/container/prerequisites.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/22.4/container/prerequisites.md b/src/22.4/container/prerequisites.md index 1d31aeef..f9998d6a 100644 --- a/src/22.4/container/prerequisites.md +++ b/src/22.4/container/prerequisites.md @@ -5,7 +5,7 @@ Please follow the guide step by step. Later steps might require settings or output of a previous command. ``` -The `sudo`-command is used for executing commands and binaries that require privileged access on the system. +The {command}`sudo`-command is used for executing commands and binaries that require privileged access on the system. ### Dependencies From 2507d105cf9d605430489323fe05c8578d10c6a0 Mon Sep 17 00:00:00 2001 From: DaanSelen <80752476+DaanSelen@users.noreply.github.com> Date: Fri, 10 Jul 2026 11:04:19 +0200 Subject: [PATCH 4/7] Update src/22.4/container/prerequisites.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Björn Ricks --- src/22.4/container/prerequisites.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/22.4/container/prerequisites.md b/src/22.4/container/prerequisites.md index f9998d6a..a7f937b8 100644 --- a/src/22.4/container/prerequisites.md +++ b/src/22.4/container/prerequisites.md @@ -10,7 +10,7 @@ The {command}`sudo`-command is used for executing commands and binaries that req ### Dependencies There are a few dependencies required for the following steps like [curl](https://curl.se/) -(alternatively [wget](https://www.gnu.org/software/wget/)) and [docker](https://www.docker.com/), +and [docker](https://www.docker.com/), of which the former is required to downloading files from this guide. [curl](https://curl.se/) can be separately downloaded through the instructions below, but it will also be installed when following the Docker engine installation docs. From 248dcd84f3f73400f1d40b72f61ae3ae8317ba22 Mon Sep 17 00:00:00 2001 From: DaanSelen <80752476+DaanSelen@users.noreply.github.com> Date: Fri, 10 Jul 2026 11:04:32 +0200 Subject: [PATCH 5/7] Update src/22.4/container/prerequisites.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Björn Ricks --- src/22.4/container/prerequisites.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/22.4/container/prerequisites.md b/src/22.4/container/prerequisites.md index a7f937b8..8ff0a937 100644 --- a/src/22.4/container/prerequisites.md +++ b/src/22.4/container/prerequisites.md @@ -63,5 +63,5 @@ a destination directory should be created. --- caption: Create download directory --- -export DOWNLOAD_DIR=$HOME/greenbone-ce && mkdir -p $DOWNLOAD_DIR +export DOWNLOAD_DIR=$HOME/greenbone-community-edition && mkdir -p $DOWNLOAD_DIR ``` From 975d51d3cf56a5e1d2010aa0ea35dac32f33d624 Mon Sep 17 00:00:00 2001 From: Daan Date: Fri, 10 Jul 2026 11:09:26 +0200 Subject: [PATCH 6/7] chore: fix minor typos --- src/22.4/container/preamble.md | 2 +- src/22.4/container/prerequisites.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/22.4/container/preamble.md b/src/22.4/container/preamble.md index 4c29a7d7..d1b380ab 100644 --- a/src/22.4/container/preamble.md +++ b/src/22.4/container/preamble.md @@ -1,6 +1,6 @@ Running the Greenbone Community Edition from containers requires knowledge about: -* Using a terminal/shell (e.g. [bash] or [sh]). +* Using a terminal/shell (e.g. {command}`bash` or {command}`sh`). * Using [docker](https://www.docker.com/) and/or [podman](https://podman.io/). * Running services via [docker compose](https://docs.docker.com/compose/). diff --git a/src/22.4/container/prerequisites.md b/src/22.4/container/prerequisites.md index 8ff0a937..2bb473de 100644 --- a/src/22.4/container/prerequisites.md +++ b/src/22.4/container/prerequisites.md @@ -39,7 +39,7 @@ sudo dnf install ca-certificates curl [Docker](https://www.docker.com/) (alternatively [podman](https://podman.io/)) is the application with which the Greenbone stack will be deployed. Docker can be installed by following the instructions provided directly by them. -Please refer to the: [Official Docker Engine Installation Guide](https://docs.docker.com/engine/install/)): +Please refer to the: [Official Docker Engine Installation Guide](https://docs.docker.com/engine/install/): ### Setting up Docker From 69b3d378a5c151d6e11f989943db3fec8c7ea740 Mon Sep 17 00:00:00 2001 From: Daan Date: Fri, 10 Jul 2026 11:11:00 +0200 Subject: [PATCH 7/7] chore: readd command {} --- src/22.4/container/prerequisites.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/22.4/container/prerequisites.md b/src/22.4/container/prerequisites.md index 2bb473de..0377ba2f 100644 --- a/src/22.4/container/prerequisites.md +++ b/src/22.4/container/prerequisites.md @@ -44,9 +44,9 @@ Please refer to the: [Official Docker Engine Installation Guide](https://docs.do ### Setting up Docker -To allow the current user to run `docker`-commands and therefore start the containers, +To allow the current user to run {command}`docker`-commands and therefore start the containers, they must be added to the *docker* user group (or be run as root). -To make the group change effective, either logout and login again or use the `su`-command. +To make the group change effective, either logout and login again or use the {command}`su`-command. ```{code-block} shell ---