Install Backuply Server
This section explains how to install the Backuply Server using the official installation script.
Command:
wget -O backuply.sh https://a.softaculous.com/backuply-server/files/install.sh
chmod +x backuply.sh
./backuply.sh
Backuply Cron Command
This command executes the Backuply cron handler, which is responsible for processing all scheduled and background tasks within Backuply
Command:
/usr/local/backuply/bin/php /usr/local/backuply/cron.php debug=4
Backuply Version
This command displays the currently installed Backuply version.
Command:
backuply -v
Update Backuply
Updates the Backuply installation to the latest available version directly from the terminal.
Command:
backuply --update
Backuply License Details
This command displays the current license details for Backuply.
Command:
backuply -l
Sample Output
Backuply License : BACSER--XXXXX-XXXXX-XXXXX-XXXXX
Type : Premium
Expires (DD/MM/YYYY) : Never
License IP : -XXXXX-XXXXX
Refresh License
This command Forces a license refresh from the Backuply licensing server.
Command:
backuply --refresh-license
Fix Permissions
Resets file and directory permissions to ensure proper functioning of Backuply.
Command:
backuply --fix_permissions
Backuply Repair
This command runs internal repair routines to fix issues related to:
1. Corrupted installation files
2. Missing binaries
3. Misconfigured components
Command:
backuply --repair
Rebuild Database
This command rebuilds Backuply’s internal SQLite databases to fix inconsistencies
Command:
backuply --db_rebuild
Backuply Logs – Commands & Usage
1. Error Logs
Shows live system errors and failures.
Command:
tail -f /var/backuply/logs/error_log.log
2. Admin Auto Backup Logs
This command shows real-time logs of automated (cron-based) backup processes.
Command:
tail -f /var/backuply/logs/admin_auto_backup.log
3. Enduser Backup Logs
This command Displays live logs of backups triggered by end users.
Command:
tail -f /var/backuply/logs/admin_enduser_backup.log
4. Admin Auto Restore Logs
This command Monitors automated restore operations in real-time.
Command:
tail -f /var/backuply/logs/admin_auto_restore.log
5. Enduser Restore Logs
This command Shows restore activities initiated by users.
Command:
tail -f /var/backuply/logs/admin_enduser_restore.log
6. Download Logs
Displays real-time logs of backup download activity.
Command:
tail -f /var/backuply/logs/download.log
7. Sync Logs
Monitors synchronization between local and remote backup storage.
Command:
tail -f /var/backuply/logs/sync_backups.log
8. Restic Cache Logs
This command show logs related to Restic cache operations.
Command:
tail -f /var/backuply/logs/restic_cache.log
9. Task Database Logs
Tracks internal task execution and database activities.
Command:
tail -f /var/backuply/logs/task_db.log
10. Installation Logs
Shows logs of package installation and dependency setup.
Command:
tail -f /var/backuply/logs/install_packages.log
Verify Cache Status & Restic Cache Cleanup
1. Verify Cache Status
Displays the current status and location of Restic cache directories.
Command:
restic cache
2. Cleanup Restic Cache
Removes all existing Restic cache directories immediately.
Command:
restic cache --cleanup --max-age=0
Clean Orphaned Backups
Removes orphaned backup records that no longer exist on storage
Command:
backuply --clean_backups
Install Missing Packages
Installs any missing dependencies or required packages for Backuply.
Command:
backuply --install_packages
Install/Update Restic Engine
Installs or updates the Restic backup engine used by Backuply.
Command:
backuply --install_restic
Install/Update Borg Engine
Installs or updates the Borg backup engine.
Command:
backuply --install_borg
Enable Backup Deletion
Enables the option to delete backups from Backuply.
Command:
backuply --enable-delete-backups
Disable Backup Deletion
Disables the ability to delete backups.
Command:
backuply --disable-delete-backups
Test MySQL Connection
This command checks whether the MySQL connection is working properly from Backuply.
Command:
backuply --test_panel_get_funcs --func=mysql_conn
Backuply Enduser Restore Command
This command is used to restore any backup file directly from the specified local path using the Backuply CLI.
BACKUP_FILENAME is the name of the backup file.
BACKUP_PATH is the directory where the backup file is stored.
BACKUP_METHOD can either be compressed or incremental.
USERNAME is the name of the panel user.
Command:
backuply --enduser_restore --restore=1 --admin_backup=1 --type=full --filename=<backup_filename> --local_backup_path=<backup_path> --backup_method=<backup_method> --user=<username> --initiator=root --dev=1
Enduser Backup via CLI (Webuzo)
This command is used to trigger a full backup for an end-user account using the Webuzo CLI.
Command:
/usr/local/emps/bin/php /usr/local/webuzo/cli.php --enduser_backup --backup=1 --type=full --user=<username>