This script provides a method to automatically upload backups from your cPanel server to Dropbox, utilizing Dropbox's API via CPAN WebService::Dropbox, through the cPanel's Custom Backup Transport.
The cPanel backup system provides lots of flexibility, and one of the awesome features is the ability to create custom backup transports. In cPanel, a backup transport is essentially a backup destination or method to move backups to a secondary/remote server for safe keeping. The custom backup transport feature allows you to specify a script which the backup system will pass arguments to; arguments common with uploading files in FTP, e.g. 'put $filename'. Reading over the documentation, it may at first appear a daunting task; however, today we'll walk you through the process by creating a backup destination utilizing Dropbox and their very thoroughly documented API.
Special thanks to @Tim Mullin for helping me get this off the ground by providing a PoC.
cPanel 78+
CPAN WebService::Dropbox
Install CPAN WebService::Dropbox
# CentOS 7
sudo cpan WebService::Dropbox
# CentOS 6
sudo yum -y install perl-YAML
sudo cpan WebService::Dropbox
During the CPAN installation for WebService::Dropbox, you may be prompted "...just needed temporarily during building or testing. Do you want to install it permanently?" These are relatively small modules and having them installed will help with future CPAN module installations, so I chose "yes" for each prompt.
Download the script
# escalate to root
sudo su - root
# clone and copy the script from github
cd /usr/local/src
git clone https://github.com/CpanelInc/backup-transport-dropbox.git
cp -av backup-transport-dropbox/backup_transport_dropbox.pl /usr/local/bin/
If you don't already have a Dropbox account, create one here. Once you have an account, head over to their developer section to create an app(this is required to use their API). You'll be prompted to select the typical Dropbox API or the Business API. For our testing purposes, we'll stick with the simple/free Dropbox API. For step two of the app creation process, select Full Dropbox. Finally, set a name for your app; I chose 'cpanel-backups'.
After creating the Dropbox app, you'll be redirected to the Settings page for your app, which will provide your API credentials. Write down the App Key, App Secret, click the Generate access token button and write it down as well
With your favorite text editor, take the Dropbox credentials you saved earlier and update the MY_APP_KEY, MY_APP_SECRET, and MY_ACCESS_TOKEN placeholders in the transport script.
We're now ready to configure the transport in WHM. Head over to WHM » Backup » Backup Configuration and scroll down to Additional Destinations. Under Destination Type, select Custom, then Create new destination. Configure the destination as below(note, since we're using the API keys directly in the transport script, you can enter anything for the host, user, and password):
Be sure to hit Save and Validate Destination at the bottom of the screen.
Congratulations, you've just created your first custom backup transport script, how cool is that?! Feel free to fork us on GitHub and be sure to share with us your custom backup transport scripts!