All errors have documentation links

2026-04-15 22:51:37 -07:00 · 2025-10-31 22:24:31 +00:00
parent 1e63cec37c
commit 8edef9e852
24 changed files with 481 additions and 75 deletions
@@ -0,0 +1,69 @@
+#!/bin/sh
+# check-ports.sh detects and warns if required ports are already in use
+# or if they are configured to be the same.
+# Intended for lightweight Alpine containers (uses busybox netstat).
+
+# Define ports from ENV variables, applying defaults
+PORT_APP=${PORT:-20211}
+PORT_GQL=${APP_CONF_OVERRIDE:-${GRAPHQL_PORT:-20212}}
+
+# Check if ports are configured to be the same
+if [ "$PORT_APP" -eq "$PORT_GQL" ]; then
+    cat <<EOF
+══════════════════════════════════════════════════════════════════════════════
+⚠️  Configuration Warning: Both ports are set to ${PORT_APP}.
+
+    The Application port (\$PORT) and the GraphQL API port
+    (\$APP_CONF_OVERRIDE or \$GRAPHQL_PORT) are configured to use the
+    same port. This will cause a conflict.
+
+    https://github.com/jokob-sk/NetAlertX/blob/main/docs/docker-troubleshooting/port-conflicts.md
+══════════════════════════════════════════════════════════════════════════════
+EOF
+fi
+
+# Check for netstat (usually provided by busybox)
+if ! command -v netstat >/dev/null 2>&1; then
+    cat <<EOF
+══════════════════════════════════════════════════════════════════════════════
+⚠️  Configuration Error: 'netstat' command not found.
+
+    Cannot check port availability. Please ensure 'net-tools'
+    or the busybox 'netstat' applet is available in this container.
+══════════════════════════════════════════════════════════════════════════════
+EOF
+    exit 0 # Exit gracefully, this is a non-fatal check
+fi
+
+# Fetch all listening TCP/UDP ports once.
+# We awk $4 to get the 'Local Address' column (e.g., 0.0.0.0:20211 or :::20211)
+LISTENING_PORTS=$(netstat -lntu | awk '{print $4}')
+
+# Check Application Port
+# We grep for ':{PORT}$' to match the port at the end of the string.
+if echo "$LISTENING_PORTS" | grep -q ":${PORT_APP}$"; then
+    cat <<EOF
+══════════════════════════════════════════════════════════════════════════════
+⚠️  Port Warning: Application port ${PORT_APP} is already in use.
+
+    The main application (defined by \$PORT) may fail to start.
+
+    https://github.com/jokob-sk/NetAlertX/blob/main/docs/docker-troubleshooting/port-conflicts.md
+══════════════════════════════════════════════════════════════════════════════
+EOF
+fi
+
+# Check GraphQL Port
+# We add a check to avoid double-warning if ports are identical AND in use
+if [ "$PORT_APP" -ne "$PORT_GQL" ] && echo "$LISTENING_PORTS" | grep -q ":${PORT_GQL}$"; then
+    cat <<EOF
+══════════════════════════════════════════════════════════════════════════════
+⚠️  Port Warning: GraphQL API port ${PORT_GQL} is already in use.
+
+    The GraphQL API (defined by \$APP_CONF_OVERRIDE or \$GRAPHQL_PORT)
+    may fail to start.
+
+    https://github.com/jokob-sk/NetAlertX/blob/main/docs/docker-troubleshooting/port-conflicts.md
+══════════════════════════════════════════════════════════════════════════════
+EOF
+fi