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.
403 lines
16 KiB
Bash
403 lines
16 KiB
Bash
#!/bin/bash
|
|
# services/nextcloud.sh — Self-hosted cloud storage with SMB/local file access (Nextcloud).
|
|
# Part of the modular post-install system (sourced by setup.sh).
|
|
#
|
|
# Can also be run standalone on any machine:
|
|
# sudo bash nextcloud.sh
|
|
# (Docker must already be installed when run standalone)
|
|
|
|
# ── Standalone bootstrap ──────────────────────────────────────────────────────
|
|
# Detected when the script is executed directly rather than sourced by setup.sh.
|
|
# Sets up helpers and globals, then defers execution until after the function
|
|
# definition at the bottom of this file.
|
|
if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
|
|
[[ "$(id -u)" == "0" ]] || { echo "Run with sudo: sudo bash $0"; exit 1; }
|
|
|
|
_SELF_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
_COMMON="$_SELF_DIR/../lib/common.sh"
|
|
|
|
if [[ -f "$_COMMON" ]]; then
|
|
# Full repo present — use the real helpers (picks up ~/docker/.config too)
|
|
# shellcheck source=../lib/common.sh
|
|
source "$_COMMON"
|
|
else
|
|
# One-off copy — inline minimal stubs so the script works without the repo
|
|
log_info() { echo -e "\033[0;34m[INFO]\033[0m $*"; }
|
|
log_success() { echo -e "\033[0;32m[OK]\033[0m $*"; }
|
|
log_warning() { echo -e "\033[1;33m[WARN]\033[0m $*"; }
|
|
log_error() { echo -e "\033[0;31m[ERROR]\033[0m $*" >&2; }
|
|
|
|
require_docker() {
|
|
command -v docker &>/dev/null || {
|
|
log_error "Docker not found. Install it first:"
|
|
log_error " curl -fsSL https://get.docker.com | sudo sh"
|
|
return 1
|
|
}
|
|
docker compose version &>/dev/null || {
|
|
log_error "Docker Compose plugin missing:"
|
|
log_error " sudo apt-get install -y docker-compose-plugin"
|
|
return 1
|
|
}
|
|
}
|
|
|
|
ensure_docker_dir_ownership() {
|
|
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'"
|
|
}
|
|
|
|
generate_password() {
|
|
local _len="${1:-32}"
|
|
tr -dc 'A-Za-z0-9' < /dev/urandom | head -c "$_len"
|
|
}
|
|
|
|
write_readme() {
|
|
local _dir="$1"; shift
|
|
[[ "${DRY_RUN:-false}" == "true" ]] && return 0
|
|
mkdir -p "$_dir"
|
|
cat > "$_dir/README.md"
|
|
}
|
|
|
|
# Match common.sh's eval-based pattern so local vars in install_* are set correctly
|
|
prompt_text() {
|
|
local _q="$1" _def="$2" _var="$3" _r
|
|
[[ "${UNATTENDED:-false}" == "true" ]] && { eval "$_var='$_def'"; return; }
|
|
read -r -p " $_q " _r
|
|
eval "$_var='${_r:-$_def}'"
|
|
}
|
|
|
|
prompt_yn() {
|
|
local _q="$1" _def="$2" _var="$3" _r
|
|
[[ "${UNATTENDED:-false}" == "true" ]] && { eval "$_var='$_def'"; return; }
|
|
read -r -p " $_q " _r
|
|
eval "$_var='${_r:-$_def}'"
|
|
}
|
|
|
|
configure_caddy_for_service() {
|
|
local _name="$1" _upstream="$2" _subdomain="$3" _extra="${4:-}"
|
|
local _caddy_dir="$DOCKER_DIR/caddy"
|
|
local _caddyfile="$_caddy_dir/Caddyfile"
|
|
|
|
# Support remote Caddy host via CADDY_REMOTE_HOST
|
|
if [[ -n "${CADDY_REMOTE_HOST:-}" ]]; then
|
|
log_info "Remote Caddy detected at $CADDY_REMOTE_HOST — printing block to add manually."
|
|
echo ""
|
|
echo " Add the following to your Caddyfile on $CADDY_REMOTE_HOST:"
|
|
echo " ──────────────────────────────────────────────────────────"
|
|
echo " # $_name"
|
|
echo " ${_subdomain}.${SITE_DOMAIN:-example.com} {"
|
|
echo " reverse_proxy $_upstream"
|
|
[[ -n "$_extra" ]] && echo "$_extra"
|
|
echo " }"
|
|
echo " ──────────────────────────────────────────────────────────"
|
|
return 0
|
|
fi
|
|
|
|
if [[ ! -d "$_caddy_dir" ]]; then
|
|
log_info "Access $_name directly on port ${_upstream##*:}."
|
|
return 0
|
|
fi
|
|
|
|
echo ""
|
|
local _do_caddy=""
|
|
read -r -p " Configure Caddy reverse proxy for $_name? [y/N]: " _do_caddy
|
|
[[ "${_do_caddy,,}" == "y" ]] || {
|
|
log_info "Skipping — access at: http://localhost:${_upstream##*:}"
|
|
return 0
|
|
}
|
|
|
|
local _domain=""
|
|
read -r -p " Domain (e.g. ${_subdomain}.${SITE_DOMAIN:-example.com}): " _domain
|
|
[[ -n "$_domain" ]] || { log_warning "No domain entered — skipping Caddy."; return 0; }
|
|
|
|
# Back up before touching
|
|
if [[ -f "$_caddyfile" ]]; then
|
|
local _bk="$_caddy_dir/Caddyfile.backup.$(date +%Y%m%d-%H%M%S)"
|
|
cp "$_caddyfile" "$_bk"
|
|
log_info "Backed up Caddyfile to $(basename "$_bk")"
|
|
else
|
|
touch "$_caddyfile"
|
|
fi
|
|
|
|
# Remove existing block for this domain if present
|
|
if grep -q "^${_domain}" "$_caddyfile" 2>/dev/null; then
|
|
log_warning "$_domain already in Caddyfile"
|
|
local _ow=""
|
|
read -r -p " Overwrite? [y/N]: " _ow
|
|
[[ "${_ow,,}" == "y" ]] || { log_info "Keeping existing entry."; return 0; }
|
|
sed -i "/^${_domain}/,/^}/d" "$_caddyfile"
|
|
fi
|
|
|
|
cat >> "$_caddyfile" << CBLOCK
|
|
|
|
# $_name
|
|
$_domain {
|
|
reverse_proxy $_upstream
|
|
|
|
header {
|
|
Strict-Transport-Security "max-age=31536000; includeSubDomains; preload"
|
|
X-Content-Type-Options "nosniff"
|
|
X-Frame-Options "SAMEORIGIN"
|
|
Referrer-Policy "strict-origin-when-cross-origin"
|
|
}
|
|
|
|
log {
|
|
output file /var/log/caddy/${_domain}.log
|
|
format json
|
|
}
|
|
${_extra}
|
|
}
|
|
CBLOCK
|
|
|
|
log_success "Added $_domain to Caddyfile"
|
|
docker exec caddy caddy fmt --overwrite /etc/caddy/Caddyfile 2>/dev/null || true
|
|
if docker exec caddy caddy reload --config /etc/caddy/Caddyfile 2>/dev/null; then
|
|
log_success "$_name accessible at: https://$_domain"
|
|
else
|
|
log_warning "Reload failed — check: docker logs caddy"
|
|
log_info "Manual reload: docker exec caddy caddy reload --config /etc/caddy/Caddyfile"
|
|
fi
|
|
}
|
|
fi
|
|
|
|
# Globals — ACTUAL_USER/ACTUAL_HOME must come before DOCKER_DIR
|
|
# ($HOME under sudo is /root, not the real user's home)
|
|
ACTUAL_USER="${ACTUAL_USER:-${SUDO_USER:-$USER}}"
|
|
ACTUAL_HOME="$(getent passwd "$ACTUAL_USER" 2>/dev/null | cut -d: -f6 || echo "${HOME:-/root}")"
|
|
DOCKER_DIR="${DOCKER_DIR:-$ACTUAL_HOME/docker}"
|
|
DRY_RUN="${DRY_RUN:-false}"
|
|
UNATTENDED="${UNATTENDED:-false}"
|
|
SITE_TZ="${SITE_TZ:-$(cat /etc/timezone 2>/dev/null || echo UTC)}"
|
|
SITE_DOMAIN="${SITE_DOMAIN:-example.com}"
|
|
SITE_CADDY_NET="${SITE_CADDY_NET:-caddy_net}"
|
|
|
|
register_service() { :; } # no-op — no wizard to register into
|
|
_RUN_STANDALONE=1
|
|
fi
|
|
# ─────────────────────────────────────────────────────────────────────────────
|
|
|
|
register_service nextcloud utilities "Self-hosted cloud storage with SMB/local file access (Nextcloud)" 8080
|
|
|
|
install_nextcloud() {
|
|
require_docker || return 1
|
|
log_info "Installing Nextcloud..."
|
|
local DIR="$DOCKER_DIR/nextcloud"
|
|
local WEB_PORT="8080"
|
|
|
|
if [ "$DRY_RUN" = true ]; then
|
|
echo "[DRY-RUN] Would create $DIR with Dockerfile, docker-compose.yml, .env"
|
|
echo "[DRY-RUN] Would auto-scan for a free host port (8080 default)"
|
|
return 0
|
|
fi
|
|
|
|
# Scan for a free host port — this default (8080) isn't unique to
|
|
# Nextcloud in this repo (arm also defaults to 8080), 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 "$DIR"
|
|
ensure_docker_dir_ownership "$DIR"
|
|
cd "$DIR" || return 1
|
|
|
|
# Reused across reruns if already set — the MariaDB volume keeps DB_PASS
|
|
# from its first init (regenerating it would lock Nextcloud out of its
|
|
# own database), and NEXTCLOUD_ADMIN_USER/PASSWORD are only consulted by
|
|
# the container on its very first boot to create the admin account —
|
|
# printing a fresh NC_ADMIN_PASS on every rerun would silently show a
|
|
# password that was never actually applied to the existing account.
|
|
local DB_PASS=""
|
|
[ -f ".env" ] && DB_PASS="$(grep '^MYSQL_PASSWORD=' .env | cut -d= -f2-)"
|
|
[ -n "$DB_PASS" ] || DB_PASS="$(generate_password 32)"
|
|
local NC_ADMIN_PASS=""
|
|
[ -f ".env" ] && NC_ADMIN_PASS="$(grep '^NEXTCLOUD_ADMIN_PASSWORD=' .env | cut -d= -f2-)"
|
|
[ -n "$NC_ADMIN_PASS" ] || NC_ADMIN_PASS="$(generate_password 16)"
|
|
local TZ_VAL="${SITE_TZ:-UTC}"
|
|
|
|
# ── Dockerfile ──────────────────────────────────────────────────────────
|
|
cat > Dockerfile << 'NCDF'
|
|
FROM nextcloud:apache
|
|
|
|
RUN apt-get update \
|
|
&& apt-get install -y --no-install-recommends procps smbclient \
|
|
&& rm -rf /var/lib/apt/lists/*
|
|
NCDF
|
|
|
|
# Mirrors configure_caddy_for_service's own mode resolution (lib/common.sh):
|
|
# explicit CADDY_MODE from the site config wins, then a local ~/docker/caddy,
|
|
# then the legacy CADDY_REMOTE_HOST var. Only "local" joins caddy_net — a
|
|
# remote Caddy box can't resolve container names on this host's bridge
|
|
# network anyway; it reaches this service via the host's published port.
|
|
local _CADDY_MODE="${CADDY_MODE:-none}"
|
|
[ "$_CADDY_MODE" = "none" ] && [ -d "$DOCKER_DIR/caddy" ] && _CADDY_MODE="local"
|
|
[ "$_CADDY_MODE" = "none" ] && [ -n "${CADDY_REMOTE_HOST:-}" ] && _CADDY_MODE="remote"
|
|
|
|
local _CADDY_NET_BLOCK=""
|
|
local _CADDY_NET_SECTION=""
|
|
if [ "$_CADDY_MODE" = "local" ]; then
|
|
_CADDY_NET_BLOCK=" networks:
|
|
- caddy_net
|
|
"
|
|
_CADDY_NET_SECTION="
|
|
networks:
|
|
caddy_net:
|
|
external: true
|
|
name: ${SITE_CADDY_NET:-caddy_net}
|
|
"
|
|
fi
|
|
|
|
# ── docker-compose.yml ──────────────────────────────────────────────────
|
|
cat > docker-compose.yml << NCCOMPOSE
|
|
name: nextcloud
|
|
services:
|
|
nextcloud:
|
|
build: .
|
|
container_name: nextcloud
|
|
hostname: nextcloud
|
|
restart: unless-stopped
|
|
env_file: .env
|
|
depends_on:
|
|
- db
|
|
volumes:
|
|
- ./html:/var/www/html
|
|
- ./config:/var/www/html/config
|
|
- ./custom_apps:/var/www/html/custom_apps
|
|
ports:
|
|
- "${WEB_PORT}:80"
|
|
${_CADDY_NET_BLOCK}
|
|
db:
|
|
image: mariadb:10.11
|
|
container_name: nextcloud-db
|
|
hostname: nextcloud-db
|
|
restart: unless-stopped
|
|
env_file: .env
|
|
volumes:
|
|
- ./db:/var/lib/mysql
|
|
${_CADDY_NET_BLOCK}${_CADDY_NET_SECTION}
|
|
NCCOMPOSE
|
|
|
|
# ── .env ────────────────────────────────────────────────────────────────
|
|
cat > .env << NCENV
|
|
TZ=$TZ_VAL
|
|
CADDY_NET=$SITE_CADDY_NET
|
|
|
|
# MariaDB
|
|
MYSQL_ROOT_PASSWORD=$DB_PASS
|
|
MYSQL_DATABASE=nextcloud
|
|
MYSQL_USER=nextcloud
|
|
MYSQL_PASSWORD=$DB_PASS
|
|
MARIADB_AUTO_UPGRADE=1
|
|
|
|
# Nextcloud bootstrap (first run only)
|
|
NEXTCLOUD_ADMIN_USER=admin
|
|
NEXTCLOUD_ADMIN_PASSWORD=$NC_ADMIN_PASS
|
|
NEXTCLOUD_DB_TYPE=mysql
|
|
MYSQL_HOST=db
|
|
|
|
# Reverse proxy (required for correct share links and redirects behind Caddy)
|
|
OVERWRITEPROTOCOL=https
|
|
OVERWRITECLIURL=https://cloud.${SITE_DOMAIN:-example.com}
|
|
TRUSTED_PROXIES=172.16.0.0/12
|
|
NCENV
|
|
chmod 600 .env
|
|
|
|
# ── Subdirectories ──────────────────────────────────────────────────────
|
|
mkdir -p html config custom_apps db
|
|
chown -R "$ACTUAL_USER:$ACTUAL_USER" "$DIR"
|
|
|
|
echo ""
|
|
log_success "Nextcloud configured at $DIR"
|
|
|
|
configure_caddy_for_service "Nextcloud" "nextcloud:80" "cloud"
|
|
|
|
# ── Prompt to start ─────────────────────────────────────────────────────
|
|
local START_NC=""
|
|
prompt_yn "Start Nextcloud now? (y/n):" "y" START_NC
|
|
if [ "$START_NC" = "y" ] || [ "$START_NC" = "Y" ]; then
|
|
docker compose up -d --build \
|
|
&& log_success "Nextcloud started" \
|
|
|| { log_warning "Start failed — check: docker compose logs"; return 1; }
|
|
|
|
# ── Wait for occ and enable files_external ──────────────────────────
|
|
log_info "Waiting for Nextcloud to initialize (up to 90s)..."
|
|
local _wait=0
|
|
until docker exec nextcloud php occ status 2>/dev/null | grep -q "installed: true"; do
|
|
sleep 5; _wait=$((_wait+5))
|
|
[ $_wait -ge 90 ] && { log_warning "Nextcloud not ready after 90s — enable files_external manually"; break; }
|
|
done
|
|
if docker exec nextcloud php occ app:enable files_external 2>/dev/null; then
|
|
log_success "files_external app enabled (SMB/local external storage)"
|
|
fi
|
|
fi
|
|
|
|
# ── README ───────────────────────────────────────────────────────────────
|
|
write_readme "$DIR" << NCREADME
|
|
# Nextcloud
|
|
|
|
Self-hosted cloud storage with SMB/local file access.
|
|
|
|
## Access
|
|
|
|
- URL: https://cloud.${SITE_DOMAIN:-example.com} (or http://localhost:${WEB_PORT})
|
|
- Admin: admin
|
|
- Password: see \`NEXTCLOUD_ADMIN_PASSWORD\` in \`$DIR/.env\`
|
|
|
|
## Manage
|
|
|
|
\`\`\`bash
|
|
docker compose up -d --build # start / rebuild
|
|
docker compose down # stop
|
|
docker compose logs -f # follow logs
|
|
docker compose pull && docker compose up -d --build # update
|
|
\`\`\`
|
|
|
|
## Run occ commands
|
|
|
|
\`\`\`bash
|
|
docker exec -u www-data nextcloud php occ <command>
|
|
\`\`\`
|
|
|
|
## Enable external storage (SMB / local)
|
|
|
|
\`\`\`bash
|
|
docker exec -u www-data nextcloud php occ app:enable files_external
|
|
\`\`\`
|
|
|
|
Then configure mounts in Nextcloud → Settings → External Storages.
|
|
|
|
## Backup
|
|
|
|
Back up these directories:
|
|
- \`$DIR/html\` — Nextcloud application files
|
|
- \`$DIR/config\` — configuration
|
|
- \`$DIR/custom_apps\` — third-party apps
|
|
- \`$DIR/db\` — MariaDB data
|
|
- \`$DIR/.env\` — credentials (permissions 600)
|
|
NCREADME
|
|
|
|
echo ""
|
|
echo " Access URL: http://localhost:${WEB_PORT}"
|
|
echo " Admin user: admin"
|
|
echo " Admin pass: $NC_ADMIN_PASS"
|
|
echo " Config dir: $DIR"
|
|
echo ""
|
|
echo " Note: First startup may take 1-2 minutes while Nextcloud initialises."
|
|
echo ""
|
|
}
|
|
|
|
# Run immediately when executed directly (deferred until after function definition)
|
|
[[ "${_RUN_STANDALONE:-0}" == 1 ]] && install_nextcloud
|