rename: appdata/varaverk → appdata/Varaverk (capital V throughout)

2026-05-30 10:22:51 -04:00
parent 2d5a084d2b
commit 0fe99cf2a9
24 changed files with 641 additions and 385 deletions
@@ -1,16 +1,60 @@
 #!/bin/bash
-# dev_install.sh — symlinks the OS-appropriate plugin into the web server for local development.
-# Run once after cloning. Re-run if the repo is moved.
-# Safe to re-run: removes stale symlink before recreating.
+# ==============================================================================================
+# ============================= dev_install.sh =================================================
+# ==============================================================================================
 #
-# Plugin layout:
-#   Plugin/unraid/   ← Unraid plugin (PHP, served by emhttp at /usr/local/emhttp/plugins/)
-#   Plugin/debian/   ← future
-#   Plugin/<os>/     ← future
+# PURPOSE
+# ─────────────────────────────────────────────────────────────────────────────
+# Symlinks the OS-appropriate plugin directory into the web server on first
+# install or after the repo is moved. Run once by hand — never by a scheduler.
 #
-# Adding a new OS:
-#   1. Create Plugin/<os>/ with the OS-appropriate web app files
-#   2. Add detection + TARGET path below
+# Detects the running OS from /etc/*-version markers, picks the matching
+# Plugin/<os>/ source directory, and creates a symlink at the web server's
+# plugin location. All subsequent file changes under Plugin/<os>/ take effect
+# immediately without re-running this script.
+#
+# ==============================================================================================
+# OPERATIONAL SAFEGUARDS
+# ==============================================================================================
+#
+# Idempotent Symlink
+#   Removes any existing symlink at the target before recreating it. Safe to
+#   re-run after a repo move without leaving stale paths.
+#
+# Real Directory Guard
+#   If the target exists as a real directory (not a symlink), the script refuses
+#   to proceed. Manual cleanup is required to avoid silently discarding an
+#   existing installation.
+#
+# Missing Source Guard
+#   Exits early if Plugin/<os>/ does not exist — catches a missing OS directory
+#   before any filesystem changes are made.
+#
+# ==============================================================================================
+# CONFIGURATION
+# ==============================================================================================
+#
+# No config vars. All paths are derived from $BASH_SOURCE and the detected OS.
+#
+#   PLUGIN_NAME   varaverk  (hardcoded — must match the plugin's registered name)
+#
+#   OS detection markers:
+#     /etc/unraid-version   → unraid  → /usr/local/emhttp/plugins/varaverk
+#     /etc/debian_version   → debian  → (target path not yet defined)
+#     /etc/arch-release     → arch    → (target path not yet defined)
+#
+# ==============================================================================================
+# RUNTIME MODES
+# ==============================================================================================
+#
+# ./dev_install.sh
+#     Auto-detects the running OS and installs.
+#
+# ./dev_install.sh <os>
+#     Overrides OS detection. Valid values: unraid, debian, arch.
+#     Useful when testing on a machine where the marker files differ.
+#
+# ==============================================================================================

 set -euo pipefail