Merge 250ffddee7 into ca902c50fb

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

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -5,44 +5,64 @@ body:
   - type: markdown
     attributes:
       value: |
-        **IMPORTANT:** Failure to comply with the following guidelines may result in immediate closure.
+        # 🐞 **Script Issue Report**
-        - Prior to submitting, kindly search the closed issues to check if the problem you are reporting has already been addressed and resolved. If you come across a closed issue that pertains to your problem, please leave a comment on that issue instead of creating a new one.
+        Thank you for taking the time to report an issue! Please provide as much detail as possible to help us address the problem efficiently.  
-        - If the default Linux distribution is not adhered to, script support will be discontinued.
+
-        - When encountering the error message `[ERROR] in line 23: exit code *: while executing command "$@" > /dev/null 2>&1`, make sure to run the script in verbose mode to accurately determine the underlying issue.
+        ## ⚠️ **IMPORTANT**  
-        - For suggestions, questions, or feature/script requests, please use the [Discussions section.](https://github.com/community-scripts/ProxmoxVE/discussions)
+        - 🔍 **Search first:** Before submitting, check if the issue has already been reported or resolved in [closed issues](https://github.com/community-scripts/ProxmoxVE/issues?q=is%3Aissue+is%3Aclosed). If found, comment on that issue instead of creating a new one.  
+        Alternatively, check the **[Discussions](https://github.com/community-scripts/ProxmoxVE/discussions)** under the *"Announcement"* or *"Guide"* categories for relevant information.  
+        - 🛠️ **Supported environments only:** Ensure you are using a default Linux distribution. Custom setups may not be supported.  
+        - 🔎 If you encounter `[ERROR] in line 23: exit code *: while executing command "$@" > /dev/null 2>&1`, rerun the script with verbose mode before submitting the issue.  
+        - 💡 For general questions, feature requests, or suggestions, use the [Discussions section](https://github.com/community-scripts/ProxmoxVE/discussions).  
 
   - type: input
     id: guidelines
     attributes:
-      label: Please verify that you have read and understood the guidelines.
+      label: ✅ Have you read and understood the above guidelines?
       placeholder: "yes"
     validations:
       required: true
 
-  - type: textarea
+  - type: input
-    id: bug
+    id: script_name
     attributes:
-      label: A clear and concise description of the issue.
+      label: 📜 What is the name of the script you are using?
+      placeholder: "e.g., NextcloudPi, Zigbee2MQTT"
     validations:
       required: true
-      
+
+  - type: input
+    id: script_command
+    attributes:
+      label: 📂 What was the exact command used to execute the script?
+      placeholder: "e.g., bash -c \"$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/ct/zigbee2mqtt.sh)\" or \"update\""
+    validations:
+      required: true
+
+  - type: textarea
+    id: issue_description
+    attributes:
+      label: 📝 Provide a clear and concise description of the issue.
+    validations:
+      required: true
+
   - type: checkboxes
     validations:
       required: true
     attributes:
-      label: What settings are you currently utilizing?
+      label: ⚙️ What settings are you using?
       options:
         - label: Default Settings
         - label: Advanced Settings
 
   - type: markdown
     attributes:
-      value: "If using Advanced Settings, please try Default Settings before creating an issue."
+      value: "💡 **Tip:** If you are using Advanced Settings, please test with Default Settings before submitting an issue."
 
   - type: dropdown
-    id: distribution
+    id: linux_distribution
     attributes:
-      label: Which Linux distribution are you employing?
+      label: 🖥️ Which Linux distribution are you using?
       options:
         - 
         - Alpine
@@ -51,21 +71,30 @@ body:
         - Ubuntu 20.04
         - Ubuntu 22.04
         - Ubuntu 24.04
+        - Ubuntu 24.10
     validations:
       required: true
 
   - type: textarea
-    id: screenshot
+    id: steps_to_reproduce
     attributes:
-      label: If relevant, including screenshots or a code block can be helpful in clarifying the issue.
+      label: 🔄 Steps to reproduce the issue.
-      placeholder: "Code blocks begin and conclude by enclosing the code with three backticks (```) above and below it."
+      placeholder: "e.g., Step 1: ..., Step 2: ..."
     validations:
-      required: false
+      required: true
 
   - type: textarea
-    id: reproduce
+    id: error_output
     attributes:
-      label: Please provide detailed steps to reproduce the issue.
+      label: ❌ Paste the full error output (if available).
-      placeholder: "First do this, then this ..."
+      placeholder: "Include any relevant logs or error messages."
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional_context
+    attributes:
+      label: 🖼️ Additional context (optional).
+      placeholder: "Include screenshots, code blocks (use triple backticks ```), or any other relevant information."
     validations:
       required: false

.github/pull_request_template.md

@@ -1,31 +1,39 @@
-> [!NOTE]
+> **🛠️ Note:**  
-> We are meticulous when it comes to merging code into the main branch, so please understand that we may reject pull requests that do not meet the project's standards. It's never personal. Also, game-related scripts have a lower chance of being merged.
+> We are meticulous about merging code into the main branch, so please understand that pull requests not meeting the project's standards may be rejected. It's never personal!  
+> 🎮 **Note for game-related scripts:** These have a lower likelihood of being merged.
 
-## Description
+---
 
+## ✍️ Description
 Provide a summary of the changes made and/or reference the issue being addressed.
 
-Fixes # (issue)
+- 
 
-## Type of change
+- - -
-Please check the relevant option(s):
 
-- [ ] Bug fix (non-breaking change that resolves an issue)
+- Related Issue: # (issue number, if applicable)  
-- [ ] New feature (non-breaking change that adds functionality)
+- Related PR: # (if applicable)  
-- [ ] Breaking change (a fix or feature that would cause existing functionality to change unexpectedly)
+- Related Discussion: [Link](https://github.com/community-scripts/ProxmoxVE/discussions)  
-- [ ] New script (a fully functional and thoroughly tested script or set of scripts.)
 
-## Prerequisites
+---
-The following efforts must be made for the PR to be considered. Please check when completed:
+
-- [ ] Self-review performed (I have reviewed my code, ensuring it follows established patterns and conventions)
+## 🛠️ Type of Change
-- [ ] Testing performed (I have tested my changes, ensuring everything works as expected)
+Please check the relevant options:  
+- [ ] Bug fix (non-breaking change that resolves an issue)  
+- [ ] New feature (non-breaking change that adds functionality)  
+- [ ] Breaking change (fix or feature that would cause existing functionality to change unexpectedly)  
+- [ ] New script (a fully functional and thoroughly tested script or set of scripts)  
+
+---
+
+## ✅ Prerequisites
+The following steps must be completed for the pull request to be considered:  
+- [ ] Self-review performed (I have reviewed my code to ensure it follows established patterns and conventions.)  
+- [ ] Testing performed (I have thoroughly tested my changes and verified expected functionality.)  
 - [ ] Documentation updated (I have updated any relevant documentation)
 
-## Additional Information (optional)
+---
-Provide any additional context or screenshots about the feature or fix here.
 
+## 📋 Additional Information (optional)
+Provide any extra context or screenshots about the feature or fix here.  
 
-## Related Pull Requests / Discussions
-
-If there are other pull requests or discussions related to this change, please link them here:
-- Related PR #

CHANGELOG.md

@@ -22,8 +22,18 @@ Do not break established syntax in this file, as it is automatically updated by
 
 ### 🚀 Updated Scripts
 
+- Fix Keycloak Update Function [@MickLesk](https://github.com/MickLesk) ([#762](https://github.com/community-scripts/ProxmoxVE/pull/762))
 - Fix config bug in Alpine Vaultwarden [@havardthom](https://github.com/havardthom) ([#775](https://github.com/community-scripts/ProxmoxVE/pull/775))
 
+### 🌐 Website
+
+- Update some JSON Files for Website [@MickLesk](https://github.com/MickLesk) ([#812](https://github.com/community-scripts/ProxmoxVE/pull/812))
+- Update Notes & Documentation for Proxmox Backup Server [@MickLesk](https://github.com/MickLesk) ([#804](https://github.com/community-scripts/ProxmoxVE/pull/804))
+
+### 🧰 Maintenance
+
+- Github: Optimize Issue Template & PR Template [@MickLesk](https://github.com/MickLesk) ([#802](https://github.com/community-scripts/ProxmoxVE/pull/802))
+
 ## 2024-12-12
 
 ### Changed

ct/authentik.sh

@@ -0,0 +1,108 @@
+#!/usr/bin/env bash
+source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# Copyright (c) 2021-2024 community-scripts ORG
+# Author: remz1337
+# License: MIT
+# https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+
+function header_info {
+  clear
+  cat <<"EOF"
+    ___         __  __               __  _ __  
+   /   | __  __/ /_/ /_  ___  ____  / /_(_) /__
+  / /| |/ / / / __/ __ \/ _ \/ __ \/ __/ / //_/
+ / ___ / /_/ / /_/ / / /  __/ / / / /_/ / ,<   
+/_/  |_\__,_/\__/_/ /_/\___/_/ /_/\__/_/_/|_|  
+                                               
+EOF
+}
+header_info
+echo -e "Loading..."
+APP="authentik"
+var_disk="15"
+var_cpu="6"
+var_ram="8192"
+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
+check_container_storage
+check_container_resources
+if [[ ! -f /etc/systemd/system/authentik-server.service ]]; then msg_error "No ${APP} Installation Found!"; exit; fi
+RELEASE=$(curl -s https://api.github.com/repos/goauthentik/authentik/releases/latest | grep "tarball_url" | awk '{print substr($2, 2, length($2)-3)}')
+if [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]] || [[ ! -f /opt/${APP}_version.txt ]]; then
+  msg_info "Stopping ${APP}"
+  systemctl stop authentik-server
+  systemctl stop authentik-worker
+  msg_ok "Stopped ${APP}"
+
+  msg_info "Building ${APP} website"
+  mkdir -p /opt/authentik
+  wget -qO authentik.tar.gz "${RELEASE}"
+  tar -xzf authentik.tar.gz -C /opt/authentik --strip-components 1 --overwrite
+  rm -rf authentik.tar.gz
+  cd /opt/authentik/website
+  npm install &>/dev/null
+  npm run build-bundled &>/dev/null
+  cd /opt/authentik/web
+  npm install &>/dev/null
+  npm run build &>/dev/null
+  msg_ok "Built ${APP} website"
+
+  msg_info "Installing Python Dependencies"
+  cd /opt/authentik
+  poetry install --only=main --no-ansi --no-interaction --no-root &>/dev/null
+  poetry export --without-hashes --without-urls -f requirements.txt --output requirements.txt &>/dev/null
+  pip install --no-cache-dir -r requirements.txt &>/dev/null
+  pip install . &>/dev/null
+  msg_ok "Installed Python Dependencies"
+
+  msg_info "Updating ${APP} to v${RELEASE} (Patience)" 
+  cp -r /opt/authentik/authentik/blueprints /opt/authentik/blueprints
+  bash /opt/authentik/lifecycle/ak migrate &>/dev/null
+  echo "${RELEASE}" >/opt/${APP}_version.txt
+  msg_ok "Updated ${APP} to v${RELEASE}"
+
+  msg_info "Starting ${APP}"
+  systemctl start authentik-server
+  systemctl start authentik-worker
+  msg_ok "Started ${APP}"
+else
+  msg_ok "No update required. ${APP} is already at v${RELEASE}"
+fi
+exit
+}
+
+start
+build_container
+description
+
+msg_ok "Completed Successfully!\n"

ct/keycloak.sh

@@ -65,18 +65,14 @@ apt-get update &>/dev/null
 apt-get -y upgrade &>/dev/null
 
 RELEASE=$(curl -s https://api.github.com/repos/keycloak/keycloak/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }')
-msg_info "Downloading Keycloak v$RELEASE"
+msg_info "Updating Keycloak to v$RELEASE"
 cd /opt
 wget -q https://github.com/keycloak/keycloak/releases/download/$RELEASE/keycloak-$RELEASE.tar.gz
-$STD tar -xvf keycloak-$RELEASE.tar.gz
-
-msg_info "Merging configuration files"
-cp -r keycloak/conf keycloak-$RELEASE
-cp -r keycloak/providers keycloak-$RELEASE
-cp -r keycloak/themes keycloak-$RELEASE
-
-msg_info "Updating Keycloak"
 mv keycloak keycloak.old
+tar -xzf keycloak-$RELEASE.tar.gz
+cp -r keycloak.old/conf keycloak-$RELEASE
+cp -r keycloak.old/providers keycloak-$RELEASE
+cp -r keycloak.old/themes keycloak-$RELEASE
 mv keycloak-$RELEASE keycloak
 
 msg_info "Delete temporary installation files"

frontend/src/components/CommandMenu.tsx

@@ -26,7 +26,7 @@ export const formattedBadge = (type: string) => {
         <Badge className="text-yellow-500/75 border-yellow-500/75">LXC</Badge>
       );
     case "misc":
-      return <Badge className="text-red-500/75 border-red-500/75">MISC</Badge>;
+      return <Badge className="text-green-500/75 border-green-500/75">MISC</Badge>;
   }
   return null;
 };

install/authentik-install.sh

@@ -0,0 +1,193 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2024 community-scripts ORG
+# Author: tteck (tteckster)
+# Co-Author: remz1337
+# License: MIT
+# https://github.com/community-scripts/ProxmoxVE/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 (Patience)"
+$STD apt-get install -y \
+  curl \
+  sudo \
+  mc \
+  gpg \
+  pkg-config \
+  libffi-dev \
+  build-essential \
+  libpq-dev \
+  libkrb5-dev \
+  libssl-dev \
+  libsqlite3-dev \
+  tk-dev \
+  libgdbm-dev \
+  libc6-dev \
+  libbz2-dev \
+  zlib1g-dev \
+  libxmlsec1 \
+  libxmlsec1-dev \
+  libxmlsec1-openssl \
+  libmaxminddb0 \
+  python3-pip \
+  git
+msg_ok "Installed Dependencies"
+
+msg_info "Installing yq"
+YQ_LATEST="$(wget -qO- "https://api.github.com/repos/mikefarah/yq/releases/latest" | grep -Po '"tag_name": "\K.*?(?=")')"
+$STD wget "https://github.com/mikefarah/yq/releases/download/${YQ_LATEST}/yq_linux_amd64" -qO /usr/bin/yq
+chmod +x /usr/bin/yq
+msg_ok "Installed yq"
+
+msg_info "Installing GeoIP"
+GEOIP_RELEASE=$(curl -s https://api.github.com/repos/maxmind/geoipupdate/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
+wget -qO geoipupdate.deb https://github.com/maxmind/geoipupdate/releases/download/v${GEOIP_RELEASE}/geoipupdate_${GEOIP_RELEASE}_linux_amd64.deb
+$STD dpkg -i geoipupdate.deb
+cat <<EOF >/etc/GeoIP.conf
+#GEOIPUPDATE_EDITION_IDS="GeoLite2-City GeoLite2-ASN"
+#GEOIPUPDATE_VERBOSE="1"
+#GEOIPUPDATE_ACCOUNT_ID_FILE="/run/secrets/GEOIPUPDATE_ACCOUNT_ID"
+#GEOIPUPDATE_LICENSE_KEY_FILE="/run/secrets/GEOIPUPDATE_LICENSE_KEY"
+EOF
+msg_ok "Installed GeoIP"
+
+msg_info "Setting up Python 3"
+wget -q https://www.python.org/ftp/python/3.12.1/Python-3.12.1.tgz -O Python.tgz
+tar -zxf Python.tgz
+cd Python-3.12.1
+$STD ./configure --enable-optimizations
+$STD make altinstall
+cd ~
+$STD update-alternatives --install /usr/bin/python3 python3 /usr/local/bin/python3.12 1
+msg_ok "Setup Python 3"
+
+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"
+$STD apt-get update
+$STD apt-get install -y nodejs
+msg_ok "Installed Node.js"
+
+msg_info "Installing Golang"
+set +o pipefail
+GO_RELEASE=$(curl -s https://go.dev/dl/ | grep -o -m 1 "go.*\linux-amd64.tar.gz")
+wget -q https://golang.org/dl/${GO_RELEASE}
+tar -xzf ${GO_RELEASE} -C /usr/local
+ln -s /usr/local/go/bin/go /usr/bin/go
+set -o pipefail
+msg_ok "Installed Golang"
+
+msg_info "Installing Redis"
+$STD apt-get install -y redis-server
+systemctl enable -q --now redis-server
+msg_ok "Installed Redis"
+
+msg_info "Installing PostgreSQL"
+$STD apt-get install -y postgresql postgresql-contrib
+DB_NAME="authentik"
+DB_USER="authentik"
+DB_PASS="$(openssl rand -base64 18 | cut -c1-13)"
+$STD sudo -u postgres psql -c "CREATE DATABASE $DB_NAME;"
+$STD sudo -u postgres psql -c "CREATE USER $DB_USER WITH PASSWORD '$DB_PASS';"
+$STD sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE $DB_NAME TO $DB_USER;" 
+$STD sudo -u postgres psql -c "ALTER DATABASE $DB_NAME OWNER TO $DB_USER;"
+$STD sudo -u postgres psql -c "ALTER USER $DB_USER WITH SUPERUSER;"
+msg_ok "Installed PostgreSQL"
+
+msg_info "Installing authentik"
+RELEASE=$(curl -s https://api.github.com/repos/goauthentik/authentik/releases/latest | grep "tarball_url" | awk '{print substr($2, 2, length($2)-3)}')
+mkdir -p /opt/authentik
+wget -qO authentik.tar.gz "${RELEASE}"
+tar -xzf authentik.tar.gz -C /opt/authentik --strip-components 1 --overwrite
+cd /opt/authentik/website
+$STD npm install
+$STD npm run build-bundled
+cd /opt/authentik/web
+$STD npm install
+$STD npm run build
+echo "${RELEASE}" >/opt/${APPLICATION}_version.txt
+cd /opt/authentik
+$STD go mod download
+$STD go build -o /go/authentik ./cmd/server
+$STD go build -o /opt/authentik/authentik-server /opt/authentik/cmd/server/
+cd /opt/authentik
+$STD pip3 install --upgrade pip
+$STD pip3 install poetry poetry-plugin-export
+ln -s /usr/local/bin/poetry /usr/bin/poetry
+$STD poetry install --only=main --no-ansi --no-interaction --no-root
+$STD poetry export --without-hashes --without-urls -f requirements.txt --output requirements.txt
+$STD pip install --no-cache-dir -r requirements.txt
+$STD pip install .
+mkdir -p /etc/authentik
+mv /opt/authentik/authentik/lib/default.yml /etc/authentik/config.yml
+$STD yq -i ".secret_key = \"$(openssl rand -hex 32)\"" /etc/authentik/config.yml
+$STD yq -i ".postgresql.password = \"${DB_PASS}\"" /etc/authentik/config.yml
+$STD yq -i ".geoip = \"/opt/authentik/tests/GeoLite2-City-Test.mmdb\"" /etc/authentik/config.yml
+cp -r /opt/authentik/authentik/blueprints /opt/authentik/blueprints
+$STD yq -i ".blueprints_dir = \"/opt/authentik/blueprints\"" /etc/authentik/config.yml
+ln -s /usr/bin/python3 /usr/bin/python
+ln -s /usr/local/bin/gunicorn /usr/bin/gunicorn
+ln -s /usr/local/bin/celery /usr/bin/celery
+$STD bash /opt/authentik/lifecycle/ak migrate
+cd ~
+msg_ok "Installed authentik"
+
+msg_info "Creating Services"
+cat <<EOF >/etc/systemd/system/authentik-server.service
+[Unit]
+Description = authentik Server
+
+[Service]
+ExecStart=/opt/authentik/authentik-server
+WorkingDirectory=/opt/authentik/
+Restart=always
+RestartSec=5
+
+[Install]
+WantedBy=multi-user.target
+EOF
+
+cat <<EOF >/etc/systemd/system/authentik-worker.service
+[Unit]
+Description = authentik Worker
+
+[Service]
+Environment=DJANGO_SETTINGS_MODULE="authentik.root.settings"
+ExecStart=celery -A authentik.root.celery worker -Ofair --max-tasks-per-child=1 --autoscale 3,1 -E -B -s /tmp/celerybeat-schedule -Q authentik,authentik_scheduled,authentik_events
+WorkingDirectory=/opt/authentik/authentik
+Restart=always
+RestartSec=5
+
+[Install]
+WantedBy=multi-user.target
+EOF
+systemctl enable -q --now authentik-server
+sleep 2
+systemctl enable -q --now authentik-worker
+msg_ok "Created Services"
+
+motd_ssh
+customize
+
+msg_info "Cleaning up"
+rm -rf Python-3.12.1
+rm -rf Python.tgz
+rm -rf go/
+rm -rf ${GO_RELEASE}
+rm geoipupdate.deb
+rm -rf authentik.tar.gz
+$STD apt-get -y remove yq
+$STD apt-get -y autoremove
+$STD apt-get -y autoclean
+msg_ok "Cleaned"

json/actualbudget.json

@@ -9,7 +9,7 @@
     "updateable": true,
     "privileged": false,
     "interface_port": 5006,
-    "documentation": null,
+    "documentation": "https://github.com/community-scripts/ProxmoxVE/discussions/807",
     "website": "https://actualbudget.org/",
     "logo": "https://raw.githubusercontent.com/actualbudget/actual/master/packages/desktop-client/public/maskable-512x512.png",
     "description": "Actual Budget is a super fast and privacy-focused app for managing your finances. At its heart is the well proven and much loved Envelope Budgeting methodology.",

json/add-tailscale-lxc.json

@@ -33,11 +33,11 @@
     "notes": [
         {
             "text": "After the script finishes, reboot the LXC then run `tailscale up` in the LXC console",
-            "type": "warning"
+            "type": "info"
         },
         {
             "text": "Execute within the Proxmox shell",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/adguard.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Adguard Home can be updated via the user interface.",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/adventurelog.json

@@ -30,5 +30,10 @@
         "username": null,
         "password": null
     },
-    "notes": []
+    "notes": [
+        {
+            "text": "AdventureLog uses an initial local IP, if you change your LXC-IP, you need to change the IP here: `/opt/adventurelog/backend/server/.env` and here: `/opt/adventurelog/frontend/.env`",
+            "type": "warning"
+        }
+    ]
 }

json/all-templates.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Resource and network settings are adjustable post LXC creation.",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/alpine.json

@@ -30,5 +30,10 @@
         "username": null,
         "password": "alpine"
     },
-    "notes": []
+    "notes": [
+        {
+            "text": "To Update Alpine: `apk update && apk upgrade`",
+            "type": "info"
+        }
+    ]
 }

json/apache-cassandra.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Apache-Cassandra Configuration: `nano /etc/cassandra/cassandra.yaml`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/apache-couchdb.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Show Login Credentials: `cat CouchDB.creds`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/aria2.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Within the LXC console, run `cat rpc.secret` to display the rpc-secret. Copy this token and paste it into the Aria2 RPC Secret Token box within the AriaNG Settings. Then, click the reload AriaNG button.",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/audiobookshelf.json

@@ -9,7 +9,7 @@
     "updateable": false,
     "privileged": false,
     "interface_port": 13378,
-    "documentation": null,
+    "documentation": "https://www.audiobookshelf.org/guides/",
     "website": "https://www.audiobookshelf.org/",
     "logo": "https://raw.githubusercontent.com/loganmarchione/homelab-svg-assets/main/assets/audiobookshelf.svg",
     "description": "Audiobookshelf is a Self-hosted audiobook and podcast server.",

json/authentik.json

@@ -0,0 +1,39 @@
+{
+    "name": "authentik",
+    "slug": "authentik",
+    "categories": [
+        11
+    ],
+    "date_created": "2024-11-06",
+    "type": "ct",
+    "updateable": true,
+    "privileged": false,
+    "interface_port": 9000,
+    "documentation": "https://docs.goauthentik.io/docs/",
+    "website": "https://goauthentik.io/",
+    "logo": "https://github.com/goauthentik/authentik/blob/main/website/static/img/icon.png",
+    "description": "authentik is an IdP (Identity Provider) and SSO (single sign on) that is built with security at the forefront of every piece of code, every feature, with an emphasis on flexibility and versatility.",
+    "install_methods": [
+        {
+            "type": "default",
+            "script": "ct/authentik.sh",
+            "resources": {
+                "cpu": 6,
+                "ram": 8192,
+                "hdd": 12,
+                "os": "debian",
+                "version": "12"
+            }
+        }
+    ],
+    "default_credentials": {
+        "username": null,
+        "password": null
+    },
+    "notes": [
+        {
+            "text": "Initial configuration at http://<IP>:9000/if/flow/initial-setup/",
+            "type": "info"
+        }
+    ]
+}

json/autobrr.json

@@ -9,7 +9,7 @@
     "updateable": true,
     "privileged": false,
     "interface_port": 7474,
-    "documentation": null,
+    "documentation": "https://autobrr.com/configuration/autobrr",
     "website": "https://autobrr.com/",
     "logo": "https://raw.githubusercontent.com/autobrr/autobrr/master/.github/images/logo.png",
     "description": "Autobrr is a torrent downloading tool that automates the process of downloading torrents. It is designed to be modern and user-friendly, providing users with a convenient and efficient way to download torrent files. With Autobrr, you can schedule and manage your torrent downloads, and have the ability to automatically download torrents based on certain conditions, such as time of day or availability of seeds. This can save you time and effort, allowing you to focus on other tasks while your torrents are being downloaded in the background.",

json/blocky.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Blocky Configuration Path: `/opt/blocky/config.yml`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/calibre-web.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Add Calibre-Web Extras via `update`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/casaos.json

@@ -30,5 +30,10 @@
         "username": null,
         "password": null
     },
-    "notes": []
+    "notes": [
+        {
+            "text": "If the LXC is created Privileged, the script will automatically set up USB passthrough.",
+            "type": "warning"
+        }
+    ]
 }

json/clean-lxcs.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/cockpit.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Set a root password if using autologin. This will be the Cockpit password.`sudo passwd root`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/cron-update-lxcs.json

@@ -33,11 +33,11 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
-            "type": "warning"
+            "type": "info"
         },
         {
             "text": "To exclude LXCs from updating, edit the crontab using `crontab -e` and add CTID as shown in the example below:\n\n\n\n`0 0 * * 0 PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin /bin/bash -c '$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/misc/update-lxcs-cron.sh)' -s 103 111 >>/var/log/update-lxcs-cron.log 2>/dev/null`",
-            "type": "warning"
+            "type": "info"
         }
         
     ]

json/cronicle.json

@@ -32,12 +32,8 @@
     },
     "notes": [
         {
-            "text": "Primary and Worker Private Keys Must Match.",
+            "text": "Configuration Path: `/opt/cronicle/conf/config.json` (Primary and Worker Private Keys Must Match)",
-            "type": "warning"
+            "type": "info"
-        },
-        {
-            "text": "Configuration Path: `/opt/cronicle/conf/config.json`",
-            "type": "warning"
         }
     ]
 }

json/daemonsync.json

@@ -10,7 +10,7 @@
     "privileged": false,
     "interface_port": 8084,
     "documentation": null,
-    "website": null,
+    "website": "https://daemonsync.me/",
     "logo": "https://external-content.duckduckgo.com/iu/?u=https%3A%2F%2Fimg.informer.com%2Ficons_mac%2Fpng%2F128%2F350%2F350335.png&f=1&nofb=1",
     "description": "Sync files from app to server, share photos & videos, back up your data and stay secure inside local network.",
     "install_methods": [

json/dockge.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Options to add Immich and/or Home Assistant",
-            "type": "warning"
+            "type": "info"
         },
         {
             "text": "If the LXC is created Privileged, the script will automatically set up USB passthrough.",

json/emby.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "With Privileged/Unprivileged Hardware Acceleration Support",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/emqx.json

@@ -30,5 +30,10 @@
         "username": "admin",
         "password": "public"
     },
-    "notes": []
+    "notes": [
+        {
+            "text": "Setup-Steps: Access Control ➡ Authentication ➡ Create ➡ Next ➡ Next ➡ Create ➡ Users ➡ Add ➡ Username / Password (to authenicate with MQTT) ➡ Save. You're now ready to enjoy a high-performance MQTT Broker.",
+            "type": "info"
+        }
+    ]
 }

json/evcc.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "entering `evcc configure` in the LXC terminal will guide you through the creation of a configuration file for evcc.",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/fhem.json

@@ -30,5 +30,10 @@
         "username": null,
         "password": null
     },
-    "notes": []
+    "notes": [
+        {
+            "text": "If the LXC is created Privileged, the script will automatically set up USB passthrough.",
+            "type": "warning"
+        }
+    ]
 }

json/frigate.json

@@ -33,11 +33,11 @@
     "notes": [
         {
             "text": "Discussions (explore more advanced methods): `https://github.com/tteck/Proxmox/discussions/2711`",
-            "type": "warning"
+            "type": "info"
         },
         {
             "text": "go2rtc Interface port:`1984`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/fstrim.json

@@ -9,10 +9,10 @@
     "updateable": false,
     "privileged": false,
     "interface_port": null,
-    "documentation": "https://github.com/tteck/Proxmox/discussions/2505#discussion-6226037",
+    "documentation": "https://github.com/community-scripts/ProxmoxVE/discussions/805",
     "website": null,
     "logo": "https://raw.githubusercontent.com/loganmarchione/homelab-svg-assets/main/assets/lxc.svg",
-    "description": "This maintains SSD performance by managing unused blocks. Thin-provisioned storage systems also require management to prevent unnecessary storage use. VMs automate fstrim, while LXC containers need manual or automated fstrim processes for optimal performance.\r\nThis is designed to work with SSDs on ext4 filesystems only.",
+    "description": "This maintains SSD performance by managing unused blocks. Thin-provisioned storage systems also require management to prevent unnecessary storage use. VMs automate fstrim, while LXC containers need manual or automated fstrim processes for optimal performance.",
     "install_methods": [
         {
             "type": "default",
@@ -33,6 +33,10 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
+            "type": "info"
+        },
+        {
+            "text": "This is designed to work with SSDs on ext4 filesystems only.",
             "type": "warning"
         }
     ]

json/gotify.json

@@ -30,14 +30,5 @@
         "username": "admin",
         "password": "admin"
     },
-    "notes": [
+    "notes": []
-        {
-            "text": "password: `admin`",
-            "type": "warning"
-        },
-        {
-            "text": "username: `admin`",
-            "type": "warning"
-        }
-    ]
 }

json/haos-vm.json

@@ -34,6 +34,10 @@
         {
             "text": "The disk must have a minimum size of 32GB and its size cannot be changed during the creation of the VM.",
             "type": "warning"
+        },
+        {
+            "text": "After the script completes, click on the VM, then on the Summary or Console tab to find the VM IP.",
+            "type": "info"
         }
     ]
 }

json/headscale.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Configuration settings: `/etc/headscale/config.yaml`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/hivemq.json

@@ -30,5 +30,10 @@
         "username": null,
         "password": null
     },
-    "notes": []
+    "notes": [
+        {
+            "text": "To check if HiveMQ is listening to the default port for MQTT `lsof -i :1883`",
+            "type": "info"
+        }
+    ]
 }

json/homeassistant-core.json

@@ -32,16 +32,20 @@
     },
     "notes": [
         {
-            "text": "config path: `/root/.homeassistant`",
+            "text": "If the LXC is created Privileged, the script will automatically set up USB passthrough.",
             "type": "warning"
         },
         {
-            "text": "Requires `6.8.4-3-pve` or newer kernel",
+            "text": "Requires PVE 8.2.2 with kernel 6.8.4-3-pve or newer",
             "type": "warning"
         },
         {
             "text": "Use Ubuntu 24.04 ONLY",
             "type": "warning"
+        },
+        {
+            "text": "config path: `/root/.homeassistant`",
+            "type": "info"
         }
     ]
 }

json/homeassistant.json

@@ -38,6 +38,10 @@
         {
             "text": "config path: `/var/lib/docker/volumes/hass_config/_data`",
             "type": "warning"
+        },
+        {
+            "text": "Portainer Interface: LXC-IP: 9443",
+            "type": "info"
         }
     ]
 }

json/homebox.json

@@ -32,7 +32,7 @@
     },
     "notes": [
         {
-            "text": "env file location: `/opt/.env`",
+            "text": ".env file location: `/opt/.env`",
             "type": "info"
         }
     ]

json/homepage.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Configuration (bookmarks.yaml, services.yaml, widgets.yaml) path: `/opt/homepage/config/`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/homer.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Configuration Path: `/opt/homer/assets/config.yml`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/host-backup.json

@@ -33,7 +33,11 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
-            "type": "warning"
+            "type": "info"
+        },
+        {
+            "text": "A backup is rendered ineffective when it remains stored on the host",
+            "type": "info"
         }
     ]
 }

json/jellyfin.json

@@ -33,11 +33,11 @@
     "notes": [
         {
             "text": "With Privileged/Unprivileged Hardware Acceleration Support",
-            "type": "warning"
+            "type": "info"
         },
         {
             "text": "FFmpeg path: /usr/lib/jellyfin-ffmpeg/ffmpeg",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/kernel-clean.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/kernel-pin.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/linkwarden.json

@@ -36,4 +36,4 @@
             "type": "info"
         }
     ]
-}
+}

json/mafl.json

@@ -32,8 +32,8 @@
     },
     "notes": [
         {
-            "text": "Configuration Path: `/opt/mafl/data/config.yml`\r\n",
+            "text": "Configuration Path: `/opt/mafl/data/config.yml`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/magicmirror.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Configuration Path: `/opt/magicmirror/config/config.js`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/microcode.json

@@ -33,7 +33,11 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
-            "type": "warning"
+            "type": "info"
+        },
+        {
+            "text": "After a reboot, you can check whether any microcode updates are currently in effect by running the following command. `journalctl -k | grep -E \"microcode\" | head -n 1`",
+            "type": "info"
         }
     ]
 }

json/monitor-all.json

@@ -33,31 +33,35 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
+            "type": "info"
+        },
+        {
+            "text": "Virtual machines without the QEMU guest agent installed must be excluded.",
+            "type": "warning"
+        },
+        {
+            "text": "Prior to generating any new CT/VM not found in this repository, it's necessary to halt Proxmox VE Monitor-All by running `systemctl stop ping-instances`.",
             "type": "warning"
         },
         {
             "text": "To make setup changes, first stop the service: `systemctl stop ping-instances`",
-            "type": "Info"
+            "type": "info"
         },
         {
             "text": "To edit pause time: `nano /usr/local/bin/ping-instances.sh`",
-            "type": "Info"
+            "type": "info"
         },
         {
             "text": "To add excluded instances: `nano /etc/systemd/system/ping-instances.service`",
-            "type": "Info"
+            "type": "info"
-        },
-        {
-            "text": "To edit pause time: `nano /usr/local/bin/ping-instances.sh`",
-            "type": "Info"
         },
         {
             "text": "After changes have been saved, `systemctl daemon-reload` and start the service: `systemctl start ping-instances`",
-            "type": "Info"
+            "type": "info"
         },
         {
             "text": "Monitor-All logs: `cat /var/log/ping-instances.log`",
-            "type": "Info"
+            "type": "info"
         }
     ]
 }

json/mysql.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Database credentials: `cat mysql.creds`",
-            "type": "warning"
+            "type": "info"
         },
         {
             "text": "With an option to install the MySQL 8.4 LTS release instead of MySQL 8.0",

json/navidrome.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "To change Navidrome music folder path, `nano /var/lib/navidrome/navidrome.toml`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/netdata.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/node-red.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "To install themes, type `update` in the LXC console.",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/notifiarr.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Manually edit `/etc/notifiarr/notifiarr.conf`to enter the API key from Notifiarr.com, and create a password for the UI.",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/olivetin.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Configuration Path: `/etc/OliveTin/config.yaml`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/openobserve.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Show Login Credentials: `cat /opt/openobserve/data/.env`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/paperless-ngx.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Show Login Credentials, type `update` in the LXC console",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/pbs.json

@@ -9,7 +9,7 @@
     "updateable": false,
     "privileged": false,
     "interface_port": 8007,
-    "documentation": null,
+    "documentation": "https://pbs.proxmox.com/docs/",
     "website": "https://www.proxmox.com/en/proxmox-backup-server/overview",
     "logo": "https://raw.githubusercontent.com/home-assistant/brands/master/core_integrations/proxmoxve/icon.png",
     "description": "Proxmox Backup Server is an enterprise backup solution, for backing up and restoring VMs, containers, and physical hosts. By supporting incremental, fully deduplicated backups, Proxmox Backup Server significantly reduces network load and saves valuable storage space.",
@@ -32,8 +32,8 @@
     },
     "notes": [
         {
-            "text": "Set a root password if using autologin. This will be the PBS password.",
+            "text": "Set a root password if using autologin. This will be the PBS password. `sudo passwd root`",
             "type": "warning"
         }
     ]
-}
+}

json/pihole.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "To set your password, log in to the container, and type the following:  `pihole -a -p`",
-            "type": "warning"
+            "type": "info"
         },
         {
             "text": "With an option to add Unbound",

json/pimox-haos-vm.json

@@ -30,5 +30,10 @@
         "username": null,
         "password": null
     },
-    "notes": []
+    "notes": [
+        {
+            "text": "After the script completes, click on the VM, then on the Summary or Console tab to find the VM IP.",
+            "type": "info"
+        }
+    ]
 }

json/plex.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "With Privileged/Unprivileged Hardware Acceleration Support",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/podman-homeassistant.json

@@ -38,6 +38,10 @@
         {
             "text": "If the LXC is created Privileged, the script will automatically set up USB passthrough.",
             "type": "warning"
+        },
+        {
+            "text": "config path: `/var/lib/containers/storage/volumes/hass_config/_data`",
+            "type": "info"
         }
     ]
 }

json/post-pbs-install.json

@@ -33,11 +33,15 @@
     "notes": [
         {
             "text": "Proxmox Backup Server ONLY",
-            "type": "warning"
+            "type": "info"
         },
         {
             "text": "Execute within the Proxmox Backup Server Shell",
-            "type": "warning"
+            "type": "info"
+        },
+        {
+            "text": "It is recommended to answer “yes” (y) to all options presented during the process.",
+            "type": "info"
         }
     ]
 }

json/post-pve-install.json

@@ -33,7 +33,11 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
-            "type": "warning"
+            "type": "info"
+        },
+        {
+            "text": "It is recommended to answer “yes” (y) to all options presented during the process.",
+            "type": "info"
         }
     ]
 }

json/redis.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Redis Configuration: `nano /etc/redis/redis.conf`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/scaling-governor.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/snipeit.json

@@ -30,6 +30,10 @@
       "username": null,
       "password": null
     },
-    "notes": []
+    "notes": [
-  }
+      {
-  
+          "text": "Post Install: `https://github.com/community-scripts/ProxmoxVE/discussions/671`",
+          "type": "info"
+      }
+  ]
+}

json/tdarr.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "With Privileged/Unprivileged Hardware Acceleration Support",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/the-lounge.json

@@ -32,7 +32,7 @@
     },
     "notes": [
       {
-        "text": "The Lounge is running in private mode. Use \"sudo -u thelounge thelounge add name\" to create users.",
+        "text": "The Lounge is running in private mode. Use `sudo -u thelounge thelounge add name` to create users.",
         "type": "info"
       }
     ]

json/turnkey.json

@@ -33,11 +33,11 @@
     "notes": [
         {
             "text": "The script creates a `*.creds` file in the Proxmox root directory with the password of the newly created TurnKey LXC Appliance.",
-            "type": "warning"
+            "type": "info"
         },
         {
             "text": "Retrieve Password: `cat turnkey-name.creds`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/umami.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "To view the database credentials : `cat umami.creds`",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/update-lxcs.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/update-repo.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Execute within the Proxmox shell",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }

json/webmin.json

@@ -33,7 +33,7 @@
     "notes": [
         {
             "text": "Execute within an existing LXC Console",
-            "type": "warning"
+            "type": "info"
         }
     ]
 }