USER_SUBMITTED_GUIDES.md

@@ -40,5 +40,3 @@
 [Proxmox Homelab Series](<https://blog.kye.dev/proxmox-series>)
 
 [The fastest installation of Docker and Portainer on Proxmox VE](https://lavr.site/en-fastest-install-docker-portainer-proxmox/)
-
-[How To Setup Proxmox Backuper Server Using Helper Scripts](<https://youtu.be/6C2JOsrZZZw?si=kkrrcL_nLCDBJkOB>)

ct/bunkerweb.sh

@@ -66,7 +66,7 @@ Pin: version ${RELEASE}
 Pin-Priority: 1001
 EOF
   apt-get update
-  apt-get install -y nginx=1.26.2*
+  apt-get install -y nginx=1.26.1*
   apt-get install -y bunkerweb=${RELEASE}
   echo "${RELEASE}" >/opt/${APP}_version.txt
   msg_ok "Updated ${APP} to ${RELEASE}"

ct/openwebui.sh

@@ -1,84 +0,0 @@
-#!/usr/bin/env bash
-source <(curl -s https://raw.githubusercontent.com/tteck/Proxmox/main/misc/build.func)
-# Copyright (c) 2021-2024 tteck
-# Author: tteck
-# Co-Author: havardthom
-# License: MIT
-# https://github.com/tteck/Proxmox/raw/main/LICENSE
-
-function header_info {
-clear
-cat <<"EOF"     
-   ____                      _       __     __    __  ______
-  / __ \____  ___  ____     | |     / /__  / /_  / / / /  _/
- / / / / __ \/ _ \/ __ \    | | /| / / _ \/ __ \/ / / // /
-/ /_/ / /_/ /  __/ / / /    | |/ |/ /  __/ /_/ / /_/ // /
-\____/ .___/\___/_/ /_/     |__/|__/\___/_.___/\____/___/
-    /_/
-
-EOF
-}
-header_info
-echo -e "Loading..."
-APP="Open WebUI"
-var_disk="16"
-var_cpu="4"
-var_ram="4096"
-var_os="debian"
-var_version="12"
-variables
-color
-catch_errors
-
-function default_settings() {
-  CT_TYPE="1"
-  PW=""
-  CT_ID=$NEXTID
-  HN=$NSAPP
-  DISK_SIZE="$var_disk"
-  CORE_COUNT="$var_cpu"
-  RAM_SIZE="$var_ram"
-  BRG="vmbr0"
-  NET="dhcp"
-  GATE=""
-  APT_CACHER=""
-  APT_CACHER_IP=""
-  DISABLEIP6="no"
-  MTU=""
-  SD=""
-  NS=""
-  MAC=""
-  VLAN=""
-  SSH="no"
-  VERB="no"
-  echo_default
-}
-
-function update_script() {
-header_info
-if [[ ! -d /opt/open-webui ]]; then msg_error "No ${APP} Installation Found!"; exit; fi
-msg_info "Updating ${APP} (Patience)"
-cd /opt/open-webui
-output=$(git pull --no-rebase)
-if echo "$output" | grep -q "Already up to date."
-then
-  msg_ok "$APP is already up to date."
-  exit
-fi
-systemctl stop open-webui.service
-npm install &>/dev/null
-npm run build &>/dev/null
-cd ./backend
-pip install -r requirements.txt -U &>/dev/null
-systemctl start open-webui.service
-msg_ok "Updated Successfully"
-exit
-}
-
-start
-build_container
-description
-
-msg_ok "Completed Successfully!\n"
-echo -e "${APP} should be reachable by going to the following URL.
-         ${BL}http://${IP}:8080${CL} \n"

ct/peanut.sh

@@ -68,8 +68,6 @@ function update_script() {
     pnpm i &>/dev/null
     pnpm run build &>/dev/null
     cp -r .next/static .next/standalone/.next/
-    mkdir -p /opt/peanut/.next/standalone/config
-    ln -sf /etc/peanut/settings.yml /opt/peanut/.next/standalone/config/settings.yml
     systemctl start peanut
     echo "${RELEASE}" >/opt/${APP}_version.txt
     msg_ok "Updated $APP to ${RELEASE}"

ct/vaultwarden.sh

@@ -57,7 +57,7 @@ function update_script() {
     msg_error "No ${APP} Installation Found!"
     exit
   fi
- 
+  whiptail --backtitle "Proxmox VE Helper Scripts" --msgbox --title "SET RESOURCES" "Please set the resources in your ${APP} LXC to ${var_cpu}vCPU and ${var_ram}RAM for the build process before continuing" 10 75
   VAULT=$(curl -s https://api.github.com/repos/dani-garcia/vaultwarden/releases/latest |
     grep "tag_name" |
     awk '{print substr($2, 2, length($2)-3) }')
@@ -73,7 +73,7 @@ function update_script() {
 
   header_info
   if [ "$UPD" == "1" ]; then
-    whiptail --backtitle "Proxmox VE Helper Scripts" --msgbox --title "SET RESOURCES" "Please set the resources in your ${APP} LXC to ${var_cpu}vCPU and ${var_ram}RAM for the build process before continuing" 10 75
+    echo -e "\n ⚠️  Ensure you set 4vCPU & 4096MiB RAM minimum!!! \n"
     msg_info "Stopping Vaultwarden"
     systemctl stop vaultwarden.service
     msg_ok "Stopped Vaultwarden"

install/bunkerweb-install.sh

@@ -26,7 +26,7 @@ msg_info "Installing Nginx"
 wget -qO- https://nginx.org/keys/nginx_signing.key | gpg --dearmor >/usr/share/keyrings/nginx-archive-keyring.gpg
 echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] http://nginx.org/packages/debian $(lsb_release -cs) nginx" >/etc/apt/sources.list.d/nginx.list
 $STD apt-get update
-$STD apt-get install -y nginx=1.26.2*
+$STD apt-get install -y nginx=1.26.1*
 msg_ok "Installed Nginx"
 
 RELEASE=$(curl -s https://api.github.com/repos/bunkerity/bunkerweb/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')

install/ghostfolio-install.sh

@@ -14,33 +14,21 @@ setting_up_container
 network_check
 update_os
 
+## Following Ghostfolio's Dockerfile and docker-compose for versions/steps, but installing all postgres/redis on the same host
+#   - https://github.com/ghostfolio/ghostfolio/blob/main/Dockerfile
+#   - https://github.com/ghostfolio/ghostfolio/blob/main/docker/docker-compose.yml
+
 msg_info "Installing Dependencies"
 $STD apt-get update
 $STD apt-get install -y \
     curl \
     lsb-release \
-    gpg \
+    gpg
-    g++ \
-    git \
-    make \
-    openssl \
-    python3 \
-    postgresql-15 \
-    redis
 msg_ok "Installed Dependencies"
 
-msg_info "Setting up Node.js Repository"
+# POSTGRES =================================
-mkdir -p /etc/apt/keyrings
+msg_info "Setting up Postgresql"
-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_20.x nodistro main" >/etc/apt/sources.list.d/nodesource.list
-msg_ok "Set up Node.js Repository"
 
-msg_info "Installing Node.js"
-$STD apt-get update
-$STD apt-get install -y --no-install-suggests nodejs
-msg_info "Installed Node.js"
-
-msg_info "Installing Postgresql"
 POSTGRES_HOST=localhost
 POSTGRES_PORT=5432
 POSTGRES_DB=ghostfolio-db
@@ -50,6 +38,9 @@ ACCESS_TOKEN_SALT="$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 32)"
 DATABASE_URL="postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}?connect_timeout=300&sslmode=prefer"
 JWT_SECRET_KEY="$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 32)"
 
+$STD apt-get install -y postgresql-15
+
+# Setup postgres
 $STD su postgres <<EOSU
 psql -c "create database \"$POSTGRES_DB\";"
 psql -c "ALTER DATABASE \"$POSTGRES_DB\" OWNER TO \"$POSTGRES_USER\";"
@@ -57,59 +48,111 @@ psql -c "GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO \"$POSTGRES_USER
 psql -c "ALTER USER \"$POSTGRES_USER\" WITH PASSWORD '$POSTGRES_PASSWORD';"
 EOSU
 
+# Make sure postgres is working/reachable
+$STD pg_isready -d "$POSTGRES_DB" -U "$POSTGRES_USER"
+$STD psql -d "$DATABASE_URL" -c "select now()"
+
+# Store creds
 echo "" >~/ghostfolio.creds
 echo "Ghostfolio Database Credentials" >>~/ghostfolio.creds
 echo "" >>~/ghostfolio.creds
 echo -e "Ghostfolio Database User: \e[32m$POSTGRES_USER\e[0m" >>~/ghostfolio.creds
 echo -e "Ghostfolio Database Password: \e[32m$POSTGRES_PASSWORD\e[0m" >>~/ghostfolio.creds
 echo -e "Ghostfolio Database Name: \e[32m$POSTGRES_DB\e[0m" >>~/ghostfolio.creds
-msg_ok "Installed Postgresql"
+msg_ok "Set up Postgresql"
+#-- END POSTGRES
 
-msg_info "Installing Redis"
+# REDIS CACHE =================================
+msg_info "Setting up Redis"
 REDIS_HOST=localhost
 REDIS_PORT=6379
 REDIS_PASSWORD="$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 32)"
 
+$STD apt-get install -y redis
+
+## Configure Redis
 $STD redis-cli CONFIG SET requirepass "$REDIS_PASSWORD"
 $STD redis-cli  -a "$REDIS_PASSWORD" CONFIG REWRITE
 $STD systemctl restart redis
+
+# Test Redis with password auth
+$STD redis-cli -a "$REDIS_PASSWORD" ping
+
 echo "" >>~/ghostfolio.creds
 echo "Ghostfolio Redis Credentials" >>~/ghostfolio.creds
 echo "" >>~/ghostfolio.creds
 echo -e "Ghostfolio Redis Password: \e[32m$REDIS_PASSWORD\e[0m" >>~/ghostfolio.creds
-msg_ok "Installed Redis"
 
-msg_info "Installing Ghostfolio (Patience)"
+msg_ok "Set up Redis"
-RELEASE=$(curl -sL https://api.github.com/repos/ghostfolio/ghostfolio/releases/latest | grep '"tag_name":' | cut -d'"' -f4)
+#-- END REDIS CACHE
-echo "${RELEASE}" >/opt/${APPLICATION}_version.txt
+
+# GHOSTFOLIO  =================================
+msg_info "Set up Ghostfolio"
+## Setup Vars
+## default node to 20 (current required version, but determine from nvmrc later)
+NODE_VERSION=20
+GHOSTFOLIO_VERSION='latest' # tested with 2.117.0
 
 cd /opt/
-$STD curl -Ls -o ghostfolio-$RELEASE.tgz https://github.com/ghostfolio/ghostfolio/archive/refs/tags/$RELEASE.tar.gz
-$STD tar xzf ghostfolio-$RELEASE.tgz
-$STD rm ghostfolio-$RELEASE.tgz
 
-cp /opt/ghostfolio-$RELEASE/package.json /opt/package.json
+$STD apt-get install -y --no-install-suggests \
-cp /opt/ghostfolio-$RELEASE/package-lock.json /opt/package-lock.json
+  g++ \
+  git \
+  make \
+  openssl \
+  python3
 
-cd /opt/ghostfolio-$RELEASE
+if [[ "$GHOSTFOLIO_VERSION" == "latest" ]]; then
+  GHOSTFOLIO_VERSION=$(curl -sL https://api.github.com/repos/ghostfolio/ghostfolio/releases/latest | grep '"tag_name":' | cut -d'"' -f4)
+fi
+
+# Get the realease
+$STD curl -Ls -o ghostfolio-$GHOSTFOLIO_VERSION.tgz https://github.com/ghostfolio/ghostfolio/archive/refs/tags/$GHOSTFOLIO_VERSION.tar.gz
+$STD tar xzf ghostfolio-$GHOSTFOLIO_VERSION.tgz
+$STD rm ghostfolio-$GHOSTFOLIO_VERSION.tgz
+
+cd /opt/ghostfolio-$GHOSTFOLIO_VERSION
+
+# Stash these so we have clean versions later
+cp /opt/ghostfolio-$GHOSTFOLIO_VERSION/package.json /opt/package.json.bak
+cp /opt/ghostfolio-$GHOSTFOLIO_VERSION/package-lock.json /opt/package-lock.json.bak
+
+# Get node version and install node
+test -f .nvmrc && NODE_VERSION=$(sed 's/^v\([0-9]*\)[.]*.*/\1/g' .nvmrc) # get first digits after an v, excluding potential .minor.patch versions
+$STD curl -fsSL https://deb.nodesource.com/setup_$NODE_VERSION.x -o nodesource_setup.sh
+$STD bash nodesource_setup.sh
+rm nodesource_setup.sh
+$STD apt-get update
+$STD apt-get install -y --no-install-suggests nodejs
+
+# Build the project
 $STD npm install
 $STD npm run build:production
-mv /opt/package-lock.json /opt/ghostfolio-$RELEASE/package-lock.json
 
-cd /opt/ghostfolio-$RELEASE/dist/apps/api/
+# package.json was generated by the build process, however the original package-lock.json needs to be used to ensure the same versions
+mv /opt/package-lock.json.bak /opt/ghostfolio-$GHOSTFOLIO_VERSION/package-lock.json
+
+cd /opt/ghostfolio-$GHOSTFOLIO_VERSION/dist/apps/api/
 $STD npm install
-cp -r /opt/ghostfolio-$RELEASE/prisma .
+cp -r /opt/ghostfolio-$GHOSTFOLIO_VERSION/prisma .
-mv /opt/package.json /opt/ghostfolio-$RELEASE/dist/apps/api/package.json
+
+# Overwrite the generated package.json with the original one to ensure having all the scripts
+mv /opt/package.json.bak /opt/ghostfolio-$GHOSTFOLIO_VERSION/dist/apps/api/package.json
 $STD npm run database:generate-typings
 
+# Move the built project to /opt/ghostfolio
 cd /opt
-mv /opt/ghostfolio-$RELEASE/dist/apps /opt/ghostfolio
+mv /opt/ghostfolio-$GHOSTFOLIO_VERSION/dist/apps /opt/ghostfolio
-mv /opt/ghostfolio-$RELEASE/docker/entrypoint.sh /opt/ghostfolio/
+mv /opt/ghostfolio-$GHOSTFOLIO_VERSION/docker/entrypoint.sh /opt/ghostfolio/
 
-rm -rf /opt/ghostfolio-$RELEASE
+rm -rf /opt/ghostfolio-$GHOSTFOLIO_VERSION
-msg_ok "Installed Ghostfolio"
+msg_ok "Set up Ghostfolio"
+# --- END GHOSTFOLIO
 
-msg_info "Creating Service"
+# SERVICE  =================================
+msg_info "Creating Startup Scripts"
+# Create env file
+msg_info "Creating Environment File"
 cat <<EOF >/opt/ghostfolio/api/.env
 # CACHE
 REDIS_HOST=$REDIS_HOST
@@ -127,6 +170,7 @@ DATABASE_URL="$DATABASE_URL"
 JWT_SECRET_KEY=$JWT_SECRET_KEY
 EOF
 
+# Create startup script
 cat <<EOF >/opt/ghostfolio/start.sh
 #!/bin/bash
 # Source the environment vars and export them otherwise it wont get them properly
@@ -140,7 +184,8 @@ EOF
 
 chmod +x /opt/ghostfolio/start.sh
 
-msg_info "Setup Service"
+msg_info "Creating Systemd Service Definition"
+# Create Systemd Service
 cat <<EOF >/etc/systemd/system/ghostfolio.service
 [Unit]
 Description=ghostfolio
@@ -166,14 +211,11 @@ SyslogIdentifier=ghostfolio
 WantedBy=multi-user.target
 EOF
 
+# Make the service run on container startup
 systemctl enable ghostfolio
 systemctl start ghostfolio
-msg_ok "Created Service"
+msg_ok "Created Startup Scripts"
+# -- END SERVICE
 
 motd_ssh
 customize
-
-msg_info "Cleaning up"
-$STD apt-get -y autoremove
-$STD apt-get -y autoclean
-msg_ok "Cleaned"

install/openwebui-install.sh

@@ -1,81 +0,0 @@
-#!/usr/bin/env bash
-
-# Copyright (c) 2021-2024 tteck
-# Author: tteck
-# Co-Author: havardthom
-# License: MIT
-# https://github.com/tteck/Proxmox/raw/main/LICENSE
-
-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 curl
-$STD apt-get install -y sudo
-$STD apt-get install -y mc
-$STD apt-get install -y gpg
-$STD apt-get install -y git
-msg_ok "Installed Dependencies"
-
-msg_info "Installing Python3 Dependencies"
-$STD apt-get install -y --no-install-recommends \
-  python3 \
-  python3-pip
-msg_ok "Installed Python3 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_20.x nodistro main" >/etc/apt/sources.list.d/nodesource.list
-msg_ok "Set up Node.js Repository"
-
-msg_info "Installing Node.js"
-$STD apt-get update
-$STD apt-get install -y nodejs
-msg_ok "Installed Node.js"
-
-msg_info "Installing Open WebUI (Patience)"
-$STD git clone https://github.com/open-webui/open-webui.git /opt/open-webui
-cd /opt/open-webui/backend
-$STD pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu
-$STD pip3 install -r requirements.txt -U
-cd /opt/open-webui
-cp .env.example .env
-cat <<EOF >/opt/open-webui/.env
-ENV=prod
-ENABLE_OLLAMA_API=false
-EOF
-$STD npm install
-$STD npm run build
-msg_ok "Installed Open WebUI"
-
-msg_info "Creating Service"
-cat <<EOF >/etc/systemd/system/open-webui.service
-[Unit]
-Description=Open WebUI Service
-After=network.target
-
-[Service]
-Type=exec
-WorkingDirectory=/opt/open-webui
-EnvironmentFile=/opt/open-webui/.env
-ExecStart=/opt/open-webui/backend/start.sh
-
-[Install]
-WantedBy=multi-user.target
-EOF
-systemctl enable -q --now open-webui.service
-msg_ok "Created Service"
-
-motd_ssh
-customize
-
-msg_info "Cleaning up"
-$STD apt-get -y autoremove
-$STD apt-get -y autoclean
-msg_ok "Cleaned"

install/peanut-install.sh

@@ -44,15 +44,6 @@ $STD npm install -g pnpm
 $STD pnpm i
 $STD pnpm run build
 cp -r .next/static .next/standalone/.next/
-mkdir -p /opt/peanut/.next/standalone/config
-mkdir -p /etc/peanut/
-cat <<EOF >/etc/peanut/settings.yml
-WEB_HOST: 0.0.0.0
-WEB_PORT: 3000
-NUT_HOST: 0.0.0.0
-NUT_PORT: 3493
-EOF
-ln -sf /etc/peanut/settings.yml /opt/peanut/.next/standalone/config/settings.yml
 msg_ok "Installed Peanut"
 
 msg_info "Creating Service"
@@ -66,10 +57,10 @@ Restart=always
 RestartSec=5
 Type=simple
 Environment="NODE_ENV=production"
-#Environment="NUT_HOST=localhost"
+Environment="NUT_HOST=localhost"
-#Environment="NUT_PORT=3493"
+Environment="NUT_PORT=3493"
-#Environment="WEB_HOST=0.0.0.0"
+Environment="WEB_HOST=0.0.0.0"
-#Environment="WEB_PORT=3000"
+Environment="WEB_PORT=3000"
 WorkingDirectory=/opt/peanut
 ExecStart=node /opt/peanut/.next/standalone/server.js
 TimeoutStopSec=30
@@ -85,4 +76,4 @@ customize
 msg_info "Cleaning up"
 $STD apt-get -y autoremove
 $STD apt-get -y autoclean
-msg_ok "Cleaned"
+msg_ok "Cleaned"