remove stale dev artifacts; rename dev_install.sh to plugin_setup.sh
This commit is contained in:
@@ -18,7 +18,7 @@ For folder overview see `README-Plugin.md`. For web app logic see the headers in
|
||||
|
||||
```bash
|
||||
cd Plugin/
|
||||
./dev_install.sh
|
||||
./plugin_setup.sh
|
||||
```
|
||||
|
||||
This creates:
|
||||
@@ -94,7 +94,7 @@ All other configuration lives in `Configurations/master.conf` and `Configuration
|
||||
|
||||
If the repo is cloned to a new path:
|
||||
|
||||
1. Re-run `dev_install.sh` — removes the stale symlink and creates a new one pointing at the new path
|
||||
1. Re-run `plugin_setup.sh` — removes the stale symlink and creates a new one pointing at the new path
|
||||
2. Update `SCRIPTS_DIR` in Settings → Other Settings → Varaverk (or edit `varaverk.cfg` directly on flash)
|
||||
|
||||
The `.plg` on flash does not need to change — it has no path references.
|
||||
@@ -115,10 +115,10 @@ management page to reflect when the plugin was last changed:
|
||||
|
||||
## ━━━ ADDING A NEW OS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
`dev_install.sh` is built to support multiple OS targets. To add one:
|
||||
`plugin_setup.sh` is built to support multiple OS targets. To add one:
|
||||
|
||||
1. Create `Plugin/<os>/` with the OS-appropriate web app files
|
||||
2. Add the OS marker to `detect_os()` in `dev_install.sh`:
|
||||
2. Add the OS marker to `detect_os()` in `plugin_setup.sh`:
|
||||
```bash
|
||||
elif [[ -f /etc/<os>-marker ]]; then echo "<os>"
|
||||
```
|
||||
|
||||
@@ -31,7 +31,7 @@ no separate monitoring stack, no third-party dashboards.
|
||||
|
||||
```
|
||||
Plugin/
|
||||
├── dev_install.sh # One-time developer setup: symlinks plugin into web server
|
||||
├── plugin_setup.sh # One-time setup: symlinks plugin into web server
|
||||
├── Icons/ # Source icon assets (1024px master files)
|
||||
└── unraid/ # The Unraid platform adapter + plugin application
|
||||
├── adapter.sh # Platform adapter — provides platform_*() API to all scripts
|
||||
@@ -75,7 +75,7 @@ so behaviour stays consistent without a shell dependency.
|
||||
|
||||
| Script | Role | When It Runs |
|
||||
|--------|------|--------------|
|
||||
| `dev_install.sh` | Symlinks `Plugin/unraid/` into Unraid's web server | Once, manually, after cloning or moving the repo |
|
||||
| `plugin_setup.sh` | Symlinks `Plugin/unraid/` into Unraid's web server | Once, manually, after cloning or moving the repo |
|
||||
| `build.sh` | Packages the plugin as a `.txz` for release | Before publishing a new plugin version |
|
||||
|
||||
---
|
||||
|
||||
+1
-1
@@ -7,7 +7,7 @@
|
||||
# ─────────────────────────────────────────────────────────────────────────────
|
||||
# Packages the plugin web files (Plugin/unraid/) into a Slackware .txz, the
|
||||
# format unRAID re-installs from flash on every boot. This is the RELEASE path —
|
||||
# for day-to-day development use dev_install.sh (symlink, instant edits).
|
||||
# for day-to-day development use plugin_setup.sh (symlink, instant edits).
|
||||
#
|
||||
# What it produces (in Plugin/dist/):
|
||||
# varaverk-<version>-noarch-1.txz the package unRAID installs to
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/bin/bash
|
||||
# ==============================================================================================
|
||||
# ============================= dev_install.sh =================================================
|
||||
# ============================= plugin_setup.sh =================================================
|
||||
# ==============================================================================================
|
||||
#
|
||||
# PURPOSE
|
||||
@@ -47,10 +47,10 @@
|
||||
# RUNTIME MODES
|
||||
# ==============================================================================================
|
||||
#
|
||||
# ./dev_install.sh
|
||||
# ./plugin_setup.sh
|
||||
# Auto-detects the running OS and installs.
|
||||
#
|
||||
# ./dev_install.sh <os>
|
||||
# ./plugin_setup.sh <os>
|
||||
# Overrides OS detection. Valid values: unraid, debian, arch.
|
||||
# Useful when testing on a machine where the marker files differ.
|
||||
#
|
||||
@@ -70,7 +70,7 @@ detect_os() {
|
||||
else echo "unknown"; fi
|
||||
}
|
||||
|
||||
OS="${1:-$(detect_os)}" # accept override: ./dev_install.sh unraid
|
||||
OS="${1:-$(detect_os)}" # accept override: ./plugin_setup.sh unraid
|
||||
|
||||
# ── OS-specific install target ────────────────────────────────────────────────
|
||||
|
||||
@@ -81,7 +81,7 @@ case "$OS" in
|
||||
;;
|
||||
debian|arch)
|
||||
echo "OS '$OS' detected but plugin target path not yet defined."
|
||||
echo "Add the TARGET= line for this OS in dev_install.sh."
|
||||
echo "Add the TARGET= line for this OS in plugin_setup.sh."
|
||||
exit 1
|
||||
;;
|
||||
unknown|*)
|
||||
Reference in New Issue
Block a user