Claude
fa906186c3
Only include the caddy_net network block in generated docker-compose.yml files when ~/docker/caddy exists. Prevents "network caddy_net declared as external, but could not be found" on standalone installs without Caddy. Affected: actualbudget, archivebox, arm, audiobookshelf, calibre-web, changedetection, drum-rhythm-game, emby, fmd, frigate, frigate-audio, frigate-notify, gatus, homeassistant, immich, iopaint, jellyfin, joplin, koha, lyrion, magicmirror, mail-archiver, mattermost, mealie, meshcentral, n8n, nextcloud, ntfy, onlyoffice, portainer, stirling-pdf, syncthing, traccar, unifi, uptimekuma, vaultwarden, wg-easy Skipped: authelia (creates caddy_net itself), caddy, crowdsec, wolf, wolf-pair, and services using network_mode: host with no caddy_net. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01D8ckUJQtj1pH8jtAddBDZs
339 lines
13 KiB
Bash
339 lines
13 KiB
Bash
#!/bin/bash
|
|
# services/unifi.sh — UniFi Network Application (Ubiquiti controller).
|
|
# Part of the modular post-install system (sourced by setup.sh).
|
|
#
|
|
# Can also be run standalone on any machine:
|
|
# sudo bash unifi.sh
|
|
# (Docker must already be installed when run standalone)
|
|
#
|
|
# Two containers: mongo:4 (DB) + linuxserver unifi-network-application (app).
|
|
# Web UI runs on HTTPS port 8443 — no plain HTTP web interface.
|
|
# Caddy reverse-proxy wiring uses TLS passthrough or tls_insecure_skip_verify.
|
|
|
|
# ── 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
|
|
}
|
|
|
|
generate_password() {
|
|
local _len="${1:-32}"
|
|
tr -dc 'A-Za-z0-9' < /dev/urandom | head -c "$_len"
|
|
echo
|
|
}
|
|
|
|
# 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}'"
|
|
}
|
|
|
|
write_readme() {
|
|
local _dir="$1"; shift
|
|
mkdir -p "$_dir"
|
|
cat > "$_dir/README.md"
|
|
}
|
|
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}"
|
|
CADDY_REMOTE_HOST="${CADDY_REMOTE_HOST:-}"
|
|
|
|
register_service() { :; } # no-op — no wizard to register into
|
|
_RUN_STANDALONE=1
|
|
fi
|
|
# ─────────────────────────────────────────────────────────────────────────────
|
|
|
|
register_service unifi utilities "Ubiquiti network controller (UniFi)" 8443
|
|
|
|
install_unifi() {
|
|
require_docker || return 1
|
|
log_info "Installing UniFi Network Application..."
|
|
local UNIFI_DIR="$DOCKER_DIR/unifi"
|
|
|
|
if [ "$DRY_RUN" = true ]; then
|
|
echo "[DRY-RUN] Would create $UNIFI_DIR (mongo_db_data/, unifi_data/)"
|
|
echo "[DRY-RUN] Would deploy mongo:4 + linuxserver/unifi-network-application:latest"
|
|
echo "[DRY-RUN] Ports: 8443 (HTTPS web UI), 8080 (device inform), 3478/udp (STUN), 10001/udp (discovery)"
|
|
echo "[DRY-RUN] Would generate MongoDB credentials"
|
|
return 0
|
|
fi
|
|
|
|
mkdir -p "$UNIFI_DIR"
|
|
ensure_docker_dir_ownership "$UNIFI_DIR"
|
|
cd "$UNIFI_DIR" || return 1
|
|
|
|
local MONGO_PASS TZ_VAL UID_VAL GID_VAL
|
|
MONGO_PASS=$(generate_password 24)
|
|
TZ_VAL="${SITE_TZ:-$(cat /etc/timezone 2>/dev/null || echo UTC)}"
|
|
UID_VAL=$(id -u "$ACTUAL_USER")
|
|
GID_VAL=$(id -g "$ACTUAL_USER")
|
|
|
|
local _CADDY_NET_BLOCK=""
|
|
if [ -d "$DOCKER_DIR/caddy" ]; then
|
|
_CADDY_NET_BLOCK=" networks:
|
|
- caddy_net
|
|
"
|
|
fi
|
|
|
|
local _CADDY_NET_SECTION=""
|
|
if [ -d "$DOCKER_DIR/caddy" ]; then
|
|
_CADDY_NET_SECTION="
|
|
networks:
|
|
caddy_net:
|
|
external: true
|
|
name: ${SITE_CADDY_NET:-caddy_net}
|
|
"
|
|
fi
|
|
|
|
# Unquoted heredoc; ${...} used for caddy_net vars; all Docker Compose vars escaped with \$
|
|
cat > docker-compose.yml << UNIFI_COMPOSE
|
|
name: unifi
|
|
|
|
services:
|
|
unifi-db:
|
|
image: mongo:4
|
|
container_name: unifi-db
|
|
hostname: unifi-db
|
|
restart: unless-stopped
|
|
env_file: .env
|
|
volumes:
|
|
- ./mongo_db_data:/data/db
|
|
expose:
|
|
- "27017"
|
|
configs:
|
|
- source: init-mongo.js
|
|
target: /docker-entrypoint-initdb.d/init-mongo.js
|
|
|
|
unifi-app:
|
|
image: lscr.io/linuxserver/unifi-network-application:latest
|
|
container_name: unifi-app
|
|
hostname: unifi-app
|
|
restart: unless-stopped
|
|
env_file: .env
|
|
depends_on:
|
|
- unifi-db
|
|
volumes:
|
|
- ./unifi_data:/config
|
|
ports:
|
|
- "8443:8443"
|
|
- "8080:8080"
|
|
- "3478:3478/udp"
|
|
- "10001:10001/udp"
|
|
# Optional — uncomment as needed:
|
|
# - "1900:1900/udp" # L2 discovery (may conflict with UPnP)
|
|
# - "8843:8843" # guest portal HTTPS
|
|
# - "8880:8880" # guest portal HTTP
|
|
# - "6789:6789" # mobile speed test
|
|
# - "5514:5514/udp" # remote syslog
|
|
${_CADDY_NET_BLOCK}${_CADDY_NET_SECTION}
|
|
# Inline MongoDB init — Docker Compose interpolates vars from .env at startup.
|
|
configs:
|
|
init-mongo.js:
|
|
content: |
|
|
db.getSiblingDB("\${MONGO_DBNAME}").createUser({user: "\${MONGO_USER}", pwd: "\${MONGO_PASS}", roles: [{role: "\${MONGO_ROLE}", db: "\${MONGO_DBNAME}"}]});
|
|
db.getSiblingDB("\${MONGO_DBNAME}_stat").createUser({user: "\${MONGO_USER}", pwd: "\${MONGO_PASS}", roles: [{role: "\${MONGO_ROLE}", db: "\${MONGO_DBNAME}_stat"}]});
|
|
UNIFI_COMPOSE
|
|
|
|
cat > .env << UNIFI_ENV
|
|
# ── General ───────────────────────────────────────────────────────────────────
|
|
TZ=$TZ_VAL
|
|
CADDY_NET=$SITE_CADDY_NET
|
|
|
|
# ── LinuxServer — UniFi app ───────────────────────────────────────────────────
|
|
PUID=$UID_VAL
|
|
PGID=$GID_VAL
|
|
MEM_LIMIT=1024
|
|
MEM_STARTUP=512
|
|
|
|
# ── MongoDB connection ────────────────────────────────────────────────────────
|
|
MONGO_USER=unifi
|
|
MONGO_PASS=$MONGO_PASS
|
|
MONGO_HOST=unifi-db
|
|
MONGO_PORT=27017
|
|
MONGO_DBNAME=unifi_db
|
|
MONGO_ROLE=dbOwner
|
|
# MONGO_TLS= # optional
|
|
# MONGO_AUTHSOURCE= # optional
|
|
UNIFI_ENV
|
|
|
|
chmod 600 .env
|
|
mkdir -p mongo_db_data unifi_data
|
|
ensure_docker_dir_ownership "$UNIFI_DIR"
|
|
|
|
log_success "UniFi configured at $UNIFI_DIR"
|
|
|
|
# ── Optional Caddy reverse proxy (HTTPS backend requires tls_insecure_skip_verify) ──
|
|
local _caddy_mode="none"
|
|
[ -d "$DOCKER_DIR/caddy" ] && _caddy_mode="local"
|
|
[ -n "${CADDY_REMOTE_HOST:-}" ] && [ "$_caddy_mode" != "local" ] && _caddy_mode="remote"
|
|
|
|
if [ "$_caddy_mode" != "none" ]; then
|
|
echo ""
|
|
echo " UniFi web UI is HTTPS-only (self-signed cert internally)."
|
|
echo " Caddy proxies it using tls_insecure_skip_verify."
|
|
if [ "$_caddy_mode" = "remote" ]; then
|
|
echo " Remote Caddy (${CADDY_REMOTE_HOST}) — a snippet file will be saved."
|
|
fi
|
|
echo ""
|
|
local CADDY_UNIFI=""
|
|
prompt_yn "Configure Caddy reverse proxy for UniFi? (y/n):" "n" CADDY_UNIFI
|
|
if [ "$CADDY_UNIFI" = "y" ] || [ "$CADDY_UNIFI" = "Y" ]; then
|
|
local UNIFI_DOMAIN=""
|
|
local _def_domain="unifi.${SITE_DOMAIN:-example.com}"
|
|
prompt_text "UniFi domain [${_def_domain}]:" "$_def_domain" UNIFI_DOMAIN
|
|
if [ -n "$UNIFI_DOMAIN" ]; then
|
|
# UniFi uses HTTPS internally — upstream must use https:// + skip verify
|
|
local _upstream="https://unifi-app:8443"
|
|
[ "$_caddy_mode" = "remote" ] && _upstream="https://${CADDY_REMOTE_HOST}:8443"
|
|
|
|
local _site_block
|
|
_site_block="$(cat << CBLOCK
|
|
|
|
# UniFi Network Application
|
|
${UNIFI_DOMAIN} {
|
|
reverse_proxy ${_upstream} {
|
|
transport http {
|
|
tls_insecure_skip_verify
|
|
}
|
|
}
|
|
|
|
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/${UNIFI_DOMAIN}.log
|
|
format json
|
|
}
|
|
}
|
|
CBLOCK
|
|
)"
|
|
if [ "$_caddy_mode" = "local" ]; then
|
|
local CADDYFILE="$DOCKER_DIR/caddy/Caddyfile"
|
|
cp "$CADDYFILE" "$CADDYFILE.backup.$(date +%Y%m%d-%H%M%S)" 2>/dev/null || true
|
|
printf '%s\n' "$_site_block" >> "$CADDYFILE"
|
|
docker exec caddy caddy fmt --overwrite /etc/caddy/Caddyfile 2>/dev/null || true
|
|
docker exec caddy caddy reload --config /etc/caddy/Caddyfile 2>/dev/null \
|
|
&& log_success "Caddy configured for $UNIFI_DOMAIN" \
|
|
|| log_warning "Caddy reload failed — check: docker logs caddy"
|
|
else
|
|
local _snippet_dir="$DOCKER_DIR/caddy-snippets"
|
|
local _snippet_file="$_snippet_dir/unifi.caddy"
|
|
mkdir -p "$_snippet_dir"
|
|
printf '%s\n' "$_site_block" > "$_snippet_file"
|
|
chown "$ACTUAL_USER:$ACTUAL_USER" "$_snippet_file" 2>/dev/null || true
|
|
log_success "Snippet saved: $_snippet_file"
|
|
log_info "Copy to Caddy machine:"
|
|
log_info " scp $_snippet_file caddy-host:~/caddy-snippets/"
|
|
fi
|
|
fi
|
|
fi
|
|
fi
|
|
|
|
write_readme "$UNIFI_DIR" << MD
|
|
# UniFi Network Application
|
|
|
|
Ubiquiti network controller. Manages UniFi APs, switches, and gateways.
|
|
|
|
## Access
|
|
- Web UI: **https://localhost:8443** (HTTPS, self-signed cert — accept the warning)
|
|
- First run: complete the setup wizard and adopt your devices.
|
|
|
|
## Device adoption
|
|
Make sure devices can reach **http://<server-ip>:8080/inform** as the inform URL.
|
|
In the controller: Settings → System → Application Configuration → Override inform host.
|
|
|
|
## Ports
|
|
| Port | Protocol | Purpose |
|
|
|------|----------|---------|
|
|
| 8443 | TCP | HTTPS web UI |
|
|
| 8080 | TCP | Device inform / HTTP redirect |
|
|
| 3478 | UDP | STUN |
|
|
| 10001 | UDP | AP discovery |
|
|
|
|
## Manage
|
|
\`\`\`bash
|
|
cd $UNIFI_DIR
|
|
docker compose up -d # start
|
|
docker compose down # stop
|
|
docker compose logs -f # logs
|
|
docker compose pull && docker compose up -d # update (wait for DB first)
|
|
\`\`\`
|
|
|
|
## Migration from old UniFi Controller
|
|
1. Backup: Settings → System → Backup → Create Backup
|
|
2. Down the old container
|
|
3. Spin up this stack
|
|
4. Restore: Settings → System → Backup → Restore
|
|
MD
|
|
|
|
local START_UNIFI=""
|
|
prompt_yn "Start UniFi now? (y/n):" "y" START_UNIFI
|
|
if [ "$START_UNIFI" = "y" ] || [ "$START_UNIFI" = "Y" ]; then
|
|
docker compose up -d \
|
|
&& log_success "UniFi started (first startup takes ~60 s while DB initializes)" \
|
|
|| log_warning "Failed to start — check: docker compose logs"
|
|
fi
|
|
|
|
echo ""
|
|
echo " Web UI: https://localhost:8443 (accept the self-signed cert warning)"
|
|
echo " MongoDB credentials saved to: $UNIFI_DIR/.env"
|
|
echo ""
|
|
}
|
|
|
|
# Run immediately when executed directly (deferred until after function definition)
|
|
[[ "${_RUN_STANDALONE:-0}" == 1 ]] && install_unifi
|