Document control panel paths in MySQL restore script header

Added comprehensive documentation to script header:
- Lists all 4 control panel paths (cPanel, Plesk, InterWorx, standalone)
- References source: lib/system-detect.sh -> SYS_USER_HOME_BASE
- Documents InterWorx special case (/chroot/home vs /home symlink)
- Shows restore directory and SQL output directory formats
- Makes it clear where paths come from for maintenance
This commit is contained in:
cschantz
2025-12-10 21:11:48 -05:00
parent 42584b8589
commit 23c8c96e2d
+10
View File
@@ -7,12 +7,22 @@
# Use Case: Restore InnoDB databases from file-based backups (Acronis, etc.)
#
# Features:
# - Multi-control panel support (cPanel, Plesk, InterWorx, standalone)
# - Interactive guided workflow
# - Validates MySQL data directory structure
# - Starts second MySQL instance for safe extraction
# - Creates SQL dumps from restored files
# - Handles InnoDB system tablespace requirements
# - Optional force-recovery mode for corrupted databases
#
# Control Panel Paths (from lib/system-detect.sh → SYS_USER_HOME_BASE):
# - cPanel: /home
# - Plesk: /var/www/vhosts
# - InterWorx: /chroot/home (actual path, /home is symlink)
# - Standalone: /home
#
# Suggested restore directory format: ${SYS_USER_HOME_BASE}/temp/restoreYYYYMMDD/mysql
# SQL output directory: ${SYS_USER_HOME_BASE}/temp/restoreYYYYMMDD/
################################################################################
# Path resolution (modules/backup/script.sh → ../../)