Merge 1f6254062e into 41c32af0d6

CHANGELOG.md

@@ -21,10 +21,6 @@ Do not break established syntax in this file, as it is automatically updated by
 
 ### Changed
 
-### 💥 Breaking Changes
-
-- [DCMA] Delete scripts 5etools and pf2etools - Copyright abuse [@michelroegl-brunner](https://github.com/michelroegl-brunner) ([#1922](https://github.com/community-scripts/ProxmoxVE/pull/1922))
-
 ### ✨ New Scripts
 
 - New script: Baïkal [@bvdberg01](https://github.com/bvdberg01) ([#1913](https://github.com/community-scripts/ProxmoxVE/pull/1913))

ct/5etools.sh

@@ -0,0 +1,113 @@
+#!/usr/bin/env bash
+source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: TheRealVira
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://5e.tools/
+
+# App Default Values
+APP="5etools"
+var_tags="wiki"
+var_cpu="1"
+var_ram="512"
+var_disk="13"
+var_os="debian"
+var_version="12"
+var_unprivileged="1"
+
+# App Output & Base Settings
+header_info "$APP"
+base_settings
+
+# Core
+variables
+color
+catch_errors
+
+function update_script() {
+    header_info
+    check_container_storage
+    check_container_resources
+
+    # Check if installation is present | -f for file, -d for folder
+    if [[ ! -d "/opt/${APP}" ]]; then
+        msg_error "No ${APP} Installation Found!"
+        exit
+    fi
+
+    RELEASE=$(curl -s https://api.github.com/repos/5etools-mirror-3/5etools-src/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }')
+    if [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]] || [[ ! -f "/opt/${APP}_version.txt" ]]; then
+        # Crawling the new version and checking whether an update is required
+        msg_info "Updating System"
+        apt-get update &>/dev/null
+        apt-get -y upgrade &>/dev/null
+        msg_ok "Updated System"
+
+        # Execute Update
+        msg_info "Updating base 5etools"
+        cd /opt
+        wget -q "https://github.com/5etools-mirror-3/5etools-src/archive/refs/tags/${RELEASE}.zip"
+        unzip -q "${RELEASE}.zip"
+        mv "/opt/${APP}/img" "/opt/img-backup"
+        rm -rf "/opt/${APP}"
+        mv "${APP}-src-${RELEASE:1}" "/opt/${APP}"
+        mv "/opt/img-backup" "/opt/${APP}/img"
+        cd /opt/5etools
+        $STD npm install
+        $STD npm run build
+        cd ~
+        echo "${RELEASE}" >"/opt/${APP}_version.txt"
+        chown -R www-data: "/opt/${APP}"
+        chmod -R 755 "/opt/${APP}"
+        msg_ok "Updated base 5etools"
+        # Cleaning up
+        msg_info "Cleaning Up"
+        rm -rf /opt/${RELEASE}.zip
+        $STD apt-get -y autoremove
+        $STD apt-get -y autoclean
+        msg_ok "Cleanup Completed"
+    else
+        msg_ok "No update required. Base ${APP} is already at ${RELEASE}"
+    fi
+
+    IMG_RELEASE=$(curl -s https://api.github.com/repos/5etools-mirror-2/5etools-img/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }')
+    if [[ "${IMG_RELEASE}" != "$(cat /opt/${APP}_IMG_version.txt)" ]] || [[ ! -f "/opt/${APP}_IMG_version.txt" ]]; then
+        # Crawling the new version and checking whether an update is required
+        msg_info "Updating System"
+        apt-get update &>/dev/null
+        apt-get -y upgrade &>/dev/null
+        msg_ok "Updated System"
+
+        # Execute Update
+        msg_info "Updating 5etools images"
+        curl -sSL "https://github.com/5etools-mirror-2/5etools-img/archive/refs/tags/${IMG_RELEASE}.zip" > "${IMG_RELEASE}.zip"
+        unzip -q "${IMG_RELEASE}.zip"
+        rm -rf "/opt/${APP}/img"
+        mv "${APP}-img-${IMG_RELEASE:1}" "/opt/${APP}/img"
+        echo "${IMG_RELEASE}" >"/opt/${APP}_IMG_version.txt"
+        chown -R www-data: "/opt/${APP}"
+        chmod -R 755 "/opt/${APP}"
+
+        msg_ok "Updating 5etools images"
+
+        # Cleaning up
+        msg_info "Cleaning Up"
+        rm -rf /opt/${RELEASE}.zip
+        rm -rf ${IMG_RELEASE}.zip
+        $STD apt-get -y autoremove
+        $STD apt-get -y autoclean
+        msg_ok "Cleanup Completed"
+    else
+        msg_ok "No update required. ${APP} images are already at ${IMG_RELEASE}"
+    fi
+
+}
+
+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}"

ct/headers/5etools

@@ -0,0 +1,6 @@
+    ______     __              __    
+   / ____/__  / /_____  ____  / /____
+  /___ \/ _ \/ __/ __ \/ __ \/ / ___/
+ ____/ /  __/ /_/ /_/ / /_/ / (__  ) 
+/_____/\___/\__/\____/\____/_/____/  
+                                     

ct/headers/pf2etools

@@ -0,0 +1,6 @@
+    ____  _______      ______            __    
+   / __ \/ __/__ \ ___/_  __/___  ____  / /____
+  / /_/ / /_ __/ // _ \/ / / __ \/ __ \/ / ___/
+ / ____/ __// __//  __/ / / /_/ / /_/ / (__  ) 
+/_/   /_/  /____/\___/_/  \____/\____/_/____/  
+                                               

ct/pf2etools.sh

@@ -0,0 +1,81 @@
+#!/usr/bin/env bash
+source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: TheRealVira
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://pf2etools.com/
+
+# App Default Values
+APP="Pf2eTools"
+var_tags="wiki"
+var_cpu="1"
+var_ram="512"
+var_disk="6"
+var_os="debian"
+var_version="12"
+var_unprivileged="1"
+
+# App Output & Base Settings
+header_info "$APP"
+base_settings
+
+# Core
+variables
+color
+catch_errors
+
+function update_script() {
+    header_info
+    check_container_storage
+    check_container_resources
+
+    # Check if installation is present | -f for file, -d for folder
+    if [[ ! -d "/opt/${APP}" ]]; then
+        msg_error "No ${APP} Installation Found!"
+        exit
+    fi
+
+    RELEASE=$(curl -s https://api.github.com/repos/Pf2eToolsOrg/Pf2eTools/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }')
+    if [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]] || [[ ! -f "/opt/${APP}_version.txt" ]]; then
+        # Crawling the new version and checking whether an update is required
+        msg_info "Updating System"
+        apt-get update &>/dev/null
+        apt-get -y upgrade &>/dev/null
+        msg_ok "Updated System"
+
+        # Execute Update
+        msg_info "Updating ${APP}"
+        cd /opt
+        wget -q "https://github.com/Pf2eToolsOrg/Pf2eTools/archive/refs/tags/${RELEASE}.zip"
+        unzip -q ${RELEASE}.zip
+        rm -rf "/opt/${APP}"
+        mv ${APP}-${RELEASE:1} /opt/${APP}
+        cd /opt/Pf2eTools
+        $STD npm install
+        $STD npm run build
+        echo "${RELEASE}" >"/opt/${APP}_version.txt"
+        msg_ok "Updated ${APP}"
+
+        chown -R www-data: "/opt/${APP}"
+        chmod -R 755 "/opt/${APP}"
+
+        # Cleaning up
+        msg_info "Cleaning Up"
+        rm -rf /opt/${RELEASE}.zip
+        $STD apt-get -y autoremove
+        $STD apt-get -y autoclean
+        msg_ok "Cleanup Completed"
+    else
+        msg_ok "No update required. ${APP} is already at ${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}${CL}"

install/5etools-install.sh

@@ -0,0 +1,83 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: TheRealVira
+# License: MIT
+# Source: https://5e.tools/
+
+# Import Functions und Setup
+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 \
+  mc \
+  sudo \
+  git \
+  gpg \
+  ca-certificates \
+  apache2
+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_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"
+
+# Setup App
+msg_info "Set up 5etools Base"
+cd /opt
+RELEASE=$(curl -s https://api.github.com/repos/5etools-mirror-3/5etools-src/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }')
+wget -q "https://github.com/5etools-mirror-3/5etools-src/archive/refs/tags/${RELEASE}.zip"
+unzip -q "${RELEASE}.zip"
+mv "5etools-src-${RELEASE:1}" /opt/5etools
+cd /opt/5etools
+$STD npm install
+$STD npm run build
+echo "${RELEASE}" >"/opt/5etools_version.txt"
+msg_ok "Set up 5etools Base"
+
+msg_info "Set up 5etools Image"
+cd /opt
+IMG_RELEASE=$(curl -s https://api.github.com/repos/5etools-mirror-2/5etools-img/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }')
+curl -sSL "https://github.com/5etools-mirror-2/5etools-img/archive/refs/tags/${IMG_RELEASE}.zip" > "${IMG_RELEASE}.zip"
+unzip -q "${IMG_RELEASE}.zip"
+mv "5etools-img-${IMG_RELEASE:1}" /opt/5etools/img
+echo "${IMG_RELEASE}" >"/opt/5etools_IMG_version.txt"
+msg_ok "Set up 5etools Image"
+
+msg_info "Creating Service"
+cat <<EOF >> /etc/apache2/apache2.conf
+<Location /server-status>
+    SetHandler server-status
+    Order deny,allow
+    Allow from all
+</Location>
+EOF
+rm -rf /var/www/html
+ln -s "/opt/5etools" /var/www/html
+chown -R www-data: "/opt/5etools"
+chmod -R 755 "/opt/5etools"
+msg_ok "Created Service"
+
+msg_info "Cleaning up"
+rm -rf /opt/${IMG_RELEASE}.zip
+rm -rf /opt/${RELEASE}.zip
+$STD apt-get -y autoremove
+$STD apt-get -y autoclean
+msg_ok "Cleaned"
+
+motd_ssh
+customize

install/pf2etools-install.sh

@@ -0,0 +1,75 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2025 community-scripts ORG
+# Author: TheRealVira
+# License: MIT
+# Source: https://pf2etools.com/
+
+# Import Functions und Setup
+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 \
+  mc \
+  sudo \
+  apache2 \
+  gpg \
+  ca-certificates \
+  git
+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_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"
+
+# Setup App
+msg_info "Setup Pf2eTools"
+cd /opt
+RELEASE=$(curl -s https://api.github.com/repos/Pf2eToolsOrg/Pf2eTools/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }')
+wget -q "https://github.com/Pf2eToolsOrg/Pf2eTools/archive/refs/tags/${RELEASE}.zip"
+unzip -q "${RELEASE}.zip"
+mv "Pf2eTools-${RELEASE:1}" /opt/Pf2eTools
+cd /opt/Pf2eTools
+$STD npm install
+$STD npm run build
+cd ~
+echo "${RELEASE}" >/opt/Pf2eTools_version.txt
+msg_ok "Set up Pf2eTools"
+
+msg_info "Creating Service"
+cat <<EOF >> /etc/apache2/apache2.conf
+<Location /server-status>
+    SetHandler server-status
+    Order deny,allow
+    Allow from all
+</Location>
+EOF
+rm -rf /var/www/html
+ln -s "/opt/Pf2eTools" /var/www/html
+chown -R www-data: "/opt/Pf2eTools"
+chmod -R 755 "/opt/Pf2eTools"
+msg_ok "Created Service"
+
+# Cleanup
+msg_info "Cleaning up"
+rm -rf /opt/${RELEASE}.zip
+$STD apt-get -y autoremove
+$STD apt-get -y autoclean
+msg_ok "Cleaned"
+
+motd_ssh
+customize

json/5etools.json

@@ -0,0 +1,34 @@
+{
+    "name": "5etools",
+    "slug": "5etools",
+    "categories": [
+        24
+    ],
+    "date_created": "2025-01-02",
+    "type": "ct",
+    "updateable": true,
+    "privileged": false,
+    "interface_port": 80,
+    "documentation": "https://wiki.tercept.net/en/5eTools",
+    "website": "https://5e.tools/",
+    "logo": "https://wiki.tercept.net/core-wiki-assets/5etoolslogocircle.png",
+    "description": "5eTools is a website providing a suite of tools for 5th Edition Dungeons & Dragons players and Dungeon Masters.",
+    "install_methods": [
+        {
+            "type": "default",
+            "script": "ct/5etools.sh",
+            "resources": {
+                "cpu": 1,
+                "ram": 512,
+                "hdd": 13,
+                "os": "debian",
+                "version": "12"
+            }
+        }
+    ],
+    "default_credentials": {
+        "username": null,
+        "password": null
+    },
+    "notes": []
+}

json/pf2etools.json

@@ -0,0 +1,34 @@
+{
+    "name": "Pf2eTools",
+    "slug": "Pf2eTools",
+    "categories": [
+        24
+    ],
+    "date_created": "2025-01-02",
+    "type": "ct",
+    "updateable": true,
+    "privileged": false,
+    "interface_port": 80,
+    "documentation": "https://github.com/Pf2eToolsOrg/Pf2eTools/wiki",
+    "website": "https://pf2etools.com/",
+    "logo": "https://raw.githubusercontent.com/Pf2eToolsOrg/Pf2eTools/refs/heads/dev/android-chrome-192x192.png",
+    "description": "Pf2eTools is an open-source website aiming to provide tools and information for Pathfinder 2nd Edition players and gamemasters. It's built using basic web technologies to ensure wide compatibility, and utilises client-side caching for speed, efficiency, and offline access.",
+    "install_methods": [
+        {
+            "type": "default",
+            "script": "ct/pf2etools.sh",
+            "resources": {
+                "cpu": 1,
+                "ram": 512,
+                "hdd": 6,
+                "os": "debian",
+                "version": "12"
+            }
+        }
+    ],
+    "default_credentials": {
+        "username": null,
+        "password": null
+    },
+    "notes": []
+}