mirror of
https://github.com/unraid/api.git
synced 2026-01-01 22:20:05 -06:00
a8566e9e5a
- Isolate plugin concerns into `.plg` plugin & api file modifiers instead of the api's slackware package. ## Summary by CodeRabbit * **New Features** * Installation process modularized into package installation, post-install setup with verification, and service startup with cleanup. * Added logging and error detection during installation, including symlink verification. * Created required log directory to support service dependencies. * Integrated nginx service with reload capability triggered by configuration changes. * Added automatic patching of nginx configuration and hosts file to improve security and iframe compatibility. * Enhanced file modification system to handle side effects and trigger nginx reloads as needed. * **Refactor** * Restructured installation scripts for clarity; setup scripts now separate steps. * Removed legacy installation logic and deprecated related scripts. * Enabled hard link addition during package creation. * Simplified installation scripts by removing conditional branching and detailed logging. * Streamlined API environment setup by removing redundant post-install steps. * Updated dependency injection to explicitly provide nginx service token. * Improved patch application error reporting with file path details. * **Chores** * Disabled legacy scripts to streamline installation. * Removed `.gitignore` to track previously ignored files. * Updated tests to include new dependencies and relaxed logger assertions. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- - To see the specific tasks where the Asana app for GitHub is being used, see below: - https://app.asana.com/0/0/1210661184127051
334 lines
12 KiB
XML
Executable File
334 lines
12 KiB
XML
Executable File
<?xml version='1.0' standalone='yes'?>
|
|
<!DOCTYPE PLUGIN [
|
|
<!ENTITY name "dynamix.unraid.net">
|
|
<!ENTITY launch "Connect">
|
|
<!ENTITY author "limetech">
|
|
<!ENTITY version "">
|
|
<!ENTITY plugin_url "">
|
|
<!ENTITY source "/boot/config/plugins/dynamix.my.servers/&txz_name;">
|
|
<!ENTITY txz_sha256 "">
|
|
<!ENTITY txz_url "">
|
|
<!ENTITY txz_name "">
|
|
<!ENTITY arch "x86_64">
|
|
<!ENTITY build "1">
|
|
<!ENTITY tag "">
|
|
<!ENTITY api_version "">
|
|
]>
|
|
|
|
<PLUGIN name="&name;" author="&author;" version="&version;" pluginURL="&plugin_url;"
|
|
launch="&launch;" min="6.9.0-rc1" icon="globe">
|
|
|
|
<CHANGES>
|
|
##a long time ago in a galaxy far far away
|
|
- initial release
|
|
</CHANGES>
|
|
|
|
<!-- Check disk space before installation -->
|
|
<FILE Run="/bin/bash" Method="install">
|
|
<INLINE>
|
|
<![CDATA[
|
|
# Check available disk space on /usr
|
|
echo -n "Checking disk space on /usr... "
|
|
FREE_SPACE=$(df -m /usr | awk 'NR==2 {print $4}')
|
|
if [ -z "$FREE_SPACE" ]; then
|
|
echo "⚠️ Error: Unable to determine free space on /usr"
|
|
exit 1
|
|
fi
|
|
|
|
if [ "$FREE_SPACE" -lt 300 ]; then
|
|
echo "⚠️ Error: Insufficient disk space on /usr. Need at least 300MB free, only ${FREE_SPACE}MB available"
|
|
exit 1
|
|
fi
|
|
echo "ok. (${FREE_SPACE}MB free)"
|
|
|
|
exit 0
|
|
]]>
|
|
</INLINE>
|
|
</FILE>
|
|
|
|
<!-- download main txz -->
|
|
<FILE Name="&source;">
|
|
<URL>&txz_url;</URL>
|
|
<SHA256>&txz_sha256;</SHA256>
|
|
</FILE>
|
|
|
|
<!-- Check for compatible Unraid version -->
|
|
<FILE Run="/usr/bin/php" Method="install">
|
|
<INLINE>
|
|
<![CDATA[
|
|
<?php
|
|
// Check Unraid version
|
|
$version = @parse_ini_file('/etc/unraid-version', true)['version'];
|
|
|
|
// Check if this is a supported version
|
|
// - Must be 6.12.0 or higher
|
|
// - Must not be a 6.12.0 beta/rc version
|
|
$is_stable_6_12_or_higher = version_compare($version, '6.12.0', '>=') && !preg_match('/^6\\.12\\.0-/', $version);
|
|
|
|
if ($is_stable_6_12_or_higher) {
|
|
echo "Running on supported version {$version}\n";
|
|
exit(0);
|
|
}
|
|
|
|
echo "Warning: Unsupported Unraid version {$version}. This plugin requires Unraid 6.12.0 or higher.\n";
|
|
echo "The plugin may not function correctly on this system.\n";
|
|
|
|
exit(0);
|
|
]]>
|
|
</INLINE>
|
|
</FILE>
|
|
|
|
<!-- Backup files before installation -->
|
|
<FILE Run="/bin/bash" Method="install">
|
|
<INLINE>
|
|
<![CDATA[
|
|
echo "Backing up original files..."
|
|
|
|
# Define files to backup in a shell variable
|
|
FILES_TO_BACKUP=(
|
|
"/usr/local/emhttp/plugins/dynamix/DisplaySettings.page"
|
|
"/usr/local/emhttp/plugins/dynamix/Registration.page"
|
|
"/usr/local/emhttp/plugins/dynamix/include/DefaultPageLayout.php"
|
|
"/usr/local/emhttp/plugins/dynamix/include/ProvisionCert.php"
|
|
"/usr/local/emhttp/plugins/dynamix/include/UpdateDNS.php"
|
|
"/usr/local/emhttp/plugins/dynamix/include/ReplaceKey.php"
|
|
"/usr/local/emhttp/plugins/dynamix/include/Wrappers.php"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/Downgrade.page"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/Update.page"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/include/ShowChanges.php"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/scripts/showchanges"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/scripts/unraidcheck"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/include/UnraidCheck.php"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/include/UnraidCheckExec.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/Connect.page"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/MyServers.page"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/Registration.page"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/include/myservers1.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/include/myservers2.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/include/state.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/data/server-state.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/include/reboot-details.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/include/translations.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/include/web-components-extractor.php"
|
|
"/usr/local/emhttp/update.htm"
|
|
"/usr/local/emhttp/logging.htm"
|
|
"/etc/nginx/nginx.conf"
|
|
"/etc/rc.d/rc.nginx"
|
|
"/usr/share/mozilla/firefox/9n35r0i1.default/user.js"
|
|
)
|
|
|
|
# Backup each file if it exists and doesn't already have a backup
|
|
for FILE in "${FILES_TO_BACKUP[@]}"; do
|
|
if [ -f "$FILE" ] && [ ! -f "$FILE-" ]; then
|
|
cp -p "$FILE" "$FILE-"
|
|
echo "Backed up: $FILE"
|
|
fi
|
|
done
|
|
|
|
# Handle the unraid-components directory
|
|
DIR=/usr/local/emhttp/plugins/dynamix.my.servers/unraid-components
|
|
if [ -d "$DIR" ] && [ ! -d "$DIR-" ]; then
|
|
mv "$DIR" "$DIR-"
|
|
echo "Moved directory: $DIR to $DIR-"
|
|
fi
|
|
|
|
echo "Backup complete."
|
|
exit 0
|
|
]]>
|
|
</INLINE>
|
|
</FILE>
|
|
|
|
<FILE Run="/bin/bash" Method="remove">
|
|
<INLINE>
|
|
MAINNAME="&name;"
|
|
<![CDATA[
|
|
echo "Removing Plugin"
|
|
|
|
# Find any installed dynamix.unraid.net package
|
|
pkg_installed=$(ls -1 /var/log/packages/dynamix.unraid.net* 2>/dev/null | head -1)
|
|
if [ -n "$pkg_installed" ]; then
|
|
pkg_basename=$(basename "$pkg_installed")
|
|
echo "Removing package: $pkg_basename"
|
|
removepkg --terse "$pkg_basename"
|
|
else
|
|
echo "No dynamix.unraid.net package found. Trying with basic package name."
|
|
removepkg --terse "${MAINNAME}"
|
|
fi
|
|
|
|
# File restoration function
|
|
echo "Restoring files..."
|
|
|
|
# Define files to restore in a shell variable - must match backup list
|
|
FILES_TO_RESTORE=(
|
|
"/usr/local/emhttp/plugins/dynamix/DisplaySettings.page"
|
|
"/usr/local/emhttp/plugins/dynamix/Registration.page"
|
|
"/usr/local/emhttp/plugins/dynamix/include/DefaultPageLayout.php"
|
|
"/usr/local/emhttp/plugins/dynamix/include/ProvisionCert.php"
|
|
"/usr/local/emhttp/plugins/dynamix/include/UpdateDNS.php"
|
|
"/usr/local/emhttp/plugins/dynamix/include/ReplaceKey.php"
|
|
"/usr/local/emhttp/plugins/dynamix/include/Wrappers.php"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/Downgrade.page"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/Update.page"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/include/ShowChanges.php"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/scripts/showchanges"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/scripts/unraidcheck"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/include/UnraidCheck.php"
|
|
"/usr/local/emhttp/plugins/dynamix.plugin.manager/include/UnraidCheckExec.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/Connect.page"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/MyServers.page"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/Registration.page"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/include/myservers1.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/include/myservers2.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/include/state.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/data/server-state.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/include/reboot-details.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/include/translations.php"
|
|
"/usr/local/emhttp/plugins/dynamix.my.servers/include/web-components-extractor.php"
|
|
"/usr/local/emhttp/update.htm"
|
|
"/usr/local/emhttp/logging.htm"
|
|
"/etc/nginx/nginx.conf"
|
|
"/etc/rc.d/rc.nginx"
|
|
"/usr/share/mozilla/firefox/9n35r0i1.default/user.js"
|
|
)
|
|
|
|
# Restore each file if backup exists
|
|
for FILE in "${FILES_TO_RESTORE[@]}"; do
|
|
[ -f "$FILE-" ] && mv -f "$FILE-" "$FILE"
|
|
done
|
|
|
|
# Handle the unraid-components directory
|
|
DIR=/usr/local/emhttp/plugins/dynamix.my.servers/unraid-components
|
|
# Remove the archive's contents before restoring
|
|
if [ -d "$DIR" ]; then
|
|
rm -rf "$DIR"
|
|
fi
|
|
if [ -d "$DIR-" ]; then
|
|
mv "$DIR-" "$DIR"
|
|
echo "Restored directory: $DIR- to $DIR"
|
|
fi
|
|
]]>
|
|
</INLINE>
|
|
</FILE>
|
|
|
|
<!-- install api package and all necessary files -->
|
|
<FILE Run="/bin/bash" Method="install">
|
|
<INLINE>
|
|
TAG="&tag;"
|
|
PKG_FILE="&source;" # Full path to the package file including .txz extension
|
|
PKG_URL="&txz_url;" # URL where package was downloaded from
|
|
PKG_NAME="&txz_name;" # Name of the package file
|
|
<![CDATA[
|
|
# Install the Slackware package
|
|
echo "Installing package..."
|
|
# Clean up any old package txz files if they don't match our current version
|
|
for txz_file in /boot/config/plugins/dynamix.my.servers/dynamix.unraid.net-*.txz; do
|
|
if [ -f "$txz_file" ] && [ "$txz_file" != "${PKG_FILE}" ]; then
|
|
echo "Removing old package file: $txz_file"
|
|
rm -f "$txz_file"
|
|
fi
|
|
done
|
|
|
|
# Remove existing node_modules directory
|
|
echo "Cleaning up existing node_modules directory..."
|
|
if [ -d "/usr/local/unraid-api/node_modules" ]; then
|
|
echo "Removing: /usr/local/unraid-api/node_modules"
|
|
rm -rf "/usr/local/unraid-api/node_modules"
|
|
fi
|
|
|
|
# Install the package using the explicit file path
|
|
upgradepkg --install-new --reinstall "${PKG_FILE}"
|
|
if [ $? -ne 0 ]; then
|
|
echo "⚠️ Package installation failed"
|
|
exit 1
|
|
fi
|
|
|
|
if [[ -n "$TAG" && "$TAG" != "" ]]; then
|
|
printf -v sedcmd 's@^\*\*Unraid Connect\*\*@**Unraid Connect (%s)**@' "$TAG"
|
|
sed -i "${sedcmd}" "/usr/local/emhttp/plugins/dynamix.unraid.net/README.md"
|
|
fi
|
|
|
|
exit 0
|
|
]]>
|
|
</INLINE>
|
|
</FILE>
|
|
|
|
<!-- port of the old doinst.sh script -->
|
|
<FILE Run="/bin/bash" Method="install">
|
|
<INLINE>
|
|
<![CDATA[
|
|
SCRIPTS_DIR="/usr/local/share/dynamix.unraid.net/install/scripts"
|
|
# Log file for debugging
|
|
LOGFILE="/var/log/unraid-api/dynamix-unraid-install.log"
|
|
mkdir -p "$(dirname "$LOGFILE")"
|
|
|
|
echo "Starting Unraid Connect installation..."
|
|
|
|
# Move settings on flash drive
|
|
CFG_OLD=/boot/config/plugins/Unraid.net
|
|
CFG_NEW=/boot/config/plugins/dynamix.my.servers
|
|
[ -d "$CFG_OLD" ] && [ ! -d "$CFG_NEW" ] && mv "$CFG_OLD" "$CFG_NEW"
|
|
|
|
# Setup the API (but don't start it yet)
|
|
if [ -x "$SCRIPTS_DIR/setup_api.sh" ]; then
|
|
echo "Setting up Unraid API..."
|
|
echo "Running setup_api.sh" >> "$LOGFILE"
|
|
# Capture output and add to log file
|
|
setup_output=$("$SCRIPTS_DIR/setup_api.sh")
|
|
echo "$setup_output" >> "$LOGFILE"
|
|
else
|
|
echo "ERROR: setup_api.sh not found or not executable" >> "$LOGFILE"
|
|
fi
|
|
|
|
# Run post-installation verification
|
|
if [ -x "$SCRIPTS_DIR/verify_install.sh" ]; then
|
|
echo "Running post-installation verification..."
|
|
echo "Running verify_install.sh" >> "$LOGFILE"
|
|
# Capture output and add to log file
|
|
verify_output=$("$SCRIPTS_DIR/verify_install.sh")
|
|
echo "$verify_output" >> "$LOGFILE"
|
|
else
|
|
echo "ERROR: verify_install.sh not found or not executable" >> "$LOGFILE"
|
|
fi
|
|
|
|
echo "Installation completed at $(date)" >> "$LOGFILE"
|
|
]]>
|
|
</INLINE>
|
|
</FILE>
|
|
|
|
<!-- start the unraid api service -->
|
|
<FILE Run="/bin/bash" Method="install">
|
|
<INLINE>
|
|
<![CDATA[
|
|
# Clean up any old node_modules archives (on the boot drive) that don't match our current version
|
|
#
|
|
# Must run after package installation because the package provides an update api config file,
|
|
# which determines the current API version and vendor archive to keep.
|
|
/etc/rc.d/rc.unraid-api cleanup-dependencies
|
|
|
|
echo "Starting Unraid API service"
|
|
/etc/rc.d/rc.unraid-api plugins add unraid-api-plugin-connect -b --no-restart
|
|
/etc/rc.d/rc.unraid-api start
|
|
|
|
echo "Unraid API service started"
|
|
echo "✅ Installation is complete, it is safe to close this window"
|
|
echo
|
|
exit 0
|
|
]]>
|
|
</INLINE>
|
|
</FILE>
|
|
|
|
<!-- uninstall cleanup message -->
|
|
<FILE Run="/bin/bash" Method="remove">
|
|
<INLINE>
|
|
<![CDATA[
|
|
echo
|
|
echo "✅ Uninstall is complete, it is safe to close this window"
|
|
echo
|
|
|
|
exit 0
|
|
]]>
|
|
</INLINE>
|
|
</FILE>
|
|
|
|
</PLUGIN>
|