#!/bin/bash # services/fmd.sh — FindMyDevice server for Android device tracking (FMD). # Part of the modular post-install system (sourced by setup.sh). # # Can also be run standalone on any machine: # sudo bash fmd.sh # (Docker must already be installed when run standalone) # # Ported from ubuntu-post-install-24.04-crowdsec.sh (# ---- FINDMYDEVICE ----). # Own ~/docker/fmd/ with a standalone docker-compose.yml + .env. # Mobile app: "FMD" (by Nulide) on F-Droid — not the Google Find My Device app. # # Image: registry.gitlab.com/fmd-foss/fmd-server (GitLab's own registry, no # Docker Hub image exists). The project has moved twice — originally # nulide/findmydevice on Docker Hub, then gitlab.com/Nulide/findmydeviceserver, # now gitlab.com/fmd-foss/fmd-server — and was rewritten from Node.js to # Go+React along the way. Confirmed live: the old nulide/findmydevice image # no longer exists at all ("pull access denied"), so this service never # actually started on any box that installed it before this fix. The old # single shared FMD_ADMIN_PASSWORD model is gone too — the current server # uses per-user self-registration gated by an optional FMD_REGISTRATIONTOKEN, # and stores its database at /var/lib/fmd-server/db, not /fmd/data. # ── 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'" } # 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" local _display_port="${_upstream##*:}" # Determine mode: local Caddy, remote Caddy, or none local _mode="none" [[ -d "$_caddy_dir" ]] && _mode="local" [[ -n "${CADDY_REMOTE_HOST:-}" ]] && [[ "$_mode" != "local" ]] && _mode="remote" [[ "$_mode" == "none" ]] && { log_info "Access $_name directly on port $_display_port." return 0 } echo "" local _do_caddy="" if [[ "$_mode" == "remote" ]]; then log_info "Remote Caddy configured (${CADDY_REMOTE_HOST})." log_info "A snippet file will be saved to ~/docker/caddy-snippets/." fi read -r -p " Configure Caddy reverse proxy for $_name? [y/N]: " _do_caddy [[ "${_do_caddy,,}" == "y" ]] || { log_info "Skipping — access at: http://localhost:$_display_port" return 0 } # Domain prompt — pre-fill from SITE_DOMAIN when available local _default_domain="" if [[ -n "${SITE_DOMAIN:-}" ]] && [[ "$SITE_DOMAIN" != "example.com" ]]; then _default_domain="${_subdomain}.${SITE_DOMAIN}" log_info "Default: $_default_domain" fi local _domain="" read -r -p " Domain [${_default_domain:-required}]: " _domain _domain="${_domain:-$_default_domain}" [[ -n "$_domain" ]] || { log_warning "No domain entered — skipping Caddy."; return 0; } # Build upstream — remote Caddy uses host IP:port, not container name local _block_upstream="$_upstream" if [[ "$_mode" == "remote" ]]; then _block_upstream="${CADDY_REMOTE_HOST}:${_display_port}" fi local _site_block _site_block="$(cat << CBLOCK # $_name ${_domain} { reverse_proxy ${_block_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 )" if [[ "$_mode" == "local" ]]; then 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 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 printf '%s\n' "$_site_block" >> "$_caddyfile" 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 else local _snippet_dir="$DOCKER_DIR/caddy-snippets" local _snippet_file="$_snippet_dir/${_subdomain}.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/" log_info " rsync -av $_snippet_dir/ caddy-host:~/caddy-snippets/ (all at once)" fi } 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}" register_service() { :; } # no-op — no wizard to register into _RUN_STANDALONE=1 fi # ───────────────────────────────────────────────────────────────────────────── register_service fmd utilities "Android device tracking — alternative to Google Find My Device (FMD)" 8084 install_fmd() { require_docker || return 1 # ── Instance selection ─────────────────────────────────────────────────── # First instance keeps the plain "fmd" name/paths/port exactly as before # (zero behavior change for anyone with a single instance). Only asking to # add a second one introduces suffixed naming — same pattern as # services/mattermost.sh and services/wordpress.sh. local FMD_DIR="$DOCKER_DIR/fmd" local INSTANCE_SUFFIX="" CONTAINER="fmd" local WEB_PORT="8084" if [ "$DRY_RUN" = true ]; then echo "[DRY-RUN] FindMyDevice would:" echo " - Offer to add a new, separate instance if one already exists" echo " - Create \$DOCKER_DIR/fmd(-) with docker-compose.yml + .env (data/)" echo " - Generate a random registration token" echo " - Auto-scan for a free host port if this is an additional instance" echo " - Offer a Caddy reverse proxy and to start the container" return 0 fi if [ -d "$FMD_DIR" ]; then echo "" echo " FindMyDevice is already installed at $FMD_DIR." echo " 1) Manage that install (update / full reinstall / cancel)" echo " 2) Add a NEW, separate FindMyDevice instance alongside it (its own" echo " server, password, and port — full isolation)" echo "" local _TOP_CHOICE="" prompt_text " Choice [1/2]:" "1" _TOP_CHOICE if [ "$_TOP_CHOICE" = "2" ]; then local _suffix="" while true; do prompt_text " Short name for the new instance (letters/numbers/hyphens, e.g. 'kids'):" "" _suffix _suffix="$(echo "$_suffix" | tr -cs 'a-zA-Z0-9-' '-' | sed 's/^-*//;s/-*$//')" if [ -z "$_suffix" ]; then log_warning "Name can't be empty."; continue fi if [ -d "$DOCKER_DIR/fmd-$_suffix" ]; then log_warning "fmd-$_suffix already exists — pick another name."; continue fi break done INSTANCE_SUFFIX="$_suffix" FMD_DIR="$DOCKER_DIR/fmd-$_suffix" CONTAINER="fmd-$_suffix" log_info "New instance: $FMD_DIR" else # "Manage that install" on THIS instance — the banner above promises # update/fresh/cancel, so actually offer it instead of falling straight # through into the same unconditional-overwrite flow as a new install. if [[ -f "$FMD_DIR/docker-compose.yml" ]]; then local MODE="" prompt_reinstall_mode MODE case "$MODE" in update) log_info "Refreshing the FindMyDevice image only — token, port, and Caddy config are left as-is." # fmd-server's image runs as a fixed, non-configurable # UID:GID 1000:1000 (confirmed against its own # Dockerfile — not something PUID/PGID or similar can # override). The bind-mounted ./data dir needs that # exact numeric ownership regardless of what host user # actually owns it; re-assert it on every update too, # not just at install time, so a box whose data/ was # ever chowned to something else (e.g. $ACTUAL_USER # not being UID 1000) self-heals instead of staying # stuck crash-looping on "permission denied" forever. [ -d "$FMD_DIR/data" ] && chown -R 1000:1000 "$FMD_DIR/data" ( cd "$FMD_DIR" && docker compose pull && docker compose up -d ) \ && log_success "FindMyDevice image refreshed" \ || log_warning "Refresh failed — check: docker compose -f $FMD_DIR/docker-compose.yml logs" return 0 ;; cancel) log_info "Leaving the existing install as-is." return 0 ;; fresh) ;; # fall through to the full install flow below esac fi fi fi # Scan for a free port unconditionally — not just when adding an explicit # additional instance. A plain first install can just as easily collide # with an unrelated service that already claimed this default port — see # CLAUDE.md's "Port collision avoidance" section. find_free_port WEB_PORT "$WEB_PORT" mkdir -p "$FMD_DIR" ensure_docker_dir_ownership "$FMD_DIR" cd "$FMD_DIR" || return 1 local FMD_TOKEN FMD_TOKEN=$(openssl rand -base64 16 | tr -dc 'a-zA-Z0-9' | head -c 16) # 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 cat > docker-compose.yml << FMD_COMPOSE name: $CONTAINER services: fmd: image: registry.gitlab.com/fmd-foss/fmd-server:0 container_name: $CONTAINER hostname: $CONTAINER restart: unless-stopped environment: - FMD_REGISTRATIONTOKEN=\${FMD_REGISTRATIONTOKEN} volumes: - ./data:/var/lib/fmd-server/db ports: - "${WEB_PORT}:8080" ${_CADDY_NET_BLOCK}${_CADDY_NET_SECTION} FMD_COMPOSE cat > .env << FMD_ENV FMD_REGISTRATIONTOKEN=$FMD_TOKEN CADDY_NET=$SITE_CADDY_NET FMD_ENV mkdir -p data chown -R "$ACTUAL_USER:$ACTUAL_USER" "$FMD_DIR" # fmd-server's image runs as a fixed, non-configurable UID:GID 1000:1000 # (confirmed against its own Dockerfile: `useradd --uid 1000 fmd-server`, # baked in, not something an env var can override) — the bind mount at # ./data:/var/lib/fmd-server/db needs that exact numeric ownership on the # host side regardless of $ACTUAL_USER's actual UID, or the container # crash-loops on "permission denied" trying to create its sqlite db. # Confirmed live. Must run AFTER the chown above, not before, since that # one is recursive over the whole directory and would otherwise # overwrite this. chown -R 1000:1000 "$FMD_DIR/data" log_success "FindMyDevice${INSTANCE_SUFFIX:+ ($INSTANCE_SUFFIX)} configured at $FMD_DIR (port $WEB_PORT)" configure_caddy_for_service "FindMyDevice${INSTANCE_SUFFIX:+ ($INSTANCE_SUFFIX)}" "${CONTAINER}:8080" "fmd${INSTANCE_SUFFIX:+-$INSTANCE_SUFFIX}" write_readme "$FMD_DIR" << MD # FindMyDevice (FMD)${INSTANCE_SUFFIX:+ — $INSTANCE_SUFFIX} Self-hosted Android device tracking — locate, lock, or wipe your device from the web UI. Alternative to Google's Find My Device. $( [ -n "$INSTANCE_SUFFIX" ] && echo " This is a separate, fully isolated instance (own server, own password, own port) — not shared devices with another FindMyDevice instance.") - Web UI: http://localhost:${WEB_PORT} - Registration token: stored in \`.env\` (\`FMD_REGISTRATIONTOKEN\`) — the FMD app must supply this when creating an account on this server, so a stranger who finds the URL can't just self-register. Leave the \`.env\` value blank and restart if you'd rather allow open registration. - App data: \`data/\` (mounted at the container's own db path) ## Manage \`\`\`bash cd $FMD_DIR docker compose up -d # start docker compose down # stop docker compose logs -f # logs docker compose pull && docker compose up -d # update \`\`\` ## Mobile app Install **FMD** from **F-Droid** (search "Find My Device", by Nulide — not the Google "Find My Device" app): 1. Open the app → create/register an account → Server URL → \`http://YOUR-SERVER-IP:${WEB_PORT}\` 2. Enter the registration token from \`.env\` when prompted 3. Grant location and accessibility permissions MD local START_FMD="" prompt_yn "Start FindMyDevice${INSTANCE_SUFFIX:+ ($INSTANCE_SUFFIX)} now? (y/n):" "y" START_FMD if [ "$START_FMD" = "y" ] || [ "$START_FMD" = "Y" ]; then docker compose up -d && log_success "FindMyDevice${INSTANCE_SUFFIX:+ ($INSTANCE_SUFFIX)} started" || log_warning "Failed to start — check: docker compose logs" fi echo "" echo " Access at: http://localhost:${WEB_PORT}" echo " Registration token: $FMD_TOKEN (saved in .env)" echo " Mobile app: FMD (by Nulide) on F-Droid" echo "" } # Run immediately when executed directly (deferred until after function definition) [[ "${_RUN_STANDALONE:-0}" == 1 ]] && install_fmd