Skip to main content

How to restore from a system backup

Cody Selzer
  • Updated

Introduction

The cpconftool script can be used to restore cPanel system configurations, such as the Exim and cPHulk configurations, from cPanel-generated system backups.

Please note that cPanel-generated system backups do not contain OS-level configurations, such as the network and SSH configurations.

 

Procedure

The following instructions assume that the backup to restore from is already on the server.

  1. Access the server's command line as the 'root' user.
  2. Run the cpconftool script with the --list-modules option to list the modules. 
    [root@server ~]cPs# /usr/local/cpanel/bin/cpconftool --list-modules
    cpanel::easy::apache
    cpanel::smtp::exim
    cpanel::system::autossloptions
    cpanel::system::backups
    cpanel::system::greylist
    cpanel::system::hulk
    cpanel::system::modsecurity
    cpanel::system::mysql
    cpanel::system::whmconf
    cpanel::ui::themes
    [root@server ~]cPs#
  3. Run the cpconftool script with the --restore option to restore a configuration.
    /usr/local/cpanel/bin/cpconftool --restore=/path/to/backup.tar.gz --modules=configuration::to::restore
    Please note that "/path/to/backup.tar.gz" must be replaced with the full path to the backup file and "configuration::to::restore" must be replaced with a module from the above modules list, such as "cpanel::smtp::exim."

 

Additional resources

The cpconftool Script: Restore configuration settings

Related articles