chore: document minimal kernel requirement, siemens/ghostwire#48

Signed-off-by: thediveo <thediveo@gmx.eu>
siemens · Mar 18, 2024 · 9e8a8e3 · 9e8a8e3
1 parent 2b06c49
commit 9e8a8e3
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -39,6 +39,9 @@ First, ensure that you have the Docker _compose_ plugin v2 installed. For Debian
 users it is strongly recommended to install docker-ce instead of docker.io
 packages, as these are updated on a regular basis.
 
+Make sure you have a Linux kernel of at least version 4.11 installed, however we
+highly recommend at least kernel version 5.6 or later.
+
 To expose service TCP port 5001 only on localhost:
 
 ```bash

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -14,6 +14,9 @@
 We provide multi-architecture Docker images for the `linux/amd64` and
 `linux/arm64` architectures.
 
+> [!ATTENTION] Make sure you have a Linux kernel of at least version 4.11
+> installed, however we highly recommend at least kernel version 5.6 or later.
+
 <!-- tabs:start -->
 
 #### **Docker Compose v2**