add homarr

2025-05-08 17:51:08 +02:00 · 2025-05-08 17:51:08 +02:00 · e828a503d3
commit e828a503d3
parent bc58b39cf8
3 changed files with 336 additions and 0 deletions
--- a/ct/homarr.sh
+++ b/ct/homarr.sh
@ -0,0 +1,170 @@
+#!/usr/bin/env bash
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# Copyright (c) 2021-2025 tteck
+# Author: tteck (tteckster) | Co-Author: MickLesk (Canbiz) | Co-Author: CrazyWolf13
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://homarr.dev/
+
+APP="Homarr"
+var_tags="${var_tags:-arr;dashboard}"
+var_cpu="${var_cpu:-2}"
+var_ram="${var_ram:-4096}"
+var_disk="${var_disk:-8}"
+var_os="${var_os:-debian}"
+var_version="${var_version:-12}"
+var_unprivileged="${var_unprivileged:-1}"
+
+header_info "$APP"
+
+variables
+color
+catch_errors
+
+function update_script() {
+  header_info
+  check_container_storage
+  check_container_resources
+  if [[ ! -d /opt/homarr ]]; then
+    msg_error "No ${APP} Installation Found!"
+    exit
+  fi
+  if [[ -f /opt/homarr/database/db.sqlite ]]; then
+    msg_error "Old Homarr detected due to existing database file (/opt/homarr/database/db.sqlite)."
+    msg_error "Update not supported. Refer to:"
+    msg_error " - https://github.com/community-scripts/ProxmoxVE/discussions/1551"
+    msg_error " - https://homarr.dev/docs/getting-started/after-the-installation/#importing-a-zip-from-version-before-100"
+    exit 1
+  fi
+  if [[ ! -f /opt/run_homarr.sh ]]; then
+    msg_info "Detected outdated and missing service files"
+    msg_error "Warning - The port of homarr changed from 3000 to 7575"
+    $STD apt-get install -y nginx gettext openssl gpg
+    sed -i '/^NODE_ENV=/d' /opt/homarr/.env && echo "NODE_ENV='production'" >>/opt/homarr/.env
+    sed -i '/^DB_DIALECT=/d' /opt/homarr/.env && echo "DB_DIALECT='sqlite'" >>/opt/homarr/.env
+    cat <<'EOF' >/opt/run_homarr.sh
+#!/bin/bash
+set -a
+source /opt/homarr/.env
+set +a
+export DB_DIALECT='sqlite'
+export AUTH_SECRET=$(openssl rand -base64 32)
+node /opt/homarr_db/migrations/$DB_DIALECT/migrate.cjs /opt/homarr_db/migrations/$DB_DIALECT
+for dir in $(find /opt/homarr_db/migrations/migrations -mindepth 1 -maxdepth 1 -type d); do
+  dirname=$(basename "$dir")
+  mkdir -p "/opt/homarr_db/migrations/$dirname"
+  cp -r "$dir"/* "/opt/homarr_db/migrations/$dirname/" 2>/dev/null || true
+done
+export HOSTNAME=$(ip route get 1.1.1.1 | grep -oP 'src \K[^ ]+')
+envsubst '${HOSTNAME}' < /etc/nginx/templates/nginx.conf > /etc/nginx/nginx.conf
+nginx -g 'daemon off;' &
+redis-server /opt/homarr/packages/redis/redis.conf &
+node apps/tasks/tasks.cjs &
+node apps/websocket/wssServer.cjs &
+node apps/nextjs/server.js & PID=$!
+wait $PID
+EOF
+    chmod +x /opt/run_homarr.sh
+    rm /etc/systemd/system/homarr.service
+    cat <<EOF >/etc/systemd/system/homarr.service
+[Unit]
+Description=Homarr Service
+After=network.target
+[Service]
+Type=exec
+WorkingDirectory=/opt/homarr
+EnvironmentFile=-/opt/homarr/.env
+ExecStart=/opt/run_homarr.sh
+[Install]
+WantedBy=multi-user.target
+EOF
+    msg_ok "Updated Services"
+    systemctl daemon-reload
+  fi
+  RELEASE=$(curl -fsSL https://api.github.com/repos/homarr-labs/homarr/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
+  if [[ ! -f /opt/${APP}_version.txt ]] || [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]]; then
+
+    msg_info "Stopping Services (Patience)"
+    systemctl stop homarr
+    msg_ok "Services Stopped"
+
+    msg_info "Backup Data"
+    mkdir -p /opt/homarr-data-backup
+    cp /opt/homarr/.env /opt/homarr-data-backup/.env
+    msg_ok "Backup Data"
+
+    msg_info "Updating and rebuilding ${APP} to v${RELEASE} (Patience)"
+    rm /opt/run_homarr.sh
+    cat <<'EOF' >/opt/run_homarr.sh
+#!/bin/bash
+set -a
+source /opt/homarr/.env
+set +a
+export DB_DIALECT='sqlite'
+export AUTH_SECRET=$(openssl rand -base64 32)
+node /opt/homarr_db/migrations/$DB_DIALECT/migrate.cjs /opt/homarr_db/migrations/$DB_DIALECT
+for dir in $(find /opt/homarr_db/migrations/migrations -mindepth 1 -maxdepth 1 -type d); do
+  dirname=$(basename "$dir")
+  mkdir -p "/opt/homarr_db/migrations/$dirname"
+  cp -r "$dir"/* "/opt/homarr_db/migrations/$dirname/" 2>/dev/null || true
+done
+export HOSTNAME=$(ip route get 1.1.1.1 | grep -oP 'src \K[^ ]+')
+envsubst '${HOSTNAME}' < /etc/nginx/templates/nginx.conf > /etc/nginx/nginx.conf
+nginx -g 'daemon off;' &
+redis-server /opt/homarr/packages/redis/redis.conf &
+node apps/tasks/tasks.cjs &
+node apps/websocket/wssServer.cjs &
+node apps/nextjs/server.js & PID=$!
+wait $PID
+EOF
+    chmod +x /opt/run_homarr.sh
+    curl -fsSL "https://github.com/homarr-labs/homarr/archive/refs/tags/v${RELEASE}.zip" -o $(basename "https://github.com/homarr-labs/homarr/archive/refs/tags/v${RELEASE}.zip")
+    unzip -q v${RELEASE}.zip
+    rm -rf v${RELEASE}.zip
+    rm -rf /opt/homarr
+    mv homarr-${RELEASE} /opt/homarr
+    mv /opt/homarr-data-backup/.env /opt/homarr/.env
+    cd /opt/homarr
+    $STD pnpm install
+    $STD pnpm build
+    cp /opt/homarr/apps/nextjs/next.config.ts .
+    cp /opt/homarr/apps/nextjs/package.json .
+    cp -r /opt/homarr/packages/db/migrations /opt/homarr_db/migrations
+    cp -r /opt/homarr/apps/nextjs/.next/standalone/* /opt/homarr
+    mkdir -p /appdata/redis
+    cp /opt/homarr/packages/redis/redis.conf /opt/homarr/redis.conf
+    rm /etc/nginx/nginx.conf
+    mkdir -p /etc/nginx/templates
+    cp /opt/homarr/nginx.conf /etc/nginx/templates/nginx.conf
+
+    mkdir -p /opt/homarr/apps/cli
+    cp /opt/homarr/packages/cli/cli.cjs /opt/homarr/apps/cli/cli.cjs
+    echo $'#!/bin/bash\ncd /opt/homarr/apps/cli && node ./cli.cjs "$@"' >/usr/bin/homarr
+    chmod +x /usr/bin/homarr
+
+    mkdir /opt/homarr/build
+    cp ./node_modules/better-sqlite3/build/Release/better_sqlite3.node ./build/better_sqlite3.node
+    echo "${RELEASE}" >/opt/${APP}_version.txt
+    msg_ok "Updated ${APP}"
+
+    msg_info "Starting Services"
+    systemctl start homarr
+    msg_ok "Started Services"
+    msg_ok "Updated Successfully"
+    read -p "It's recommended to reboot the LXC after an update, would you like to reboot the LXC now ? (y/n): " choice
+    if [[ "$choice" =~ ^[Yy]$ ]]; then
+      reboot
+    fi
+  else
+    msg_ok "No update required. ${APP} is already at v${RELEASE}"
+  fi
+  exit
+}
+
+start
+build_container
+description
+
+msg_ok "Completed Successfully!\n"
+echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}"
+echo -e "${INFO}${YW} Access it using the following URL:${CL}"
+echo -e "${TAB}${GATEWAY}${BGN}http://${IP}:7575${CL}"
--- a/frontend/public/json/homarr.json
+++ b/frontend/public/json/homarr.json
@ -0,0 +1,35 @@
+{
+  "name": "Homarr",
+  "slug": "homarr",
+  "categories": [
+    10
+  ],
+  "date_created": "2025-01-28",
+  "type": "ct",
+  "updateable": true,
+  "privileged": false,
+  "interface_port": 7575,
+  "documentation": null,
+  "website": "https://homarr.dev/",
+  "logo": "https://raw.githubusercontent.com/loganmarchione/homelab-svg-assets/main/assets/homarr.svg",
+  "config_path": "/opt/homarr/.env",
+  "description": "Homarr is a sleek, modern dashboard that puts all of your apps and services at your fingertips.",
+  "install_methods": [
+    {
+      "type": "default",
+      "script": "ct/homarr.sh",
+      "resources": {
+        "cpu": 2,
+        "ram": 4096,
+        "hdd": 8,
+        "os": "debian",
+        "version": "12"
+      }
+    }
+  ],
+  "default_credentials": {
+    "username": null,
+    "password": null
+  },
+  "notes": []
+}
--- a/install/homarr-install.sh
+++ b/install/homarr-install.sh
@ -0,0 +1,131 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: MickLesk (Canbiz)
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://github.com/homarr-labs/homarr
+
+source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
+color
+verb_ip6
+catch_errors
+setting_up_container
+network_check
+update_os
+
+msg_info "Installing Dependencies"
+$STD apt-get install -y \
+  redis-server \
+  ca-certificates \
+  gpg \
+  make \
+  g++ \
+  build-essential \
+  nginx \
+  gettext \
+  openssl
+msg_ok "Installed Dependencies"
+
+msg_info "Setting up Node.js Repository"
+mkdir -p /etc/apt/keyrings
+curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
+echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" >/etc/apt/sources.list.d/nodesource.list
+msg_ok "Set up Node.js Repository"
+
+msg_info "Installing Node.js/pnpm"
+$STD apt-get update
+$STD apt-get install -y nodejs
+$STD npm install -g pnpm@latest
+msg_ok "Installed Node.js/pnpm"
+
+msg_info "Installing Homarr (Patience)"
+cd /opt
+RELEASE=$(curl -fsSL https://api.github.com/repos/homarr-labs/homarr/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
+curl -fsSL "https://github.com/homarr-labs/homarr/archive/refs/tags/v${RELEASE}.zip" -o $(basename "https://github.com/homarr-labs/homarr/archive/refs/tags/v${RELEASE}.zip")
+unzip -q v${RELEASE}.zip
+mv homarr-${RELEASE} /opt/homarr
+mkdir -p /opt/homarr_db
+touch /opt/homarr_db/db.sqlite
+SECRET_ENCRYPTION_KEY="$(openssl rand -hex 32)"
+cd /opt/homarr
+cat <<EOF >/opt/homarr/.env
+DB_DRIVER='better-sqlite3'
+DB_DIALECT='sqlite'
+SECRET_ENCRYPTION_KEY='${SECRET_ENCRYPTION_KEY}'
+DB_URL='/opt/homarr_db/db.sqlite'
+TURBO_TELEMETRY_DISABLED=1
+AUTH_PROVIDERS='credentials'
+NODE_ENV='production'
+EOF
+$STD pnpm install
+$STD pnpm build
+msg_ok "Installed Homarr"
+
+msg_info "Copying build and config files"
+cp /opt/homarr/apps/nextjs/next.config.ts .
+cp /opt/homarr/apps/nextjs/package.json .
+cp -r /opt/homarr/packages/db/migrations /opt/homarr_db/migrations
+cp -r /opt/homarr/apps/nextjs/.next/standalone/* /opt/homarr
+mkdir -p /appdata/redis
+cp /opt/homarr/packages/redis/redis.conf /opt/homarr/redis.conf
+mkdir -p /etc/nginx/templates
+rm /etc/nginx/nginx.conf
+cp /opt/homarr/nginx.conf /etc/nginx/templates/nginx.conf
+mkdir -p /opt/homarr/apps/cli
+cp /opt/homarr/packages/cli/cli.cjs /opt/homarr/apps/cli/cli.cjs
+echo $'#!/bin/bash\ncd /opt/homarr/apps/cli && node ./cli.cjs "$@"' >/usr/bin/homarr
+chmod +x /usr/bin/homarr
+mkdir /opt/homarr/build
+cp ./node_modules/better-sqlite3/build/Release/better_sqlite3.node ./build/better_sqlite3.node
+echo "${RELEASE}" >"/opt/${APPLICATION}_version.txt"
+msg_ok "Finished copying"
+
+msg_info "Creating Services"
+cat <<'EOF' >/opt/run_homarr.sh
+#!/bin/bash
+set -a
+source /opt/homarr/.env
+set +a
+export DB_DIALECT='sqlite'
+export AUTH_SECRET=$(openssl rand -base64 32)
+node /opt/homarr_db/migrations/$DB_DIALECT/migrate.cjs /opt/homarr_db/migrations/$DB_DIALECT
+for dir in $(find /opt/homarr_db/migrations/migrations -mindepth 1 -maxdepth 1 -type d); do
+  dirname=$(basename "$dir")
+  mkdir -p "/opt/homarr_db/migrations/$dirname"
+  cp -r "$dir"/* "/opt/homarr_db/migrations/$dirname/" 2>/dev/null || true
+done
+export HOSTNAME=$(ip route get 1.1.1.1 | grep -oP 'src \K[^ ]+')
+envsubst '${HOSTNAME}' < /etc/nginx/templates/nginx.conf > /etc/nginx/nginx.conf
+nginx -g 'daemon off;' &
+redis-server /opt/homarr/packages/redis/redis.conf &
+node apps/tasks/tasks.cjs &
+node apps/websocket/wssServer.cjs &
+node apps/nextjs/server.js & PID=$!
+wait $PID
+EOF
+chmod +x /opt/run_homarr.sh
+cat <<EOF >/etc/systemd/system/homarr.service
+[Unit]
+Description=Homarr Service
+After=network.target
+
+[Service]
+Type=exec
+WorkingDirectory=/opt/homarr
+EnvironmentFile=-/opt/homarr/.env
+ExecStart=/opt/run_homarr.sh
+
+[Install]
+WantedBy=multi-user.target
+EOF
+systemctl enable -q --now homarr
+msg_ok "Created Service"
+
+motd_ssh
+customize
+
+msg_info "Cleaning up"
+rm -rf /opt/v${RELEASE}.zip
+$STD apt-get -y autoremove
+$STD apt-get -y autoclean
+msg_ok "Cleaned"