Bake cross-service port collision avoidance into every service script

With 70+ services sharing a handful of common default ports (emby and
jellyfin both default to 8096, changedetection and frigate both default
to 5000, arm and nextcloud both default to 8080...), nothing previously
checked whether a service's default port was actually free on the host.
Whichever service installed second would silently write a compose file
claiming an already-held port, only failing at `docker compose up` time.

Adds two shared helpers to lib/common.sh:
- port_in_use PORT [PROTO] — true if something's already listening
- find_free_port VARNAME START [PROTO] — scans upward, writes back the
  first free port

Every service that publishes a fixed host port now scans before writing
docker-compose.yml, on every install (not just when adding an explicit
additional instance). On a normal single-install host this is a silent
no-op; it only changes behavior when something else already holds the
port.

- The 19 services already given multi-instance support this session had
  their port scan moved out of the "add instance" branch to run
  unconditionally, since the same collision risk exists on a plain first
  install.
- 20 more services with previously-hardcoded ports gained scanning for
  the first time: archivebox, arm, calibre-web, changedetection,
  drum-rhythm-game, gatus, n8n, nextcloud, onlyoffice, stirling-pdf,
  uptimekuma, portainer, iopaint (both GPU/CPU compose branches), koha
  (paired), syncthing (paired), wg-easy (paired, plus WG_PORT env so
  generated peer configs keep the right Endpoint), homeassistant
  (bridge-mode only — host mode can only warn), frigate and
  frigate-audio (multi-port stacks, moved together).
- caddy.sh is the deliberate exception: 80/443 stay fixed and only warn
  on collision, since silently moving Caddy itself would leave nothing
  listening where any client actually looks.
- authelia.sh needs no change — it has no published host port at all.
- Every service's standalone bootstrap fallback (sudo bash services/x.sh
  with no sibling files) got the same two helpers duplicated into its
  stub block, matching how every other shared helper is already handled
  there.

Documents the full pattern in CLAUDE.md's new "Port collision avoidance"
section, including the quoted-heredoc/backtick-escaping gotcha and the
network_mode:host limitation (can only scan ports the app takes as a
configurable env var).

Verified via bash -n on every changed file, plus functional runs seeding
occupied ports for each collision shape used here (single, paired,
multi-port stacks) and confirming the scan/shift and generated
compose/README output are correct — including the emby/jellyfin,
nextcloud/arm, and frigate/changedetection collision scenarios that
originally motivated this.
This commit is contained in:
Claude
2026-08-09 23:55:49 +00:00
parent b860a8b174
commit 9e06ed4b83
42 changed files with 1269 additions and 254 deletions
+35 -13
View File
@@ -38,6 +38,21 @@ if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
chown -R "$ACTUAL_USER:$ACTUAL_USER" "$@" 2>/dev/null || true
}
port_in_use() {
local _port="$1" _proto="${2:-tcp}"
local _flag="-tlnH"
[ "$_proto" = "udp" ] && _flag="-ulnH"
ss "$_flag" "sport = :${_port}" 2>/dev/null | grep -q .
}
find_free_port() {
local _varname="$1" _port="$2" _proto="${3:-tcp}"
while port_in_use "$_port" "$_proto"; do
_port=$((_port + 1))
done
eval "$_varname='$_port'"
}
prompt_text() {
local _q="$1" _def="$2" _var="$3" _r
[[ "${UNATTENDED:-false}" == "true" ]] && { eval "$_var='$_def'"; return; }
@@ -182,15 +197,22 @@ install_archivebox() {
require_docker || return 1
local AB_DIR="$DOCKER_DIR/archivebox"
local WEB_PORT="8000"
if [ "$DRY_RUN" = true ]; then
echo "[DRY-RUN] archivebox would:"
echo " - Create $AB_DIR with docker-compose.yml"
echo " - Initialize ArchiveBox data directory"
echo " - Expose port 8000 (web UI)"
echo " - Expose port 8000 (web UI), auto-scanned for a free host port"
return 0
fi
# Scan for a free host port — this default (8000) isn't unique to
# ArchiveBox in this repo, so a plain install shouldn't silently claim a
# port another already-running service holds. See CLAUDE.md's "Port
# collision avoidance" section.
find_free_port WEB_PORT "$WEB_PORT"
mkdir -p "$AB_DIR"
ensure_docker_dir_ownership "$AB_DIR"
cd "$AB_DIR" || return 1
@@ -236,7 +258,7 @@ services:
volumes:
- ./data:/data
ports:
- "8000:8000"
- "${WEB_PORT}:8000"
${_CADDY_NET_BLOCK}${_CADDY_NET_SECTION}
ABCOMPOSE
@@ -254,47 +276,47 @@ ABENV
configure_caddy_for_service "ArchiveBox" "archivebox:8000" "archive"
write_readme "$AB_DIR" << 'MD'
write_readme "$AB_DIR" << MD
# ArchiveBox
Self-hosted web archiving — saves full snapshots of web pages (HTML, screenshots,
PDFs, WARC) like a personal Wayback Machine.
- Web UI: http://localhost:8000
- Web UI: http://localhost:${WEB_PORT}
## Manage
```bash
\`\`\`bash
cd ~/docker/archivebox
docker compose up -d # start
docker compose down # stop
docker compose logs -f # logs
docker compose pull && docker compose up -d # update
```
\`\`\`
## Add URLs to archive
```bash
# Via web UI — visit http://localhost:8000 and use the Add page
\`\`\`bash
# Via web UI — visit http://localhost:${WEB_PORT} and use the Add page
# Via CLI:
echo "https://example.com" | docker compose run --rm archivebox add
docker compose run --rm archivebox add --depth=1 https://example.com
```
\`\`\`
## Create admin user
```bash
\`\`\`bash
docker compose run --rm archivebox manage createsuperuser
```
\`\`\`
MD
local START_AB=""
prompt_yn "Start ArchiveBox now? (y/n):" "y" START_AB
if [ "$START_AB" = "y" ] || [ "$START_AB" = "Y" ]; then
docker compose up -d \
&& log_success "ArchiveBox started — http://localhost:8000" \
&& log_success "ArchiveBox started — http://localhost:${WEB_PORT}" \
|| log_warning "Start failed — check: docker compose logs"
fi
echo ""
echo " Web UI: http://localhost:8000"
echo " Web UI: http://localhost:${WEB_PORT}"
echo " Add URLs via the web UI or: echo 'URL' | docker compose run --rm archivebox add"
echo ""
}