Remove unnecessary newline in koel.sh

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

CHANGELOG.md

@@ -12,6 +12,22 @@ Exercise vigilance regarding copycat or coat-tailing sites that seek to exploit
 
 ## 2025-12-15
 
+### 🚀 Updated Scripts
+
+  - #### 🔧 Refactor
+
+    - Refactor: Heimdall Dashboard [@tremor021](https://github.com/tremor021) ([#9959](https://github.com/community-scripts/ProxmoxVE/pull/9959))
+
+### 💾 Core
+
+  - #### 🐞 Bug Fixes
+
+    - core: load app defaults before applying base_settings / fix composer cleanup after install/update [@MickLesk](https://github.com/MickLesk) ([#9965](https://github.com/community-scripts/ProxmoxVE/pull/9965))
+
+### 📚 Documentation
+
+  - README; add project statistics / formatting [@MickLesk](https://github.com/MickLesk) ([#9967](https://github.com/community-scripts/ProxmoxVE/pull/9967))
+
 ## 2025-12-14
 
 ### 🚀 Updated Scripts

README.md

@@ -30,8 +30,8 @@
 
   <br />
 
-> **Simplify your Proxmox VE setup with community-driven automation scripts**  
-> Originally created by tteck, now maintained and expanded by the community
+ **Simplify your Proxmox VE setup with community-driven automation scripts**  
+ Originally created by tteck, now maintained and expanded by the community
 
 </div>
 
@@ -239,17 +239,34 @@ This project is maintained by volunteers in memory of tteck. Your support helps
 
 ---
 
-## 📈 Project Growth
+## 📈 Project Statistics
+<p align="center">
+  <img
+    src="https://repobeats.axiom.co/api/embed/57edde03e00f88d739bdb5b844ff7d07dd079375.svg"
+    alt="Repobeats analytics"
+    width="650"
+  />
+</p>
 
-<div align="center">
+<p align="center">
   <a href="https://star-history.com/#community-scripts/ProxmoxVE&Date">
     <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date&theme=dark" />
-      <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date" />
-      <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date" />
+      <source
+        media="(prefers-color-scheme: dark)"
+        srcset="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date&theme=dark"
+      />
+      <source
+        media="(prefers-color-scheme: light)"
+        srcset="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date"
+      />
+      <img
+        alt="Star History Chart"
+        src="https://api.star-history.com/svg?repos=community-scripts/ProxmoxVE&type=Date"
+        width="650"
+      />
     </picture>
   </a>
-</div>
+</p>
 
 ---
 

ct/heimdall-dashboard.sh

@@ -11,7 +11,7 @@ var_cpu="${var_cpu:-1}"
 var_ram="${var_ram:-512}"
 var_disk="${var_disk:-2}"
 var_os="${var_os:-debian}"
-var_version="${var_version:-12}"
+var_version="${var_version:-13}"
 var_unprivileged="${var_unprivileged:-1}"
 
 header_info "$APP"
@@ -27,45 +27,45 @@ function update_script() {
     msg_error "No ${APP} Installation Found!"
     exit
   fi
-  RELEASE=$(curl -fsSL "https://api.github.com/repos/linuxserver/Heimdall/releases/latest" | awk '/tag_name/{print $4;exit}' FS='[""]')
-  if [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]] || [[ ! -f /opt/${APP}_version.txt ]]; then
+
+  if check_for_gh_release "Heimdall" "linuxserver/Heimdall"; then
     msg_info "Stopping Service"
     systemctl stop heimdall
     sleep 1
     msg_ok "Stopped Service"
+
     msg_info "Backing up Data"
     cp -R /opt/Heimdall/database database-backup
     cp -R /opt/Heimdall/public public-backup
     sleep 1
     msg_ok "Backed up Data"
-    msg_info "Updating Heimdall Dashboard to ${RELEASE}"
-    curl -fsSL "https://github.com/linuxserver/Heimdall/archive/${RELEASE}.tar.gz" -o $(basename "https://github.com/linuxserver/Heimdall/archive/${RELEASE}.tar.gz")
-    tar xzf "${RELEASE}".tar.gz
-    VER=$(curl -fsSL https://api.github.com/repos/linuxserver/Heimdall/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
-    cp -R Heimdall-"${VER}"/* /opt/Heimdall
+
+    setup_composer
+    fetch_and_deploy_gh_release "Heimdall" "linuxserver/Heimdall" "tarball"
+
+    msg_info "Updating Heimdall-Dashboard"
     cd /opt/Heimdall
-    $STD apt-get install -y composer
     export COMPOSER_ALLOW_SUPERUSER=1
     $STD composer dump-autoload
-    echo "${RELEASE}" >/opt/${APP}_version.txt
-    msg_ok "Updated Heimdall Dashboard to ${RELEASE}"
+    msg_ok "Updated Heimdall-Dashboard"
+
     msg_info "Restoring Data"
     cd ~
     cp -R database-backup/* /opt/Heimdall/database
     cp -R public-backup/* /opt/Heimdall/public
     sleep 1
     msg_ok "Restored Data"
-    msg_info "Cleanup"
-    rm -rf {"${RELEASE}".tar.gz,Heimdall-"${VER}",public-backup,database-backup,Heimdall}
+
+    msg_info "Cleaning Up"
+    rm -rf {public-backup,database-backup}
     sleep 1
-    msg_ok "Cleaned"
+    msg_ok "Cleaned Up"
+
     msg_info "Starting Service"
     systemctl start heimdall.service
     sleep 2
     msg_ok "Started Service"
     msg_ok "Updated successfully!"
-  else
-    msg_ok "No update required.  ${APP} is already at ${RELEASE}."
   fi
   exit
 }

ct/koel.sh

@@ -0,0 +1,81 @@
+#!/usr/bin/env bash
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: MickLesk (CanbiZ)
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://koel.dev/
+
+APP="Koel"
+var_tags="${var_tags:-music;streaming}"
+var_cpu="${var_cpu:-2}"
+var_ram="${var_ram:-2048}"
+var_disk="${var_disk:-8}"
+var_os="${var_os:-debian}"
+var_version="${var_version:-13}"
+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/koel ]]; then
+    msg_error "No ${APP} Installation Found!"
+    exit
+  fi
+
+  if check_for_gh_release "koel" "koel/koel"; then
+    msg_info "Stopping Services"
+    systemctl stop nginx php8.4-fpm
+    msg_ok "Stopped Services"
+
+    msg_info "Creating Backup"
+    mkdir -p /tmp/koel_backup
+    cp /opt/koel/.env /tmp/koel_backup/
+    cp -r /opt/koel/storage /tmp/koel_backup/ 2>/dev/null || true
+    cp -r /opt/koel/public/img /tmp/koel_backup/ 2>/dev/null || true
+    msg_ok "Created Backup"
+
+    CLEAN_INSTALL=1 fetch_and_deploy_gh_release "koel" "koel/koel" "prebuild" "latest" "/opt/koel" "koel-*.tar.gz"
+
+    msg_info "Restoring Data"
+    cp /tmp/koel_backup/.env /opt/koel/
+    cp -r /tmp/koel_backup/storage/* /opt/koel/storage/ 2>/dev/null || true
+    cp -r /tmp/koel_backup/img/* /opt/koel/public/img/ 2>/dev/null || true
+    rm -rf /tmp/koel_backup
+    msg_ok "Restored Data"
+
+    msg_info "Running Migrations"
+    cd /opt/koel
+    export COMPOSER_ALLOW_SUPERUSER=1
+    $STD composer install --no-interaction --no-dev --optimize-autoloader
+    $STD php artisan migrate --force
+    $STD php artisan config:clear
+    $STD php artisan cache:clear
+    $STD php artisan view:clear
+    $STD php artisan koel:init --no-assets --no-interaction
+    chown -R www-data:www-data /opt/koel
+    chmod -R 775 /opt/koel/storage
+    msg_ok "Ran Migrations"
+
+    msg_info "Starting Services"
+    systemctl start php8.4-fpm nginx
+    msg_ok "Started Services"
+    msg_ok "Updated Successfully"
+  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}${CL}"

frontend/public/json/heimdall-dashboard.json

@@ -23,7 +23,7 @@
         "ram": 512,
         "hdd": 2,
         "os": "debian",
-        "version": "12"
+        "version": "13"
       }
     }
   ],

frontend/public/json/koel.json

@@ -0,0 +1,48 @@
+{
+    "name": "Koel",
+    "slug": "koel",
+    "categories": [
+        13
+    ],
+    "date_created": "2025-12-10",
+    "type": "ct",
+    "updateable": true,
+    "privileged": false,
+    "interface_port": 80,
+    "documentation": "https://docs.koel.dev/",
+    "config_path": "/opt/koel/.env",
+    "website": "https://koel.dev/",
+    "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/koel-light.webp",
+    "description": "Koel is a simple web-based personal audio streaming service written in Vue and Laravel. It supports multiple users, audio visualization, smart playlists, YouTube integration, and Last.fm scrobbling.",
+    "install_methods": [
+        {
+            "type": "default",
+            "script": "ct/koel.sh",
+            "resources": {
+                "cpu": 2,
+                "ram": 2048,
+                "hdd": 8,
+                "os": "Debian",
+                "version": "13"
+            }
+        }
+    ],
+    "default_credentials": {
+        "username": "admin@koel.dev",
+        "password": "KoelIsCool"
+    },
+    "notes": [
+        {
+            "text": "Media files should be placed in /opt/koel_media",
+            "type": "info"
+        },
+        {
+            "text": "Database credentials are stored in ~/koel.creds",
+            "type": "info"
+        },
+        {
+            "text": "Music library is scanned hourly via cron job",
+            "type": "info"
+        }
+    ]
+}

install/heimdall-dashboard-install.sh

@@ -14,27 +14,22 @@ network_check
 update_os
 
 msg_info "Installing Dependencies"
-$STD apt-get install -y apt-transport-https
-$STD apt-get install -y composer
-$STD apt-get install -y php8.2-{bz2,curl,sqlite3,zip,xml}
+$STD apt install -y apt-transport-https
 msg_ok "Installed Dependencies"
 
-RELEASE=$(curl -fsSL "https://api.github.com/repos/linuxserver/Heimdall/releases/latest" | awk '/tag_name/{print $4;exit}' FS='[""]')
-echo "${RELEASE}" >/opt/"${APPLICATION}"_version.txt
-msg_info "Installing Heimdall Dashboard ${RELEASE}"
-curl -fsSL "https://github.com/linuxserver/Heimdall/archive/${RELEASE}.tar.gz" -o "${RELEASE}".tar.gz
-tar xzf "${RELEASE}".tar.gz
-VER=$(curl -fsSL https://api.github.com/repos/linuxserver/Heimdall/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
-rm -rf "${RELEASE}".tar.gz
-mv Heimdall-"${VER}" /opt/Heimdall
+PHP_VERSION="8.4" PHP_MODULE="bz2,sqlite3" PHP_FPM="YES" setup_php
+setup_composer
+fetch_and_deploy_gh_release "Heimdall" "linuxserver/Heimdall" "tarball"
+
+msg_info "Setting up Heimdall-Dashboard"
 cd /opt/Heimdall
 cp .env.example .env
 $STD php artisan key:generate
-msg_ok "Installed Heimdall Dashboard ${RELEASE}"
+msg_ok "Setup Heimdall-Dashboard"
 
 msg_info "Creating Service"
-service_path="/etc/systemd/system/heimdall.service"
-echo "[Unit]
+cat <<EOF >/etc/systemd/system/heimdall.service
+[Unit]
 Description=Heimdall
 After=network.target
 
@@ -44,14 +39,16 @@ RestartSec=5
 Type=simple
 User=root
 WorkingDirectory=/opt/Heimdall
-ExecStart="/usr/bin/php" artisan serve --port 7990 --host 0.0.0.0
+ExecStart=/usr/bin/php artisan serve --port 7990 --host 0.0.0.0
 TimeoutStopSec=30
 
 [Install]
-WantedBy=multi-user.target" >$service_path
+WantedBy=multi-user.target"
+EOF
 systemctl enable -q --now heimdall
 cd /opt/Heimdall
-COMPOSER_ALLOW_SUPERUSER=1 composer dump-autoload &>/dev/null
+export COMPOSER_ALLOW_SUPERUSER=1
+$STD composer dump-autoload
 systemctl restart heimdall.service
 msg_ok "Created Service"
 

install/koel-install.sh

@@ -0,0 +1,189 @@
+#!/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://koel.dev/
+
+source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
+color
+verb_ip6
+catch_errors
+setting_up_container
+network_check
+update_os
+
+msg_info "Installing Dependencies"
+$STD apt install -y \
+  nginx \
+  ffmpeg \
+  cron \
+  locales
+msg_ok "Installed Dependencies"
+
+import_local_ip
+PG_VERSION="16" setup_postgresql
+PG_DB_NAME="koel" PG_DB_USER="koel" setup_postgresql_db
+PHP_VERSION="8.4" PHP_FPM="YES" PHP_MODULE="bz2,exif,imagick,pgsql,sqlite3" setup_php
+NODE_VERSION="22" NODE_MODULE="pnpm" setup_nodejs
+setup_composer
+
+fetch_and_deploy_gh_release "koel" "koel/koel" "prebuild" "latest" "/opt/koel" "koel-*.tar.gz"
+
+msg_info "Configuring Koel"
+mkdir -p /opt/koel_media /opt/koel_sync
+cd /opt/koel
+cat <<EOF >/opt/koel/.env
+APP_NAME=Koel
+APP_ENV=production
+APP_DEBUG=false
+APP_URL=http://${LOCAL_IP}
+APP_KEY=
+
+TRUSTED_HOSTS=
+
+DB_CONNECTION=pgsql
+DB_HOST=127.0.0.1
+DB_PORT=5432
+DB_DATABASE=${PG_DB_NAME}
+DB_USERNAME=${PG_DB_USER}
+DB_PASSWORD=${PG_DB_PASS}
+
+STORAGE_DRIVER=local
+MEDIA_PATH=/opt/koel_media
+ARTIFACTS_PATH=
+
+IGNORE_DOT_FILES=true
+APP_MAX_SCAN_TIME=600
+MEMORY_LIMIT=
+
+STREAMING_METHOD=php
+SCOUT_DRIVER=tntsearch
+
+USE_MUSICBRAINZ=true
+MUSICBRAINZ_USER_AGENT=
+
+LASTFM_API_KEY=
+LASTFM_API_SECRET=
+
+SPOTIFY_CLIENT_ID=
+SPOTIFY_CLIENT_SECRET=
+
+YOUTUBE_API_KEY=
+
+CDN_URL=
+
+TRANSCODE_FLAC=false
+FFMPEG_PATH=/usr/bin/ffmpeg
+TRANSCODE_BIT_RATE=128
+
+ALLOW_DOWNLOAD=true
+BACKUP_ON_DELETE=true
+
+MEDIA_BROWSER_ENABLED=false
+
+PROXY_AUTH_ENABLED=false
+
+SYNC_LOG_LEVEL=error
+FORCE_HTTPS=
+
+MAIL_FROM_ADDRESS="noreply@localhost"
+MAIL_FROM_NAME="Koel"
+MAIL_MAILER=log
+MAIL_HOST=null
+MAIL_PORT=null
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+
+BROADCAST_CONNECTION=log
+CACHE_DRIVER=file
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=file
+SESSION_LIFETIME=120
+EOF
+
+mkdir -p /opt/koel/storage/{app/public,framework/{cache/data,sessions,views},logs}
+chown -R www-data:www-data /opt/koel /opt/koel_media /opt/koel_sync
+chmod -R 775 /opt/koel/storage /opt/koel/bootstrap/cache
+msg_ok "Configured Koel"
+
+msg_info "Installing Koel (Patience)"
+export COMPOSER_ALLOW_SUPERUSER=1
+cd /opt/koel
+$STD composer install --no-interaction --no-dev --optimize-autoloader
+$STD php artisan key:generate --force
+$STD php artisan config:clear
+$STD php artisan cache:clear
+$STD php artisan koel:init --no-assets --no-interaction
+chown -R www-data:www-data /opt/koel
+msg_ok "Installed Koel"
+
+msg_info "Tuning PHP-FPM"
+PHP_FPM_CONF="/etc/php/8.4/fpm/pool.d/www.conf"
+sed -i 's/^pm.max_children = .*/pm.max_children = 15/' "$PHP_FPM_CONF"
+sed -i 's/^pm.start_servers = .*/pm.start_servers = 4/' "$PHP_FPM_CONF"
+sed -i 's/^pm.min_spare_servers = .*/pm.min_spare_servers = 2/' "$PHP_FPM_CONF"
+sed -i 's/^pm.max_spare_servers = .*/pm.max_spare_servers = 8/' "$PHP_FPM_CONF"
+$STD systemctl restart php8.4-fpm
+msg_ok "Tuned PHP-FPM"
+
+msg_info "Configuring Nginx"
+cat <<'EOF' >/etc/nginx/sites-available/koel
+server {
+    listen 80;
+    server_name _;
+    root /opt/koel/public;
+    index index.php;
+
+    client_max_body_size 50M;
+    charset utf-8;
+
+    gzip on;
+    gzip_types text/plain text/css application/x-javascript text/xml application/xml application/xml+rss text/javascript application/json;
+    gzip_comp_level 9;
+
+    send_timeout 3600;
+
+    location / {
+        try_files $uri $uri/ /index.php?$args;
+    }
+
+    location /media/ {
+        internal;
+        alias $upstream_http_x_media_root;
+    }
+
+    location ~ \.php$ {
+        try_files $uri $uri/ /index.php?$args;
+        fastcgi_pass unix:/run/php/php8.4-fpm.sock;
+        fastcgi_index index.php;
+        fastcgi_split_path_info ^(.+\.php)(/.+)$;
+        fastcgi_intercept_errors on;
+        fastcgi_param PATH_INFO $fastcgi_path_info;
+        fastcgi_param PATH_TRANSLATED $document_root$fastcgi_path_info;
+        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+        include fastcgi_params;
+    }
+
+    location ~ /\.(?!well-known).* {
+        deny all;
+    }
+}
+EOF
+rm -f /etc/nginx/sites-enabled/default
+ln -sf /etc/nginx/sites-available/koel /etc/nginx/sites-enabled/koel
+$STD systemctl reload nginx
+msg_ok "Configured Nginx"
+
+msg_info "Setting up Cron Job"
+cat <<'EOF' >/etc/cron.d/koel
+0 * * * * www-data cd /opt/koel && /usr/bin/php artisan koel:scan >/dev/null 2>&1
+EOF
+chmod 644 /etc/cron.d/koel
+msg_ok "Set up Cron Job"
+
+motd_ssh
+customize
+cleanup_lxc

misc/build.func

@@ -445,9 +445,11 @@ base_settings() {
 # - Safe parser for KEY=VALUE lines from vars files
 # - Used by default_var_settings and app defaults loading
 # - Only loads whitelisted var_* keys
+# - Optional force parameter to override existing values (for app defaults)
 # ------------------------------------------------------------------------------
 load_vars_file() {
   local file="$1"
+  local force="${2:-no}" # If "yes", override existing variables
   [ -f "$file" ] || return 0
   msg_info "Loading defaults from ${file}"
 
@@ -485,8 +487,12 @@ load_vars_file() {
         var_val="${BASH_REMATCH[1]}"
       fi
 
-      # Set only if not already exported
-      [[ -z "${!var_key+x}" ]] && export "${var_key}=${var_val}"
+      # Set variable: force mode overrides existing, otherwise only set if empty
+      if [[ "$force" == "yes" ]]; then
+        export "${var_key}=${var_val}"
+      else
+        [[ -z "${!var_key+x}" ]] && export "${var_key}=${var_val}"
+      fi
     fi
   done <"$file"
   msg_ok "Loaded ${file}"
@@ -2148,8 +2154,8 @@ install_script() {
         header_info
         echo -e "${DEFAULT}${BOLD}${BL}Using App Defaults for ${APP} on node $PVEHOST_NAME${CL}"
         METHOD="appdefaults"
+        load_vars_file "$(get_app_defaults_path)" "yes" # Force override script defaults
         base_settings
-        load_vars_file "$(get_app_defaults_path)"
         echo_default
         defaults_target="$(get_app_defaults_path)"
         break

misc/core.func

@@ -828,7 +828,7 @@ cleanup_lxc() {
   # Ruby gem
   if command -v gem &>/dev/null; then $STD gem cleanup || true; fi
   # Composer (PHP)
-  if command -v composer &>/dev/null; then $STD composer clear-cache || true; fi
+  if command -v composer &>/dev/null; then COMPOSER_ALLOW_SUPERUSER=1 && $STD composer clear-cache || true; fi
 
   if command -v journalctl &>/dev/null; then
     $STD journalctl --vacuum-time=10m || true

misc/tools.func

@@ -1752,30 +1752,13 @@ function fetch_and_deploy_gh_release() {
 
   ### Tarball Mode ###
   if [[ "$mode" == "tarball" || "$mode" == "source" ]]; then
-    # Try multiple tarball URL formats for maximum compatibility
-    local tarball_urls=(
-      "https://github.com/$repo/archive/refs/tags/$tag_name.tar.gz"
-      "https://github.com/$repo/archive/$tag_name.tar.gz"
-    )
-    
-    # Also try API-provided tarball_url as fallback
-    local api_tarball_url=$(echo "$json" | jq -r '.tarball_url // empty')
-    [[ -n "$api_tarball_url" ]] && tarball_urls+=("$api_tarball_url")
-    
+    # GitHub API's tarball_url/zipball_url can return HTTP 300 Multiple Choices
+    # when a branch and tag share the same name. Use explicit refs/tags/ URL instead.
+    local direct_tarball_url="https://github.com/$repo/archive/refs/tags/$tag_name.tar.gz"
     filename="${app_lc}-${version}.tar.gz"
-    local download_success=false
 
-    for url in "${tarball_urls[@]}"; do
-      msg_debug "Attempting download from: $url"
-      if curl $download_timeout -fsSL -w "%{http_code}" -o "$tmpdir/$filename" "$url" 2>/dev/null | grep -q "^200$"; then
-        download_success=true
-        break
-      fi
-      rm -f "$tmpdir/$filename"
-    done
-
-    if ! $download_success; then
-      msg_error "Download failed from all tarball URLs for $repo $tag_name"
+    curl $download_timeout -fsSL -o "$tmpdir/$filename" "$direct_tarball_url" || {
+      msg_error "Download failed: $direct_tarball_url"
       rm -rf "$tmpdir"
       return 1
     }