What is pkgacct? The Complete cPanel Backup & Migration Tool Guide

Table of Contents: What is pkgacct? Key Features of pkgacct How to Use pkgacct Options/Flags for pkgacct Restoring the Backup Common Use Cases Tips for Using pkgacct Troubleshooting Common Issues

pkgacct is a command-line tool in cPanel/WHM used for creating backups of cPanel accounts. It is part of cPanel's internal utilities and is often used by system administrators to package (archive) a cPanel account, including all its files, databases, emails, and configurations.

The tool generates a backup file in .tar.gz format, which can be restored on the same or another server using the restorepkg utility.

Key Features of pkgacct

1. Full Account Backup:
   • Archives the entire cPanel account, including:
     • Files: Home directory, websites, scripts
     • Databases: MySQL/MariaDB databases
     • Email accounts and messages: Mailboxes, forwarders, filters
     • DNS zone files: Domain DNS records
     • Configuration settings: Account preferences, subdomains, cron jobs
2. Transfer Between Servers:
   • Primarily designed for migrating cPanel accounts between servers.
3. Efficient and Automated:
   • Can be scripted for automated backups and migrations.
4. Customizable Options:
   • Includes various flags for controlling backup details and optimizing the process.

How to Use pkgacct

Basic Syntax

Example Commands

1. Create a Backup for a cPanel Account:

This will create a backup of the cPanel account username in the default backup directory (/home).

2. Create a Backup in a Custom Directory:

This will save the backup in the specified /backup/ directory.

Options/Flags for pkgacct

pkgacct offers several options to customize the backup process. Here are the most commonly used flags:

Restoring the Backup

Use the restorepkg utility to restore a backup created with pkgacct.

Basic Syntax

Example Command

This will restore the cPanel account from the backup file. The username will be the same as in the original backup.

Common Use Cases

1. Migrating cPanel Accounts:
   • Use pkgacct to back up accounts from the source server, transfer the cpmove-username.tar.gz file to the destination server (via SCP, FTP, or rsync), and use restorepkg to complete the migration.
2. Manual Backups:
   • Create on-demand backups for disaster recovery or archiving before making major server changes.
3. Troubleshooting:
   • Back up accounts before upgrading cPanel, the server OS, or performing other risky operations to ensure you have a rollback point.

Tips for Using pkgacct

1. Check Available Disk Space:
   • Ensure there is enough disk space for the backup file before running pkgacct. A backup typically requires space equal to the account size.
2. Automate with Cron Jobs:
   • Schedule regular backups using a cron job. Example (backup at 2 AM daily):
     0 2 * * * /usr/local/cpanel/scripts/pkgacct username /backup/
3. Secure Your Backups:
   • Transfer backups securely using scp or rsync over SSH. Set proper permissions on backup directories (e.g., chmod 600).
4. Exclude Unnecessary Data:
   • Use flags like --skiphomedir or --skipdns to exclude data that isn't required for your specific use case, reducing backup size and time.

Troubleshooting Common Issues

1. Permission Denied:
   • Run the command as root (via SSH) to ensure sufficient permissions. Standard cPanel users cannot run pkgacct.
2. Backup Fails for Large Accounts:
   • Use the --skiphomedir flag to exclude home directory files if storage is limited. Also, check for available inodes (df -i).
3. Slow Backups:
   • Use the --nocompress option to speed up backup creation (compression is CPU-intensive). You can compress it later with gzip if needed.
4. Backup File Not Found:
   • Verify the backup file's location. By default, it's in /home/ as cpmove-<username>.tar.gz. Use ls -la /home/cpmove* to list backups.
5. Account Doesn't Exist Error:
   • Double-check the username spelling. List all cPanel accounts with: ls -la /var/cpanel/users/.

With this guide, you can effectively use pkgacct for cPanel account backups, migrations, and disaster recovery planning.