Page tree
Skip to end of metadata
Go to start of metadata

For cPanel & WHM version 60

Overview

This document describes the structure and contents of the backup tarball file. You can create a backup file in any of the following interfaces:

  • WHM's Backup Configuration interface (Home >> Backup >> Backup Configuration).
  • cPanel's Backup interface (Home >> Files >> Backup).

When you create a backup file, the system creates a tarball (.tar.gz) file, which contains compressed versions of an account's files.

Note:

The backup process runs as the cPanel user for whom it backs up data. The system does not back up anything that the user does not own and cannot access.

  • The system includes all of the files that the user owns in the backup file.
  • The system includes any files that the user does not own but can access to in the backup file.

Directories

Each of the headings below represents a directory that the backup's tarball (.tar.gz) file contains.

Under each heading, you will find information about the file or files within the directory.

Fileuser
DescriptionThis file contains the user's OAuth2 authentication information.

/bandwidth

Fileuser
DescriptionThis file contains a copy of the file in the /var/cpanel/bandwidth/ directory. For example, /var/cpanel/bandwidth/$user

/bandwidth_db

Fileuser
DescriptionThis file contains a copy of the file in the /var/cpanel/bandwidth_db directory.

Important:

The system stores bandwidth information in the /bandwidth_db.json file. The system creates the /bandwidth and /bandwidth_db directores, but does not store any data in these directories.

/counters 

FileThis directory contains a copy of any file that the current user owns within the /var/cpanel/Counters/ directory.
DescriptionEach of these files contains the current count for the webpage hit counters.
Examplecpuser.dat

/cp

Fileuser
DescriptionThis directory contains the cPuser file that is in the /var/cpanel/users/$user directory.
Example
# cPanel -- If you edit this file directly you must run /usr/local/cpanel/scripts/updateuserdomains afterwards to rebuild the system caches
BWLIMIT=unlimited
CONTACTEMAIL=webmaster@example.com
CONTACTEMAIL2=
DEMO=0
DNS=example.com
FEATURELIST=default
HASCGI=1
IP=192.168.0.1
LANG=english-utf8
LOCALE=en
MAXADDON=10
MAXFTP=unlimited
MAXLST=unlimited
MAXMONGREL=4
MAXPARK=unlimited
MAXPOP=unlimited
MAXSQL=unlimited
MAXSUB=unlimited
MTIME=1270977213
OWNER=reseller
PLAN=default
RS=paper_lantern
STARTDATE=1250193678
USER=user 

/cron

Fileuser
DescriptionThis directory contains a copy of the cPanel account's crontab.
Example
11,26,41,56 * * * * /usr/local/cpanel/whostmgr/bin/dnsqueue > /dev/null 2>&1
30 */4 * * * /usr/bin/test -x /usr/local/cpanel/scripts/update_db_cache && /usr/local/cpanel/scripts/update_db_cache
45 */8 * * * /usr/bin/test -x /usr/local/cpanel/bin/optimizefs && /usr/local/cpanel/bin/optimizefs
*/5 * * * * /usr/local/cpanel/bin/dcpumon >/dev/null 2>&1
6 3 * * * /usr/local/cpanel/whostmgr/docroot/cgi/cpaddons_report.pl --notify
32 1 * * * /usr/local/cpanel/scripts/upcp
0 1 * * * /usr/local/cpanel/scripts/cpbackup
0 2 * * * /usr/local/cpanel/scripts/mailman_chown_archives
35 * * * * /usr/bin/test -x /usr/local/cpanel/bin/tail-check && /usr/local/cpanel/bin/tail-check
30 */2 * * * /usr/local/cpanel/bin/mysqluserstore >/dev/null 2>&1
0 6 * * * /usr/local/cpanel/scripts/exim_tidydb > /dev/null 2>&1 

/dnszones

Fileexample.com
DescriptionThis directory contains copies of the cPanel account's DNS zone files.
Example
$TTL 14400
example.com.   86400   IN   SOA   ns1.example.com.   host.example.com.   (
                  2010040700 ;Serial Number
                  86400 ;refresh
                  7200 ;retry
                  3600000 ;expire
                  86400 ;minimum
   )
example.com.   86400   IN   NS   ns1.example.com.
example.com.   86400   IN   NS   ns2.example.com.
example.com.   14400   IN   A   192.168.0.1
localhost   14400   IN   A   127.0.0.1
example.com.   14400   IN   MX   0   example.com.
mail   14400   IN   CNAME   example.com.
www   14400   IN   CNAME   example.com.
ftp   14400   IN   A   192.168.0.1
cpanel   14400   IN   A   192.168.0.1
whm   14400   IN   A   192.168.0.1
webmail   14400   IN   A   192.168.0.1
webdisk   14400   IN   A   192.168.0.1
192.168.0.1   14400   IN   PTR   example.com.example.com. 

/homedir

DescriptionThis directory contains a copy of the account's home directory, which the (getpwnam($user))[7]; expression retrieves.
ExampleThis directory contains the contents of the user's home directory.

/homedir/.cphorde

Notes:

  • In cPanel & WHM version 11.50, we removed the horde directory.
  • In cPanel & WHM version 11.50 and later, Horde SQLite database backups are not backwards compatible. For example, you cannot restore a Horde database backup that you created in cPanel & WHM version 11.52 to an installation of cPanel & WHM version 11.50.
DescriptionThis directory contains the Horde data for the cPanel account and its webmail accounts.
ExampleThis directory contains a horde.sqlite file.

/httpfiles

Description

This directory contains custom virtualhost templates.

Example
DocumentRoot /home/elrcom/public_html
Port 80
DirectoryIndex index.htm index.html
ServerRoot /usr/local/apache

<VirtualHost 10.215.215.221:80>
DocumentRoot /home/elrcom/public_html
ServerAdmin webmaster@elr.com
ServerName elr.com
User elrcom
Group elrcom
</VirtualHost> 

/ips

File/related_ips
DescriptionThis file contains the IPv6 addresses that exist on the account's server.
Example
2001:db8:0100:0006:0000:0000:0000:0000
2001:db8:0100:0006:0000:0000:0002:00ce
2001:0db8:85a3::8a2e:0370:7334

/logs

Filessub.example.comftp.example.com, www.example.comexample.com
DescriptionThis directory contains copies of log files in the /usr/local/apache/domlogs directory.
ExampleThe information that the log file tracks determines the contents of each file.

/mm

Filesmailinglist.example.com/config.pckconfig.pck.lastrequest.pck
DescriptionThis directory contains the cPanel account's Mailman mailing list files. Each mailing list possesses its own subdirectory within the mm/ directory.
ExampleThe contents of each file that the mm/ directory's subdirectories contain varies with the type of information that the configuration file stores.

/mma

Directorypub/
DescriptionThis directory contains all of the account's domains' Mailman files from the /usr/local/cpanel/3rdparty/mailman/archives/public directory. The system divides the files into subdirectories that correspond to the mailing lists to which they belong.
Directorypriv/
DescriptionThis directory contains all of the account's domains' Mailman files that the system associates with the account's domains from the /usr/local/cpanel/3rdparty/mailman/archives/private directory. The system divides these files into subdirectories that correspond to the mailing lists to which they belong.

/mms

Filesmailinglist.example.comconfig.pckconfig.pck.lastrequest.pck
DescriptionThis directory contains files from the /usr/local/cpanel/3rdparty/mailman/suspended.lists directory.
ExampleThe contents of each file within the mm/ directory's subdirectories varies with which type of information the configuration file stores.

/mysql

Filesuser_database.sql
DescriptionThis directory contains the MySQL® dumps of any MySQL databases that the cPanel account owns.
Example
-- MySQL dump 10.11
--
-- Host: localhost    Database: user_database
-- ------------------------------------------------------
-- Server version   5.0.90-community

/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
/*!40101 SET NAMES utf8 */;
/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
/*!40103 SET TIME_ZONE='+00:00' */;
/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;

--
-- Dumping routines for database 'user_database'
--
DELIMITER ;;
DELIMITER ;
/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;

/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;

-- Dump completed on 2010-04-30 12:43:09 

/psql

Filedatabase.tar
DescriptionThis file contains the cPanel account's PostgreSQL® database.
Filepsql_users.sql
DescriptionThis file contains all of the cPanel account's PostgreSQL users.
Exampleuser_name
Filepsql_grants.sql
DescriptionThis file contains all of the cPanel account's PostgreSQL grants.
ExampleGRANT ALL ON DATABASE user_db TO user

/resellerconfig

Fileresellers-nameservers
DescriptionThis file contains the user's line from the /var/cpanel/resellers-nameservers file.
Example cpuser:192.168.0.1,192.168.0.2
Fileresellers
DescriptionThis file contains the user's line from the /var/cpanel/resellers file.
Examplecpuser:list-accts,show-bandwidth,suspend-acct

/sslcerts

Fileexample.com.crt
DescriptionThis file is a copy of the domain's certificate.
ExampleThis file contains the certificate's data.
Fileexample.com.cabundle
DescriptionThis file is a copy of the domain's CA bundle.
ExampleThis file contains the CA bundle's data.
Fileexample.com.csr
Description

This file contains a copy of the certificate-signing request (CSR).

These system copies these files from the following locations:

/usr/share/ssl/certs/
/etc/ssl/certs/
/var/cpanel/ssl/installed/certs
/usr/local/ssl/certs/
ExampleThis file contains the certificate signing request's data.

/sslkeys

Filesexample.com.key
DescriptionThis file contains a copy of an SSL key.
Example
-----BEGIN RSA PRIVATE KEY-----
MIICXAIBAAKBgQDhtHrjvvMJsCeHtWone6IahJ5bOxPF8LfYwDud0TTlSt6vsFHj
BfFMjGSP+6y7N4IDfNT2MZrRqvpKBrddR15Fb0BuHAx+2yIwsJnopWSI0/9C6Fp2
eMfiJyGx/+akzdWdbKW6IFp09xmO5/lcOqHfMx6JCfzZM3YjN2rXuZ+8tQIDAQAB
AoGATrYJETl7OkqzTnFmxsQn4QWU0A4HNEVhZ/aKE9xsjPYSOMTNmdVttBtVypyj
PVr7PUogXocoDayJwp0a/y2vYvG5oblSuFWoPXkAYYpFHIT0V+U9X9Z4Wl/7SKs7
S7woIcQZd8+MNXgp21YrTiz1agpFCLdQJFIou7yseYxKlpUCQQD7Tz2AUCx8Dv9a
Ai1ukMGunUcnqNQnLyfLaBJgk78Yz9KiszxopIZhZxfIVtP71OCFX0S0KbJRllLi
WGB4nMMnAkEA5ermq7QPKS4m9p+tkGIwv7CgroAXSCbnlZrQN8r776aBc/chG27z
YsYESkUlK0gsPKY4t0Orp/yUSkWeWSX6wwJAB4cBFZXRL0oXte94wuYNFxjY58Qz
zpSoAXy1iDUEtU6MRZlOxueeqs42tSZ8pP9kVjpbSXYyRCVXiDYTdalkYwJBANZM
jTaLfPoYL27+REtoiiGRoyMi9xBkWsTB6MOoKg0kuFJ7jNtCHg75nHQRYOSnv7vD
/ucqZuwL67gSjdZwJPsCQB8lFaYMSPcCJefV84B3zrffbGlSbPAL2rEEsQyEqc9h
WHEx75HRVA9zQGB+DjQlVVWaf7v4sz1Y7wlLLbMsN3E=
-----END RSA PRIVATE KEY----- 

/suspended

File$user or $user.lock
DescriptionThis directory contains a copy of the file in the /var/cpanel/suspended/ directory. For example, /var/cpanel/suspended/$user or /var/cpanel/suspended/$user.lock
ExampleThe file contains the reason for the account suspension, if one exists.

/suspendinfo

Fileuser
DescriptionThis directory contains a copy of the file in the /var/cpanel/suspendinfo/ directory. For example, /var/cpanel/suspendinfo/$user
Exampleshell=/bin/sh

/userconfig

Fileuser
DescriptionThis directory contains a copy of the file in the /var/cpanel/userconfig/ directory.
ExampleThis file contains symlinks from the user's public_html directory.

/userdata

Filessub.example.comexample.commain
DescriptionThis directory contains the user data of any cPanel account's subdomain or domain. The system copies files within this directory from the /var/cpanel/userdata/$user/ directory.
Example
--- 
customlog: 
  - 
    format: combined
    target: /usr/local/apache/domlogs/example.com
  - 
    format: "\"%{%s}t %I .\\n%{%s}t %O .\""
    target: /usr/local/apache/domlogs/example.com-bytes_log
documentroot: /home/$user/public_html
group: $group
hascgi: 1
homedir: /home/$user
ifmodulemoddisablesuexecc: {}

ip: 192.168.0.1
options: ExecCGI Includes
owner: $reseller
phpopenbasedirprotect: 1
port: 80
removehandler: 
  - 
    removehandler: cgi-script .cgi .pl .plx .ppl .perl
scriptalias: 
  - 
    path: /home/$user/public_html/cgi-bin
    url: /cgi-bin/
  - 
    path: /home/$user/public_html/cgi-bin/
    url: /cgi-bin/
serveradmin: webmaster@example.com
serveralias: www.example.com
servername: example.com
usecanonicalname: 'Off'
user: $user
userdirprotect: ''

/va

Filesubdomain.example.com
Description

This directory contains any of the account's autoresponders. For example, a copy of the /etc/valiases/example.com file.

Exampleforwarder@example.com: "/usr/local/cpanel/bin/autorespond forwarder@example.com /home/user/.autorespond" *: user

/vad

Filessbudomain.example.com
DescriptionThis directory contains a copy of the account's virtual domain aliases. For example, a copy of the /etc/vdomainaliases/example.com file.
Examplesub.example.com: example_fwd_dest.net

/vf 

Filessubdomain.example.com
DescriptionThis file contains a copy of the user's Exim filter. The system creates copies of the filters that the user owns from the /etc/vfilters directory.
Example
# Exim filter

# Auto Generated by cPanel.  Do not manually edit this file as your changes will be overwritten.  If you must edit this filter, edit the corresponding .yaml file as well.

if not first_delivery and error_message then finish endif

#&lt;spam
if
$header_subject: contains "<spam"
then
save "/dev/null" 660
endif

#Test rule one
if
$header_from: is "me@example.com"
then
pipe "/home2/tramel/public_html/domain/modules/mail2forum/m2f_import.sh > /dev/null"
endif

#Total $10, 000
if
$header_from: is "me@example.com"
then
save "/dev/null" 660
endif

#Generated SpamAssassin Discard Rule
if
$h_X-Spam-Bar: contains "++++++++"
then
save "/dev/null" 660
endif 

Files with no directory

The headings below represent files in the tarball that are not directories.

addons

Description

This file contains a hash of addon domains and their relative subdomains.

Example
example.com=example.net 

bandwidth_db.json

Description

This file contains user bandwidth data information.

Example

None

has_sslstorage

Description

This file contains a touch file that indicates the account uses WHM's SSL Storage Manager feature (Home >> SSL/TLS >> SSL Storage Manager).

Example
crtindex.txt

homedir_paths

Description

This file contains the full path to the cPanel user's home directory.

Example
/home/user/

/mysql.sql

Description

This file contains the MySQL grants for the cPanel account's MySQL databases.

Example
GRANT USAGE ON *.* TO 'user'@'localhost' IDENTIFIED BY PASSWORD '*BF92437D34E1616098F0EFAB1B4891B877C8C094';
GRANT ALL PRIVILEGES ON `user`.* TO 'user'@'localhost';
GRANT ALL PRIVILEGES ON `user\_%`.* TO 'user'@'localhost';
GRANT USAGE ON *.* TO 'user_1'@'localhost' IDENTIFIED BY PASSWORD '*9F677A2C67F91BCB7452A24EFCDF63E81F1E80C9';
GRANT USAGE ON *.* TO 'user_h'@'localhost' IDENTIFIED BY PASSWORD '*667F407DE7C6AD07358FA38DAED7828A72014B4E';
GRANT USAGE ON *.* TO 'user_wpchavi'@'localhost' IDENTIFIED BY PASSWORD '*9F677A2C67F91BCB7452A24EFCDF63E81F1E80C9';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, CREATE ROUTINE ON `user\_database`.* TO 'user_wpchavi'@'localhost'; 

 

 

nobodyfiles

Description

This file contains a list of files in the user's home directory that the nobody system user owns.

ExampleNone

 

pds

Description

This file contains a list of the cPanel account's parked domains (aliases).

Example
example.com
example.net
example.org

proftpdpasswd

Description

This file contains a copy of ProFTPd's /etc/proftpd/$user file.

Example
user:$1$02GrBhKb$6sG4242432dAODwAA5GpUs4/:1000:1000:User &:/home/cpuser:/bin/sh
ftp::1001:1006::/home/cpuser/public_ftp:/usr/local/bin/bash
user_logs:$1$02erBhKb$dsafassfsIO8dAODwAA5GpUs4/:1002:1002:cpuser:/usr/local/apache/domlogs/cpuser:/bin/ftpsh 

quota

DescriptionThis file contains the quota size (in bytes) from the /etc/quota.conf file.
ExampleNone

 

sds

Description

This file contains a list of the cPanel account's subdomains.

Example
sub1.example.com
sub2.example.com
sub3.example.com

sds2

Description

This file contains a hash of subdomains and their relative document roots.

Example
sub1_example.com=public_html/sub1
sub2_example.com=public_html/sub2
sub3_example.com=public_html/sub3

shadow

Description

This file contains a copy of the user's password that the ( getpwnam($user) )[1] command returns.

Example
$2$QU65s61I$/Ud5Ps/sItj5ipT41ETuh1user@example.com

shell

Description

This file contains the user's login shell.

Example
/bin/bash

ssldomain

Description

This file contains the cPanel account's domain that uses SSL.

Example
example.com

version

Description

This file contains the cPanel account's pkgacct version and its archive version.

Example
pkgacct version: 8.3
archive version: 3

Additional documentation

There is no content with the specified labels

There is no content with the specified labels

There is no content with the specified labels

There is no content with the specified labels