FailedProxy/Varaverk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix root Manual, README, User_Script_Plug-in — boot drive paths, 15min watchdog, scheduler setup replaces User Scripts section

Browse Source
This commit is contained in:
Gmer4Lfe
2026-06-01 19:50:31 -04:00
parent d22b18bf9f
commit 4effb55756
4 changed files with 110 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README-User_Script_Plug-in.md
+60 -55
View File
@@ -2,9 +2,14 @@
# 📋 USER SCRIPTS PLUGIN — COMPLETE SETUP REFERENCE
# ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
**Every script entry for the User Scripts plugin — what it does, when it runs,
how to set it up, and what to watch for.** No cross-referencing other READMEs to
understand the basics. The deeper documentation exists — this is your daily reference.
> **Mostly superseded.** Scheduling has moved to the Varaverk plugin's built-in
> scheduler. Only `array_started.sh` still uses User Scripts (for the "At Startup of Array"
> hook). All cron entries are now managed via the Varaverk Scheduler tab or `schedule.json`.
> See `Orchestrators/README-Orchestrators.md` for the current complete schedule.
**Historical reference for the User Scripts plugin setup — what each script does,
when it ran, how it was configured.** Still useful as a script reference. Paths
updated to reflect current boot-drive installation location.
---
@@ -95,7 +100,7 @@ Background: YES — required (starts continuous background processes)
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Orchestrators/array_started.sh
/boot/config/plugins/varaverk/Orchestrators/array_started.sh
```
**What it does:**
@@ -133,7 +138,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Orchestrators/transcode_management.sh
/boot/config/plugins/varaverk/Orchestrators/transcode_management.sh
```
**What it does:**
@@ -174,7 +179,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Orchestrators/critical_sync_maintenance.sh
/boot/config/plugins/varaverk/Orchestrators/critical_sync_maintenance.sh
```
**What it does:**
@@ -207,7 +212,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Orchestrators/arrs_failed_stalled_recovery.sh
/boot/config/plugins/varaverk/Orchestrators/arrs_failed_stalled_recovery.sh
```
**What it does:**
@@ -242,7 +247,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Orchestrators/daily_sync_maintenance.sh
/boot/config/plugins/varaverk/Orchestrators/daily_sync_maintenance.sh
```
**What it does:**
@@ -309,7 +314,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Orchestrators/weekly_sync_maintenance.sh
/boot/config/plugins/varaverk/Orchestrators/weekly_sync_maintenance.sh
```
**What it does:**
@@ -356,7 +361,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Orchestrators/sunday_morning_coffee_report.sh
/boot/config/plugins/varaverk/Orchestrators/sunday_morning_coffee_report.sh
```
**What it does:**
@@ -403,7 +408,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Monitors/weekly_health_digest.sh
/boot/config/plugins/varaverk/Monitors/weekly_health_digest.sh
```
**What it does:**
@@ -435,7 +440,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Monitors/system_tuning_monitor.sh
/boot/config/plugins/varaverk/Monitors/system_tuning_monitor.sh
```
**What it does:**
@@ -467,7 +472,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Monitors/zfs_memory_snapshot.sh
/boot/config/plugins/varaverk/Monitors/zfs_memory_snapshot.sh
```
**What it does:**
@@ -493,7 +498,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Monitors/smart_health.sh
/boot/config/plugins/varaverk/Monitors/smart_health.sh
```
**What it does:**
@@ -524,7 +529,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Monitors/cert_monitor.sh
/boot/config/plugins/varaverk/Monitors/cert_monitor.sh
```
**What it does:**
@@ -557,7 +562,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Monitors/backup_verify.sh
/boot/config/plugins/varaverk/Monitors/backup_verify.sh
```
**What it does:**
@@ -591,7 +596,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Monitors/emby_session_report.sh
/boot/config/plugins/varaverk/Monitors/emby_session_report.sh
```
**What it does:**
@@ -617,7 +622,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Monitors/bandwidth_monitor.sh --report
/boot/config/plugins/varaverk/Monitors/bandwidth_monitor.sh --report
```
**What it does:**
@@ -655,7 +660,7 @@ Background: NO (runs and exits — status check)
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Fallback/fallback.sh --status
/boot/config/plugins/varaverk/Fallback/fallback.sh --status
```
**What it does:**
@@ -680,7 +685,7 @@ Background: YES — test takes several minutes
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Fallback/fallback_test.sh --dry-run
/boot/config/plugins/varaverk/Fallback/fallback_test.sh --dry-run
```
**What it does:**
@@ -753,7 +758,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Rsync/rsync.sh \
/boot/config/plugins/varaverk/Rsync/rsync.sh \
/mnt/user/appdata-Fallback/Critical-Data
```
@@ -774,7 +779,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Rsync/rsync.sh \
/boot/config/plugins/varaverk/Rsync/rsync.sh \
/mnt/user/Media_Server/Emby --profile=emby
```
@@ -795,7 +800,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Rsync/rsync.sh \
/boot/config/plugins/varaverk/Rsync/rsync.sh \
/mnt/user/appdata-Fallback/Arrs_Stack
```
@@ -816,7 +821,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Rsync/rsync.sh \
/boot/config/plugins/varaverk/Rsync/rsync.sh \
/mnt/user/appdata-Fallback/Important-Data
```
@@ -836,7 +841,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Rsync/rsync.sh \
/boot/config/plugins/varaverk/Rsync/rsync.sh \
/mnt/user/appdata-Fallback/Gmer4Lfe
```
@@ -849,7 +854,7 @@ No profile container stop required. Incremental — safe to run at any time.
## 🐳 DOCKER_ESSENTIALS
## ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
> **docker_watchdog.sh is called every minute by watchdog_orchestrator.sh — not scheduled separately.**
> **docker_watchdog.sh is called every 15 minutes by watchdog_orchestrator.sh — not scheduled separately.**
> docker_daily_restart.sh is called by daily_sync_maintenance.sh.
> docker_weekly_restart.sh is called by weekly_sync_maintenance.sh.
> docker_network_connect.sh is called by array_started.sh.
@@ -868,7 +873,7 @@ Background: NO
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Watchdogs/docker_watchdog.sh --status
/boot/config/plugins/varaverk/Watchdogs/docker_watchdog.sh --status
```
**What it shows:**
@@ -889,7 +894,7 @@ Background: NO
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Docker_Essentials/watchdog_skip_list_manager.sh --status
/boot/config/plugins/varaverk/Docker_Essentials/watchdog_skip_list_manager.sh --status
```
**What it does:**
@@ -928,7 +933,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Docker_Essentials/docker_daily_restart.sh --dry-run
/boot/config/plugins/varaverk/Docker_Essentials/docker_daily_restart.sh --dry-run
```
**What it does:**
@@ -955,7 +960,7 @@ Background: NO
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Docker_Essentials/docker_network_connect.sh --status
/boot/config/plugins/varaverk/Docker_Essentials/docker_network_connect.sh --status
```
**What it does:**
@@ -989,7 +994,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Media/media_shares_permissions.sh --dry-run
/boot/config/plugins/varaverk/Media/media_shares_permissions.sh --dry-run
```
**What it does:**
@@ -1015,7 +1020,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Media/media_cleaner.sh anime --dry-run
/boot/config/plugins/varaverk/Media/media_cleaner.sh anime --dry-run
```
**What it does:**
@@ -1036,7 +1041,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Media/media_cleaner.sh media --dry-run
/boot/config/plugins/varaverk/Media/media_cleaner.sh media --dry-run
```
**What it does:**
@@ -1056,7 +1061,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Media/lidarr_cleanup.sh --dry-run --log
/boot/config/plugins/varaverk/Media/lidarr_cleanup.sh --dry-run --log
```
**What it does:**
@@ -1088,7 +1093,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Media/sonarr_cleanup.sh --dry-run --log
/boot/config/plugins/varaverk/Media/sonarr_cleanup.sh --dry-run --log
```
**What it does:**
@@ -1109,7 +1114,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Media/radarr_cleanup.sh --dry-run --log
/boot/config/plugins/varaverk/Media/radarr_cleanup.sh --dry-run --log
```
**What it does:**
@@ -1140,7 +1145,7 @@ Background: NO
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Transcodes/ramdisk_setup.sh --status
/boot/config/plugins/varaverk/Transcodes/ramdisk_setup.sh --status
```
**What it shows:**
@@ -1161,7 +1166,7 @@ Background: NO
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Transcodes/transcode_manager.sh --status
/boot/config/plugins/varaverk/Transcodes/transcode_manager.sh --status
```
**What it shows:**
@@ -1192,7 +1197,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Watchdogs/System/webgui_watchdog.sh
/boot/config/plugins/varaverk/Watchdogs/System/webgui_watchdog.sh
```
**What it does:**
@@ -1223,7 +1228,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/unRAID_Essentials/clear_logs.sh
/boot/config/plugins/varaverk/unRAID_Essentials/clear_logs.sh
```
**What it does:**
@@ -1250,7 +1255,7 @@ Background: NO
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Watchdogs/stability_watchdog.sh --status
/boot/config/plugins/varaverk/Watchdogs/stability_watchdog.sh --status
```
**What it shows:**
@@ -1271,7 +1276,7 @@ Background: NO
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/unRAID_Essentials/mover_stop.sh
/boot/config/plugins/varaverk/unRAID_Essentials/mover_stop.sh
```
**What it does:**
@@ -1292,7 +1297,7 @@ Background: NO
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/unRAID_Essentials/rsync_stop.sh --status
/boot/config/plugins/varaverk/unRAID_Essentials/rsync_stop.sh --status
```
**What it does:**
@@ -1314,7 +1319,7 @@ Background: NO
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/unRAID_Essentials/user_scripts_stop.sh --status
/boot/config/plugins/varaverk/unRAID_Essentials/user_scripts_stop.sh --status
```
**What it does:**
@@ -1336,7 +1341,7 @@ Background: YES — sequence takes 1-2 minutes
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/unRAID_Essentials/server_reboot.sh --dry-run
/boot/config/plugins/varaverk/unRAID_Essentials/server_reboot.sh --dry-run
```
**What it does:**
@@ -1373,7 +1378,7 @@ Background: NO
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Partnership/partnership_manage.sh --status
/boot/config/plugins/varaverk/Partnership/partnership_manage.sh --status
```
**What it shows:**
@@ -1394,7 +1399,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Partnership/partnership_manage.sh --onboard --dry-run
/boot/config/plugins/varaverk/Partnership/partnership_manage.sh --onboard --dry-run
```
**What it does:**
@@ -1418,7 +1423,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Partnership/partnership_manage.sh --offboard --dry-run
/boot/config/plugins/varaverk/Partnership/partnership_manage.sh --offboard --dry-run
```
**What it does:**
@@ -1452,7 +1457,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Tools/bulk_permissions_repair.sh /mnt/user/Movies --dry-run
/boot/config/plugins/varaverk/Tools/bulk_permissions_repair.sh /mnt/user/Movies --dry-run
```
**What it does:**
@@ -1474,7 +1479,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Tools/container_data_export.sh \
/boot/config/plugins/varaverk/Tools/container_data_export.sh \
Emby /mnt/media-servers/Media_Server/Emby /mnt/user/Backups/
```
@@ -1499,7 +1504,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Tools/emby_database_repair.sh
/boot/config/plugins/varaverk/Tools/emby_database_repair.sh
```
**What it does:**
@@ -1531,7 +1536,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Tools/zfs_pool_scrub.sh
/boot/config/plugins/varaverk/Tools/zfs_pool_scrub.sh
```
**What it does:**
@@ -1553,7 +1558,7 @@ Background: YES
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/Tools/recreate_shares.sh --dry-run
/boot/config/plugins/varaverk/Tools/recreate_shares.sh --dry-run
```
**What it does:**
@@ -1581,7 +1586,7 @@ Background: NO
```bash
#!/bin/bash
/mnt/user/appdata/Varaverk/unRAID_Essentials/git_pull_execute.sh
/boot/config/plugins/varaverk/unRAID_Essentials/git_pull_execute.sh
```
**What it does:**
@@ -1607,7 +1612,7 @@ Correct startup setup:
Wrong startup setup (old approach):
ramdisk_setup — At Startup of Array
docker_syslog_filter — At Startup of Array
stability_watchdog — Every Minute via watchdog_orchestrator
stability_watchdog — Every 15 Minutes via watchdog_orchestrator
docker_watchdog — At Startup of Array
failover — At Startup of Array
(unpredictable order, no coordination)