Skip to content

Lightweight server monitoring with historical data, docker stats, and alerts.

13.0 KB
Raw Blame
#!/bin/sh

is_freebsd() {
  [ "$(uname -s)" = "FreeBSD" ]
}

# If SELinux is enabled, reset the binary to the label its path should have.
# The binary is extracted in a temp dir and moved, so it keeps the temp label
# (user_tmp_t) that systemd is not allowed to execute.
restore_selinux_context() {
  if command -v getenforce >/dev/null 2>&1 && command -v restorecon >/dev/null 2>&1; then
    SELINUX_MODE=$(getenforce) || return 0
    if [ "$SELINUX_MODE" != "Disabled" ]; then
      echo "SELinux is enabled (${SELINUX_MODE} mode). Restoring context of $1..."
      restorecon -v "$1" >/dev/null 2>&1 || echo "Warning: Failed to restore SELinux context for $1."
    fi
  fi
}

# Function to ensure the proxy URL ends with a /
ensure_trailing_slash() {
  if [ -n "$1" ]; then
    case "$1" in
    */) echo "$1" ;;
    *) echo "$1/" ;;
    esac
  else
    echo "$1"
  fi
}

# Generate FreeBSD rc service content
generate_freebsd_rc_service() {
  cat <<'EOF'
#!/bin/sh

# PROVIDE: beszel_hub
# REQUIRE: DAEMON NETWORKING
# BEFORE: LOGIN
# KEYWORD: shutdown

# Add the following lines to /etc/rc.conf to configure Beszel Hub:
#
# beszel_hub_enable (bool):   Set to YES to enable Beszel Hub
#                             Default: YES
# beszel_hub_port (str):      Port to listen on
#                             Default: 8090
# beszel_hub_user (str):      Beszel Hub daemon user
#                             Default: beszel
# beszel_hub_bin (str):       Path to the beszel binary
#                             Default: /usr/local/sbin/beszel
# beszel_hub_data (str):      Path to the beszel data directory
#                             Default: /usr/local/etc/beszel/beszel_data
# beszel_hub_flags (str):     Extra flags passed to beszel command invocation
#                             Default:

. /etc/rc.subr

name="beszel_hub"
rcvar=beszel_hub_enable

load_rc_config $name
: ${beszel_hub_enable:="YES"}
: ${beszel_hub_port:="8090"}
: ${beszel_hub_user:="beszel"}
: ${beszel_hub_flags:=""}
: ${beszel_hub_bin:="/usr/local/sbin/beszel"}
: ${beszel_hub_data:="/usr/local/etc/beszel/beszel_data"}

logfile="/var/log/${name}.log"
pidfile="/var/run/${name}.pid"

procname="/usr/sbin/daemon"
start_precmd="${name}_prestart"
start_cmd="${name}_start"
stop_cmd="${name}_stop"

extra_commands="upgrade"
upgrade_cmd="beszel_hub_upgrade"

beszel_hub_prestart()
{
    if [ ! -d "${beszel_hub_data}" ]; then
        echo "Creating data directory ${beszel_hub_data}"
        mkdir -p "${beszel_hub_data}"
        chown "${beszel_hub_user}:${beszel_hub_user}" "${beszel_hub_data}"
    fi
}

beszel_hub_start()
{
    echo "Starting ${name}"
    cd "$(dirname "${beszel_hub_data}")" || exit 1
    /usr/sbin/daemon -f \
            -P "${pidfile}" \
            -o "${logfile}" \
            -u "${beszel_hub_user}" \
            "${beszel_hub_bin}" serve --http "0.0.0.0:${beszel_hub_port}" ${beszel_hub_flags}
}

beszel_hub_stop()
{
    pid="$(check_pidfile "${pidfile}" "${procname}")"
    if [ -n "${pid}" ]; then
        echo "Stopping ${name} (pid=${pid})"
        kill -- "-${pid}"
        wait_for_pids "${pid}"
    else
        echo "${name} isn't running"
    fi
}

beszel_hub_upgrade()
{
    echo "Upgrading ${name}"
    if command -v sudo >/dev/null; then
        sudo -u "${beszel_hub_user}" -- "${beszel_hub_bin}" update
    else
        su -m "${beszel_hub_user}" -c "${beszel_hub_bin} update"
    fi
}

run_rc_command "$1"
EOF
}

# Detect system architecture
detect_architecture() {
  arch=$(uname -m)
  case "$arch" in
    x86_64)
      arch="amd64"
      ;;
    armv7l)
      arch="arm"
      ;;
    aarch64)
      arch="arm64"
      ;;
  esac
  echo "$arch"
}

# Build sudo args by properly quoting everything
build_sudo_args() {
  QUOTED_ARGS=""
  while [ $# -gt 0 ]; do
    if [ -n "$QUOTED_ARGS" ]; then
      QUOTED_ARGS="$QUOTED_ARGS "
    fi
    QUOTED_ARGS="$QUOTED_ARGS'$(echo "$1" | sed "s/'/'\\\\''/g")'"
    shift
  done
  echo "$QUOTED_ARGS"
}

# Check if running as root and re-execute with sudo if needed
if [ "$(id -u)" != "0" ]; then
  if command -v sudo >/dev/null 2>&1; then
    SUDO_ARGS=$(build_sudo_args "$@")
    eval "exec sudo $0 $SUDO_ARGS"
  else
    echo "This script must be run as root. Please either:"
    echo "1. Run this script as root (su root)"
    echo "2. Install sudo and run with sudo"
    exit 1
  fi
fi

# Define default values
PORT=8090
GITHUB_URL="https://github.com"
AUTO_UPDATE_FLAG="false"
UNINSTALL=false

# Parse command line arguments
while [ $# -gt 0 ]; do
  case "$1" in
    -u)
      UNINSTALL=true
      shift
      ;;
    -h|--help)
      printf "Beszel Hub installation script\n\n"
      printf "Usage: ./install-hub.sh [options]\n\n"
      printf "Options: \n"
      printf "  -u           : Uninstall the Beszel Hub\n"
      printf "  -p <port>    : Specify a port number (default: 8090)\n"
      printf "  -c, --mirror [URL] : Use a GitHub mirror/proxy URL (default: https://gh.beszel.dev)\n"
      printf "  --auto-update : Enable automatic daily updates (disabled by default)\n"
      printf "  -h, --help   : Display this help message\n"
      exit 0
      ;;
    -p)
      shift
      PORT="$1"
      shift
      ;;
    -c | --mirror)
      shift
      if [ -n "$1" ] && ! echo "$1" | grep -q '^-'; then
        GITHUB_URL="$(ensure_trailing_slash "$1")https://github.com"
        shift
      else
        GITHUB_URL="https://gh.beszel.dev"
      fi
      ;;
    --auto-update)
      AUTO_UPDATE_FLAG="true"
      shift
      ;;
    *)
      echo "Invalid option: $1" >&2
      exit 1
      ;;
  esac
done

# Set paths based on operating system
if is_freebsd; then
  HUB_DIR="/usr/local/etc/beszel"
  BIN_PATH="/usr/local/sbin/beszel"
else
  HUB_DIR="/opt/beszel"
  BIN_PATH="/opt/beszel/beszel"
fi

# Uninstall process
if [ "$UNINSTALL" = true ]; then
  if is_freebsd; then
    echo "Stopping and disabling the Beszel Hub service..."
    service beszel-hub stop 2>/dev/null
    sysrc beszel_hub_enable="NO" 2>/dev/null

    echo "Removing the FreeBSD service files..."
    rm -f /usr/local/etc/rc.d/beszel-hub

    echo "Removing the daily update cron job..."
    rm -f /etc/cron.d/beszel-hub

    echo "Removing log files..."
    rm -f /var/log/beszel_hub.log

    echo "Removing the Beszel Hub binary and data..."
    rm -f "$BIN_PATH"
    rm -rf "$HUB_DIR"

    echo "Removing the dedicated user..."
    pw user del beszel 2>/dev/null

    echo "The Beszel Hub has been uninstalled successfully!"
    exit 0
  else
    # Stop and disable the Beszel Hub service
    echo "Stopping and disabling the Beszel Hub service..."
    systemctl stop beszel-hub.service
    systemctl disable beszel-hub.service

    # Remove the systemd service file
    echo "Removing the systemd service file..."
    rm -f /etc/systemd/system/beszel-hub.service

    # Remove the update timer and service if they exist
    echo "Removing the daily update service and timer..."
    systemctl stop beszel-hub-update.timer 2>/dev/null
    systemctl disable beszel-hub-update.timer 2>/dev/null
    rm -f /etc/systemd/system/beszel-hub-update.service
    rm -f /etc/systemd/system/beszel-hub-update.timer

    # Reload the systemd daemon
    echo "Reloading the systemd daemon..."
    systemctl daemon-reload

    # Remove the Beszel Hub binary and data
    echo "Removing the Beszel Hub binary and data..."
    rm -rf "$HUB_DIR"

    # Remove the dedicated user
    echo "Removing the dedicated user..."
    userdel beszel 2>/dev/null

    echo "The Beszel Hub has been uninstalled successfully!"
    exit 0
  fi
fi

# Function to check if a package is installed
package_installed() {
  command -v "$1" >/dev/null 2>&1
}

# Check for package manager and install necessary packages if not installed
if package_installed pkg && is_freebsd; then
  if ! package_installed tar || ! package_installed curl; then
    pkg update
    pkg install -y gtar curl
  fi
elif package_installed apt-get; then
  if ! package_installed tar || ! package_installed curl; then
    apt-get update
    apt-get install -y tar curl
  fi
elif package_installed yum; then
  if ! package_installed tar || ! package_installed curl; then
    yum install -y tar curl
  fi
elif package_installed pacman; then
  if ! package_installed tar || ! package_installed curl; then
    pacman -Sy --noconfirm tar curl
  fi
else
  echo "Warning: Please ensure 'tar' and 'curl' are installed."
fi

# Create a dedicated user for the service if it doesn't exist
echo "Creating a dedicated user for the Beszel Hub service..."
if is_freebsd; then
  if ! id -u beszel >/dev/null 2>&1; then
    pw user add beszel -d /nonexistent -s /usr/sbin/nologin -c "beszel user"
  fi
else
  if ! id -u beszel >/dev/null 2>&1; then
    useradd -M -s /bin/false beszel
  fi
fi

# Create the directory for the Beszel Hub
echo "Creating the directory for the Beszel Hub..."
mkdir -p "$HUB_DIR/beszel_data"
chown -R beszel:beszel "$HUB_DIR"
chmod 755 "$HUB_DIR"

# Download and install the Beszel Hub
echo "Downloading and installing the Beszel Hub..."

OS=$(uname -s | tr '[:upper:]' '[:lower:]')
ARCH=$(detect_architecture)
FILE_NAME="beszel_${OS}_${ARCH}.tar.gz"

TEMP_DIR=$(mktemp -d)
ARCHIVE_PATH="$TEMP_DIR/$FILE_NAME"
DOWNLOAD_URL="$GITHUB_URL/henrygd/beszel/releases/latest/download/$FILE_NAME"

if ! curl -fL# --retry 3 --retry-delay 2 --connect-timeout 10 "$DOWNLOAD_URL" -o "$ARCHIVE_PATH"; then
  echo "Failed to download the Beszel Hub from:"
  echo "$DOWNLOAD_URL"
  echo "Try again with --mirror (or --mirror <url>) if GitHub is not reachable."
  rm -rf "$TEMP_DIR"
  exit 1
fi

if ! tar -tzf "$ARCHIVE_PATH" >/dev/null 2>&1; then
  echo "Downloaded archive is invalid or incomplete (possible network/proxy issue)."
  echo "Try again with --mirror (or --mirror <url>) if the download path is unstable."
  rm -rf "$TEMP_DIR"
  exit 1
fi

if ! tar -xzf "$ARCHIVE_PATH" -C "$TEMP_DIR" beszel; then
  echo "Failed to extract beszel from archive."
  rm -rf "$TEMP_DIR"
  exit 1
fi

if [ ! -s "$TEMP_DIR/beszel" ]; then
  echo "Downloaded binary is missing or empty."
  rm -rf "$TEMP_DIR"
  exit 1
fi

chmod +x "$TEMP_DIR/beszel"
mv "$TEMP_DIR/beszel" "$BIN_PATH"
chown beszel:beszel "$BIN_PATH"
restore_selinux_context "$BIN_PATH"
rm -rf "$TEMP_DIR"

if is_freebsd; then
  echo "Creating FreeBSD rc service..."

  # Create the rc service file
  generate_freebsd_rc_service > /usr/local/etc/rc.d/beszel-hub

  # Set proper permissions for the rc script
  chmod 755 /usr/local/etc/rc.d/beszel-hub

  # Configure the port
  sysrc beszel_hub_port="$PORT"

  # Enable and start the service
  echo "Enabling and starting the Beszel Hub service..."
  sysrc beszel_hub_enable="YES"
  service beszel-hub restart

  # Check if service started successfully
  sleep 2
  if ! service beszel-hub status | grep -q "is running"; then
    echo "Error: The Beszel Hub service failed to start. Checking logs..."
    tail -n 20 /var/log/beszel_hub.log
    exit 1
  fi

  # Auto-update service for FreeBSD
  if [ "$AUTO_UPDATE_FLAG" = "true" ]; then
    echo "Setting up daily automatic updates for beszel-hub..."

    # Create cron job in /etc/cron.d
    cat >/etc/cron.d/beszel-hub <<EOF
# Beszel Hub daily update job
12 8 * * * root $BIN_PATH update >/dev/null 2>&1
EOF
    chmod 644 /etc/cron.d/beszel-hub
    printf "\nDaily updates have been enabled via /etc/cron.d.\n"
  fi

  # Check service status
  if ! service beszel-hub status >/dev/null 2>&1; then
    echo "Error: The Beszel Hub service is not running."
    service beszel-hub status
    exit 1
  fi

else
  # Original systemd service installation code
  printf "Creating the systemd service for the Beszel Hub...\n"
  cat >/etc/systemd/system/beszel-hub.service <<EOF
[Unit]
Description=Beszel Hub Service
After=network.target

[Service]
ExecStart=$BIN_PATH serve --http "0.0.0.0:$PORT"
WorkingDirectory=$HUB_DIR
User=beszel
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target
EOF

  # Load and start the service
  printf "Loading and starting the Beszel Hub service...\n"
  systemctl daemon-reload
  systemctl enable --quiet beszel-hub.service
  systemctl start --quiet beszel-hub.service

  # Wait for the service to start or fail
  sleep 2

  # Check if the service is running
  if [ "$(systemctl is-active beszel-hub.service)" != "active" ]; then
    echo "Error: The Beszel Hub service is not running."
    echo "$(systemctl status beszel-hub.service)"
    exit 1
  fi

  # Enable auto-update if flag is set to true
  if [ "$AUTO_UPDATE_FLAG" = "true" ]; then
    echo "Setting up daily automatic updates for beszel-hub..."

    # Create systemd service for the daily update
    cat >/etc/systemd/system/beszel-hub-update.service <<EOF
[Unit]
Description=Update beszel-hub if needed
Wants=beszel-hub.service

[Service]
Type=oneshot
WorkingDirectory=$HUB_DIR
ExecStart=$BIN_PATH update
EOF

    # Create systemd timer for the daily update
    cat >/etc/systemd/system/beszel-hub-update.timer <<EOF
[Unit]
Description=Run beszel-hub update daily

[Timer]
OnCalendar=daily
Persistent=true
RandomizedDelaySec=4h

[Install]
WantedBy=timers.target
EOF

    systemctl daemon-reload
    systemctl enable --now beszel-hub-update.timer

    printf "\nDaily updates have been enabled.\n"
  fi
fi

printf "\n\033[32mBeszel Hub has been installed successfully! It is now accessible on port $PORT.\033[0m\n"