New Script: 5etools (#1157)

* Testing 5etools. * Adding httpd-foreground step for updates. * Debug. * Debug. * Debug. * Debug. * Debug. * Debug. * Debug. * Debug. * Fix version names. * Added 5etools json. * Introduced images and increased storage. * Fixing version zip names. * Increased storage. * Introduced image versions. * Clean-up. * Renamed step. * Increased git post buffer. * Fixing echo command. * Fix tags. * Finetune storage size. * cleanup and restore. * Update ct/5etools.sh Co-authored-by: Michel Roegl-Brunner <[email protected]> * Update ct/5etools.sh Co-authored-by: Michel Roegl-Brunner <[email protected]> * Update ct/5etools.sh Co-authored-by: Michel Roegl-Brunner <[email protected]> * Update install/5etools-install.sh Co-authored-by: Michel Roegl-Brunner <[email protected]> * Update install/5etools-install.sh Co-authored-by: Michel Roegl-Brunner <[email protected]> * Update install/5etools-install.sh Co-authored-by: Michel Roegl-Brunner <[email protected]> * Update install/5etools-install.sh Co-authored-by: Michel Roegl-Brunner <[email protected]> * Update install/5etools-install.sh Co-authored-by: Michel Roegl-Brunner <[email protected]> * Update install/5etools-install.sh Co-authored-by: Michel Roegl-Brunner <[email protected]> * Update install/5etools-install.sh Co-authored-by: Michel Roegl-Brunner <[email protected]> * Moving stuff around. * Cleanup and finetune. * Update 5etools-install.sh * Switched to release crawling. * Update 5etools-install.sh * Update 5etools-install.sh * Update 5etools.sh * Update 5etools-install.sh * Update 5etools-install.sh * Update 5etools.sh * Update 5etools.sh * Update 5etools.json * Update 5etools-install.sh * Update 5etools.sh * Update 5etools-install.sh * Update 5etools.sh * Update 5etools-install.sh * Update 5etools.sh * Update 5etools.sh * Update 5etools-install.sh * Update 5etools.sh * Update 5etools.json * Update 5etools.sh * Update 5etools.sh Fixed update script * Update 5etools.json --------- Co-authored-by: Michel Roegl-Brunner <[email protected]> Co-authored-by: CanbiZ <[email protected]>
community-scripts · Jan 2, 2025 · 618445e · 618445e
1 parent 3e5274a
commit 618445e
Show file tree

Hide file tree

Showing 3 changed files with 210 additions and 0 deletions.
diff --git a/ct/5etools.sh b/ct/5etools.sh
@@ -0,0 +1,109 @@
+#!/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"
+        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"
+        echo "${RELEASE}" >"/opt/${APP}_version.txt"
+        msg_ok "Updated base 5etools"
+
+        chown -R www-data: "/opt/${APP}"
+        chmod -R 755 "/opt/${APP}"
+
+        # Cleaning up
+        msg_info "Cleaning Up"
+        rm "${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"
+        msg_ok "Updating 5etools images"
+
+        chown -R www-data: "/opt/${APP}"
+        chmod -R 755 "/opt/${APP}"
+
+        # Cleaning up
+        msg_info "Cleaning Up"
+        rm "${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}"
diff --git a/install/5etools-install.sh b/install/5etools-install.sh
@@ -0,0 +1,67 @@
+#!/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 \
+  apache2
+msg_ok "Installed Dependencies"
+
+# Setup App
+msg_info "Set up base 5etools"
+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
+echo "${RELEASE}" >"/opt/5etools_version.txt"
+rm "${RELEASE}.zip"
+msg_ok "Set up base 5etools"
+
+msg_info "Set up 5etools images"
+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"
+rm "${IMG_RELEASE}.zip"
+msg_ok "Set up 5etools images"
+
+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"
+apache2ctl start
+msg_ok "Creating Service"
+# Cleanup
+msg_info "Cleaning up"
+$STD apt-get -y autoremove
+$STD apt-get -y autoclean
+msg_ok "Cleaned"
+
+motd_ssh
+customize
diff --git a/json/5etools.json b/json/5etools.json
@@ -0,0 +1,34 @@
+{
+    "name": "5etools",
+    "slug": "5etools",
+    "categories": [
+        0
+    ],
+    "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": []
+}