From e356259785b8c98373e7e87f8ac44e4a5832e550 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johanna=20R=C3=BChrig?=
<TheRealVira@users.noreply.github.com>
Date: Thu, 2 Jan 2025 20:29:49 +0100
Subject: [PATCH] New Script: Pf2eTools (#1162)
* Testing 5etools.
* Introducing Pf2eTools
* Replacing name with var.
* Switched to release crawling.
* Re-added git.
* Update Pf2eTools-install.sh
* Update Pf2eTools-install.sh
* Update Pf2eTools-install.sh
* Update Pf2eTools.sh
* Update Pf2eTools-install.sh
* Update Pf2eTools.sh
* Update Pf2eTools.sh
* Update Pf2eTools-install.sh
* Update Pf2eTools.sh
* Update Pf2eTools-install.sh
* Update Pf2eTools.sh
Fix update script
* Update Pf2eTools.json
---------
Co-authored-by: CanbiZ <47820557+MickLesk@users.noreply.github.com>
---
ct/Pf2eTools.sh | 78 ++++++++++++++++++++++++++++++++++++
install/Pf2eTools-install.sh | 58 +++++++++++++++++++++++++++
json/Pf2eTools.json | 34 ++++++++++++++++
3 files changed, 170 insertions(+)
create mode 100644 ct/Pf2eTools.sh
create mode 100644 install/Pf2eTools-install.sh
create mode 100644 json/Pf2eTools.json
diff --git a/ct/Pf2eTools.sh b/ct/Pf2eTools.sh
new file mode 100644
index 000000000..43d693c87
--- /dev/null
+++ b/ct/Pf2eTools.sh
@@ -0,0 +1,78 @@
+#!/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/${APP}"
+ 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}"
+ 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 "${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}"
diff --git a/install/Pf2eTools-install.sh b/install/Pf2eTools-install.sh
new file mode 100644
index 000000000..d245d3462
--- /dev/null
+++ b/install/Pf2eTools-install.sh
@@ -0,0 +1,58 @@
+#!/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 \
+ git
+msg_ok "Installed Dependencies"
+
+# Setup App
+msg_info "Setup Pf2eTools"
+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
+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"
+apache2ctl start
+msg_ok "Creating Service"
+# Cleanup
+msg_info "Cleaning up"
+rm "${RELEASE}.zip"
+$STD apt-get -y autoremove
+$STD apt-get -y autoclean
+msg_ok "Cleaned"
+
+motd_ssh
+customize
diff --git a/json/Pf2eTools.json b/json/Pf2eTools.json
new file mode 100644
index 000000000..0dbb2b472
--- /dev/null
+++ b/json/Pf2eTools.json
@@ -0,0 +1,34 @@
+{
+ "name": "Pf2eTools",
+ "slug": "Pf2eTools",
+ "categories": [
+ 0
+ ],
+ "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": []
+}