ProxmoxVE/tools/addon/adguardhome-sync.sh

#!/usr/bin/env bash

# Copyright (c) 2021-2026 community-scripts ORG
# Author: MickLesk (CanbiZ)
# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
# Source: https://github.com/bakito/adguardhome-sync

if ! command -v curl &>/dev/null; then
  printf "\r\e[2K%b" '\033[93m Setup Source \033[m' >&2
  if [[ -f "/etc/alpine-release" ]]; then
    apk -U add curl >/dev/null 2>&1
  else
    apt-get update >/dev/null 2>&1
    apt-get install -y curl >/dev/null 2>&1
  fi
fi
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/core.func)
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/tools.func)
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/error_handler.func)
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/api.func) 2>/dev/null || true

# Enable error handling
set -Eeuo pipefail
trap 'error_handler' ERR

# ==============================================================================
# CONFIGURATION
# ==============================================================================
APP="AdGuardHome-Sync"
APP_TYPE="addon"
INSTALL_PATH="/opt/adguardhome-sync"
CONFIG_PATH="/opt/adguardhome-sync/adguardhome-sync.yaml"
DEFAULT_PORT=8080

# Initialize all core functions (colors, formatting, icons, STD mode)
load_functions
init_tool_telemetry "" "addon"

# ==============================================================================
# HEADER
# ==============================================================================
function header_info {
  clear
  cat <<"EOF"
    ___       __                          ____  __                        _____
   /   | ____/ /___ ___  ______ __________/ / / / /___  ____ ___  ___     / ___/__  ______  _____
  / /| |/ __  / __ `/ / / / __ `/ ___/ __  / /_/ / __ \/ __ `__ \/ _ \    \__ \/ / / / __ \/ ___/
 / ___ / /_/ / /_/ / /_/ / /_/ / /  / /_/ / __  / /_/ / / / / / /  __/   ___/ / /_/ / / / / /__
/_/  |_\__,_/\__, /\__,_/\__,_/_/   \__,_/_/ /_/\____/_/ /_/ /_/\___/   /____/\__, /_/ /_/\___/
            /____/                                                           /____/
EOF
}

# ==============================================================================
# HELPER FUNCTIONS
# ==============================================================================
get_ip() {
 ifconfig | grep -v '127.0.0.1' | grep -Eo 'inet (addr:)?([0-9]*\.){3}[0-9]*' | grep -m1 -Eo '([0-9]*\.){3}[0-9]*' || echo "127.0.0.1"
}

# ==============================================================================
# OS DETECTION
# ==============================================================================
if [[ -f "/etc/alpine-release" ]]; then
  OS="Alpine"
  SERVICE_PATH="/etc/init.d/adguardhome-sync"
elif [[ -f "/etc/debian_version" ]]; then
  OS="Debian"
  SERVICE_PATH="/etc/systemd/system/adguardhome-sync.service"
else
  msg_error "Unsupported OS detected. Exiting."
  exit 238
fi

# ==============================================================================
# DEPENDENCY CHECK
# ==============================================================================
if ! command -v jq &>/dev/null; then
  printf "\r\e[2K%b" '\033[93m Installing jq \033[m' >&2
  if [[ "$OS" == "Alpine" ]]; then
    apk -U add jq >/dev/null 2>&1
  fi
fi

# ==============================================================================
# UNINSTALL
# ==============================================================================
function uninstall() {
  msg_info "Uninstalling ${APP}"
  if [[ "$OS" == "Alpine" ]]; then
    rc-service adguardhome-sync stop &>/dev/null || true
    rc-update del adguardhome-sync &>/dev/null || true
    rm -f "$SERVICE_PATH"
  else
    systemctl disable --now adguardhome-sync.service &>/dev/null || true
    rm -f "$SERVICE_PATH"
  fi
  rm -rf "$INSTALL_PATH"
  rm -f "/usr/local/bin/update_adguardhome-sync"
  rm -f "$HOME/.adguardhome-sync"
  msg_ok "${APP} has been uninstalled"
}

# ==============================================================================
# UPDATE
# ==============================================================================
function update() {
  if check_for_gh_release "adguardhome-sync" "bakito/adguardhome-sync"; then
    msg_info "Stopping service"
    if [[ "$OS" == "Alpine" ]]; then
      rc-service adguardhome-sync stop &>/dev/null || true
    else
      systemctl stop adguardhome-sync.service &>/dev/null || true
    fi
    msg_ok "Stopped service"

    msg_info "Backing up configuration"
    cp "$CONFIG_PATH" /tmp/adguardhome-sync.yaml.bak 2>/dev/null || true
    msg_ok "Backed up configuration"

    CLEAN_INSTALL=1 fetch_and_deploy_gh_release "adguardhome-sync" "bakito/adguardhome-sync" "prebuild" "latest" "$INSTALL_PATH" "adguardhome-sync_*_linux_amd64.tar.gz"

    msg_info "Restoring configuration"
    cp /tmp/adguardhome-sync.yaml.bak "$CONFIG_PATH" 2>/dev/null || true
    rm -f /tmp/adguardhome-sync.yaml.bak
    msg_ok "Restored configuration"

    msg_info "Starting service"
    if [[ "$OS" == "Alpine" ]]; then
      rc-service adguardhome-sync start
    else
      systemctl start adguardhome-sync.service
    fi
    msg_ok "Started service"
    msg_ok "Updated successfully!"
    exit
  fi
}

# ==============================================================================
# INSTALL
# ==============================================================================
function install() {
  local ip
  ip=$(get_ip)

  fetch_and_deploy_gh_release "adguardhome-sync" "bakito/adguardhome-sync" "prebuild" "latest" "$INSTALL_PATH" "adguardhome-sync_*_linux_amd64.tar.gz"

  # Gather configuration from user
  echo ""
  echo -e "${TAB}Enter details for your AdGuard Home instances."
  echo -e "${TAB}The Origin is your primary instance, Replica will sync from it."
  echo ""

  # Origin instance
  echo -e "${YW}── Origin (Primary) Instance ──${CL}"
  local origin_url origin_user origin_pass
  read -rp "  Origin URL (e.g., http://192.168.1.1): " origin_url
  origin_url="${origin_url:-http://192.168.1.1}"
  # Add http:// if no protocol specified
  [[ ! "$origin_url" =~ ^https?:// ]] && origin_url="http://${origin_url}"
  read -rp "  Origin Username [admin]: " origin_user
  origin_user="${origin_user:-admin}"
  read -rsp "  Origin Password: " origin_pass
  echo ""
  origin_pass="${origin_pass:-changeme}"

  # Replica instance
  echo ""
  echo -e "${YW}── Replica Instance ──${CL}"
  local replica_url replica_user replica_pass
  read -rp "  Replica URL (e.g., http://192.168.1.2): " replica_url
  replica_url="${replica_url:-http://192.168.1.2}"
  # Add http:// if no protocol specified
  [[ ! "$replica_url" =~ ^https?:// ]] && replica_url="http://${replica_url}"
  read -rp "  Replica Username [admin]: " replica_user
  replica_user="${replica_user:-admin}"
  read -rsp "  Replica Password: " replica_pass
  echo ""
  replica_pass="${replica_pass:-changeme}"
  echo ""

  msg_info "Creating configuration"
  cat <<EOF >"$CONFIG_PATH"
# AdGuardHome-Sync Configuration
# Documentation: https://github.com/bakito/adguardhome-sync

# Cron expression for sync interval (e.g., every 2 hours: "0 */2 * * *")
cron: "0 */2 * * *"

# Run sync on startup
runOnStart: true

# Continue sync on errors
continueOnError: false

# Origin AdGuardHome instance (primary)
origin:
  url: "${origin_url}"
  username: "${origin_user}"
  password: "${origin_pass}"
  insecureSkipVerify: false

# Replica instances (one or more)
replicas:
  - url: "${replica_url}"
    username: "${replica_user}"
    password: "${replica_pass}"
    insecureSkipVerify: false
  # Add more replicas as needed:
  # - url: "http://192.168.1.3"
  #   username: "admin"
  #   password: "changeme"

# API settings (web UI)
api:
  port: ${DEFAULT_PORT}
  darkMode: true
  metrics:
    enabled: false

# Sync features (all enabled by default)
features:
  dns:
    accessLists: true
    serverConfig: true
    rewrites: true
  dhcp:
    serverConfig: true
    staticLeases: true
  generalSettings: true
  queryLogConfig: true
  statsConfig: true
  clientSettings: true
  services: true
  filters: true
  theme: true
EOF
  chmod 600 "$CONFIG_PATH"
  msg_ok "Created configuration"

  msg_info "Creating service"
  if [[ "$OS" == "Alpine" ]]; then
    cat <<EOF >"$SERVICE_PATH"
#!/sbin/openrc-run

name="adguardhome-sync"
description="AdGuardHome Sync"
command="${INSTALL_PATH}/adguardhome-sync"
command_args="run --config ${CONFIG_PATH}"
command_background=true
pidfile="/run/\${RC_SVCNAME}.pid"
output_log="/var/log/adguardhome-sync.log"
error_log="/var/log/adguardhome-sync.log"

depend() {
    need net
    after firewall
}
EOF
    chmod +x "$SERVICE_PATH"
    rc-update add adguardhome-sync default
    rc-service adguardhome-sync start
  else
    cat <<EOF >"$SERVICE_PATH"
[Unit]
Description=AdGuardHome Sync
After=network.target

[Service]
Type=simple
ExecStart=${INSTALL_PATH}/adguardhome-sync run --config ${CONFIG_PATH}
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target
EOF
    systemctl daemon-reload
    systemctl enable --now adguardhome-sync &>/dev/null
  fi
  msg_ok "Created and started service"

  # Create update script
  msg_info "Creating update script"
  cat <<'UPDATEEOF' >/usr/local/bin/update_adguardhome-sync
#!/usr/bin/env bash
# AdGuardHome-Sync Update Script
type=update bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/tools/addon/adguardhome-sync.sh)"
UPDATEEOF
  chmod +x /usr/local/bin/update_adguardhome-sync
  msg_ok "Created update script (/usr/local/bin/update_adguardhome-sync)"

  echo ""
  msg_ok "${APP} installed successfully"
  msg_ok "Web UI: ${BL}http://${ip}:${DEFAULT_PORT}${CL}"
  msg_ok "Config: ${BL}${CONFIG_PATH}${CL}"
  echo ""
  msg_warn "Edit the config file to add your AdGuardHome instances!"
  msg_warn "  Origin: Your primary AdGuardHome instance"
  msg_warn "  Replicas: One or more replica instances to sync to"
}

# ==============================================================================
# MAIN
# ==============================================================================

# Handle type=update (called from update script)
if [[ "${type:-}" == "update" ]]; then
  header_info
  if [[ -d "$INSTALL_PATH" && -f "$INSTALL_PATH/adguardhome-sync" ]]; then
    update
  else
    msg_error "${APP} is not installed. Nothing to update."
    exit 233
  fi
  exit 0
fi

header_info

IP=$(get_ip)

# Check if already installed
if [[ -d "$INSTALL_PATH" && -f "$INSTALL_PATH/adguardhome-sync" ]]; then
  msg_warn "${APP} is already installed."
  echo ""

  echo -n "${TAB}Uninstall ${APP}? (y/N): "
  read -r uninstall_prompt
  if [[ "${uninstall_prompt,,}" =~ ^(y|yes)$ ]]; then
    uninstall
    exit 0
  fi

  echo -n "${TAB}Update ${APP}? (y/N): "
  read -r update_prompt
  if [[ "${update_prompt,,}" =~ ^(y|yes)$ ]]; then
    update
    exit 0
  fi

  msg_warn "No action selected. Exiting."
  exit 0
fi

# Fresh installation
msg_warn "${APP} is not installed."
echo ""
echo -e "${TAB}${INFO} This will install:"
echo -e "${TAB}  - AdGuardHome-Sync (Go binary)"
echo -e "${TAB}  - Systemd/OpenRC service"
echo -e "${TAB}  - Web UI on port ${DEFAULT_PORT}"
echo ""

echo -n "${TAB}Install ${APP}? (y/N): "
read -r install_prompt
if [[ "${install_prompt,,}" =~ ^(y|yes)$ ]]; then
  install
else
  msg_warn "Installation cancelled. Exiting."
  exit 0
fi