From 132f535fffa76c6f4d93824ca0b7a710ed2d7419 Mon Sep 17 00:00:00 2001
From: Martin Weise <martin.weise@tuwien.ac.at>
Date: Fri, 19 Jan 2024 15:30:03 +0100
Subject: [PATCH] Updated documentation troubleshooting
---
.docs/deployment-docker-compose.md | 12 ++++++++++--
mkdocs.yml | 2 +-
2 files changed, 11 insertions(+), 3 deletions(-)
diff --git a/.docs/deployment-docker-compose.md b/.docs/deployment-docker-compose.md
index 4e78dad081..761feccfc1 100644
--- a/.docs/deployment-docker-compose.md
+++ b/.docs/deployment-docker-compose.md
@@ -61,7 +61,7 @@ since RabbitMQ maintains state inside the container.
We maintain a rapid prototype deployment option through Docker Compose (v2.17.0 and newer). This deployment creates the
core infrastructure and a single Docker container for all user-generated databases.
-=== ":simple-linux: Linux"
+=== "Linux"
Download and install [Docker Engine](https://docs.docker.com/desktop/install/linux-install/) for your Linux
distribution. Although the installation might work, we *do not* recommend Docker Desktop.
@@ -74,7 +74,7 @@ core infrastructure and a single Docker container for all user-generated databas
curl -sSL https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/dev/install.sh | bash
-=== ":simple-windows: Windows"
+=== "Windows"
Open `cmd.exe` as administrator and install WSL2 and the Debian subsystem:
@@ -126,6 +126,14 @@ In case the deployment is unsuccessful, we have explanations on their origin and
: *Solution*: Update your local Docker image cache by executing `docker compose pull`, it automatically downloads
all Docker images that have updates. Then apply the new images with `docker compose up -d`.
+**Error response from daemon: Error starting userland proxy: listen tcp4 0.0.0.0:xyz: bind: address already in use**
+
+: *Origin*: Your deployment machine (e.g. laptop, virtual machine) has the port `xyz` already assigned. Some service
+ or application is already listening to this port.
+: *Solution*: This service or application needs to be stopped. You can find out the service or application via
+ `sudo netstat -tulpn` (sudo is necessary for the process id) and then stop the service or application
+ gracefully or force a stop via `kill -15 PID` (not recommended).
+
## Security
!!! warning "Known security issues with the default configuration"
diff --git a/mkdocs.yml b/mkdocs.yml
index 3eef0cf8c1..ae8084fafc 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -7,8 +7,8 @@ docs_dir: .docs
nav:
- Home: index.md
- Deployment:
- - Kubernetes: deployment-helm.md
- Docker Compose: deployment-docker-compose.md
+ - Kubernetes: deployment-helm.md
- System:
- Overview: system.md
- Services:
--
GitLab