Child pages
  • Backup Tarball Contents
Skip to end of metadata
Go to start of metadata

This document is for a previous release of cPanel & WHM. To view our latest documentation, visit our Home page.

For cPanel & WHM 11.42

Overview

You can create a backup file in the WHM Configure Backup interface, or the cPanel Backups or Backup Wizard interfaces. When you do this, the system creates a tarball (.tar.gz) file, which contains compressed versions of an account's files.

This document provides information about the structure and contents of the backup tarball file. 

A note about backups

The backup process runs as the cPanel user for whom it backs up data. Anything a user cannot access is not backed up.

This means:

  • All of the files owned by the user are included in the backup.
  • Files the user does not own but has access to are included in the backup.
  • Files the user does not own and cannot access are not included in the backup — even if they are stored in the user's home directory.

Directories

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

Under the heading, you will find information about the file(s) within the given directory.

/resellerconfig

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

/suspended

File$user or $user.lock
DescriptionThis directory contains a copy of the file in /var/cpanel/suspended/ (e.g. /var/cpanel/suspended/$user or /var/cpanel/suspended/$user.lock)
ExampleThe file should contain the reason the account was suspended, if one exists.

/suspendinfo

Fileuser
DescriptionThis directory contains a copy of the file in /var/cpanel/suspendinfo/ (e.g. /var/cpanel/suspendinfo/$user)
Exampleshell=/bin/sh

/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
DescriptionThis file is a copy of the certificate-signing request (CSR).
ExampleThis file contains the certificate-signing request's data.

These files are copied from the following locations:

  • /usr/share/ssl/certs/
  • /etc/ssl/certs/
  • /var/ssl/certs/
  • /usr/local/ssl/certs/

/sslkeys

Filesexample.com.key
DescriptionThis file is 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----- 

/counters 

FilesThis directory contains a copy of any file owned by the current user contained within /var/cpanel/Counters/.
DescriptionEach of these files contain the current count for the web page hit counters.
Examplecpuser.dat

/bandwidth

Filesuser
DescriptionThis file is a copy of a file in /var/cpanel/bandwidth/ (e.g. /var/cpanel/bandwidth/$user).

/dnszones

Filesexample.com.
DescriptionThese files are copies of any DNS zone files associated with the cPanel account.

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. 

/va

Filesubdomain.example.com
DescriptionThis directory contains any auto responders associated with the account. (A copy of /etc/valiases/example.com)
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. (A copy of /etc/vdomainaliases/example.com)
Examplesub.example.com: example_fwd_dest.net

/vf 

Filessubdomain.example.com
DescriptionThis is a copy of an Exim filter.

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

#<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 

/fp

Warning:

Microsoft® discontinued support for FrontPage extensions on Linux servers in 2006. You should exercise caution when installing FrontPage extensions, as they have been known to cause security issues. It is recommended that you use another publishing method, such as FTP or WebDAV. For security reasons, we no longer provide FrontPage extensions within EasyApache. If you wish to install FrontPage, you must install the Custom Module.
Fileswww.example.com:$port.cnf
DescriptionThis directory contains a copy of /usr/local/frontpage/www.example.com:$port.cnf
Example
SMTPHost:127.0.0.1
SendmailCommand:/usr/sbin/sendmail
MailSender:webmaster@example.com
Filesexample.com:$port.cnf
DescriptionThis directory contains a copy of /usr/local/frontpage/example.com:$port.cnf
Example
SMTPHost:127.0.0.1
SendmailCommand:/usr/sbin/sendmail
MailSender:webmaster@example.com
Filessites/example.com.conf
DescriptionThe sites/ subdirectory contains virtual host configuration files.
Example
<VirtualHost 192.168.0.1:80> DocumentRoot /home/user/public_html ServerAdmin webmaster@example.com ServerName example.com User $user Group $group </VirtualHost>

/proftpdpasswd

Fileuser
DescriptionThis directory contains a copy of the ProFTP passwd file at /etc/proftpd/user/.
Example
cpuser:$1$02GrBhKb$6sG4242432dAODwAA5GpUs4/:1000:1000:User &:/home/cpuser:/bin/sh<br>ftp::1001:1006::/home/cpuser/public_ftp:/usr/local/bin/bash<br>cpuser_logs:$1$02erBhKb$dsafassfsIO8dAODwAA5GpUs4/:1002:1002:cpuser:/usr/local/apache/domlogs/cpuser:/bin/ftpsh

/logs

Filessub.example.comftp.example.com www.example.com example.com
DescriptionThis directory contains copies of log files found in /usr/local/apache/domlogs
ExampleThe contents of each file will differ based on what information the log file is responsible for tracking.

/userdata

Filessub.example.comexample.commain
DescriptionThe files within this directory contain the user data of any subdomain or domain associated with the cPanel account. Files contained within this directory are copied from /var/cpanel/userdata/$user/

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: ''

/horde

Filesmeta.yaml
DescriptionThis file contains the metadata for the Horde account.
Example
"apps":
  "content":
    "version": 2
  "horde_alarm":
    "version": 1
  "horde_auth":
    "version": 1
  "horde_cache":
    "version": 2 
Filesfilename.csv
DescriptionEach .csv file contains the data from one Horde data table.
ExampleThe contents of each file will differ based on the information stored in the originating table. Only Horde tables that contain user data will be saved as .csv files. The following tables may be converted into .csv files: 
  • horde_alarms
  • horde_dav_collections
  • horde_dav_objects
  • horde_histories
  • horde_muvfs
  • horde_prefs
  • horde_vfs
  • ingo_forwards
  • ingo_lists
  • ingo_rules
  • ingo_shares
  • ingo_shares_groups
  • ingo_shares_users
  • ingo_sharesng
  • ingo_sharesng_groups
  • ingo_sharesng_users
  • ingo_spam
  • ingo_vacations
  • kronolith_events
  • kronolith_events_geo
  • kronolith_events_mysqlgeo
  • kronolith_shares
  • kronolith_shares_groups
  • kronolith_shares_users
  • kronolith_sharesng
  • kronolith_sharesng_groups
  • kronolith_sharesng_users
  • kronolith_storage
  • mnemo_memos
  • mnemo_shares
  • mnemo_shares_groups
  • mnemo_shares_users
  • mnemo_sharesng
  • mnemo_sharesng_groups
  • mnemo_sharesng_users
  • nag_shares
  • nag_shares_groups
  • nag_shares_users
  • nag_sharesng
  • nag_sharesng_groups
  • nag_sharesng_users
  • nag_tasks
  • rampage_objects
  • rampage_tag_stats
  • rampage_tagged
  • rampage_tags
  • rampage_types
  • rampage_user_tag_stats
  • rampage_users
  • turba_objects
  • turba_shares
  • turba_shares_groups
  • turba_shares_users
  • turba_sharesng
  • turba_sharesng_groups
  • turba_sharesng_users

/httpfiles

Description: This directory contains custom virtual host 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> 

/mysql

Filesuser_database.sql
DescriptionThese files are MySQL dumps of any MySQL databases owned by the cPanel account.

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 
Filehorde.sql
DescriptionThis file contains turba_objects from the horde database, where owner_id matches $dnslist.

Example:

-- MySQL dump 10.13  Distrib 5.1.37, for pc-linux-gnu (i686)
--
-- Host: localhost    Database: horde
-- ------------------------------------------------------
-- Server version       5.1.37-log

/*!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 data for table `turba_objects`
--
-- WHERE:  owner_id='example' or owner_id REGEXP '@(abc\.com|s1766\.abc\.com|superfluous749\.test|superfluous101\.test|template1\.abc\.com|superfluous1018\.test|s1271\.abc\.com|s1148\.abc\.com|s1734\.abc\.com|superfluous783\.test|s 

/psql

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

/mm

Filesmailinglist.example.com/ (subdirectory), config.pckconfig.pck.lastrequest.pck
DescriptionThis directory contains files associated with any mailman mailing list associated with the cPanel account. Each mailing list will have its own subdirectory within the mm/ directory.
ExampleThe contents of each file contained within the mm/ directory's subdirectories will vary depending on what kind of information the configuration file stores.

/mms

Filesmailinglist.example.com/ (subdirectory), config.pckconfig.pck.lastrequest.pck
DescriptionThis directory contains files from /usr/local/cpanel/3rdparty/mailman/suspended.lists
ExampleThe contents of each file contained within the mm/ directory's subdirectories will vary depending on what kind of information the configuration file stores.

/mma

Directorypub/
DescriptionThis subdirectory (/mma/pub/) contains all of the mailman files associated with the account's domains from /usr/local/cpanel/3rdparty/mailman/archives/public. The files are divided into subdirectories that correspond to the mailing lists to which they belong.
Example 
Directorypriv/
DescriptionThis subdirectory (/mma/priv/) contains all of the mailman files associated with the account's domains from /usr/local/cpanel/3rdparty/mailman/archives/private. The files are divided into subdirectories that correspond to the mailing lists to which they belong.
Example 

/homedir

DescriptionThis directory contains a copy of the account's home directory, as defined by (getpwnam(4user))[7];.
ExampleThe contents of this directory will depend on the contents of the user's home directory.

/cp

Filesuser
DescriptionThis directory contains the cPuser file found in /var/cpanel/users/$user

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=x3
STARTDATE=1250193678
USER=user 

/cron

Filesuser
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
2,58 * * * * /usr/local/bandmin/bandmin
0 0 * * * /usr/local/bandmin/ipaddrmap
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 

Files not contained by a directory

The headings below represent files in the tarball which are not contained by a directory.

addons

This file contains a list of addon domains matched to their relative subdomains.

Example:

example.com=example.net 

homedir_paths

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

Example:

/home/user/ 

/mysql.sql

This file contains the MySQL grants for any MySQL databases associated with the cPanel account.

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

This file contains a list of files that can be found in the user's home directory and are owned by the system user nobody.

pds

This file contains a list of parked domains associated with the cPanel account.

Example:

  • example.com
  • example.net
  • example.org

 

proftpdpasswd

This file contains a copy of the ProFTPd password file located at /etc/proftpd/$user

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

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

sds

A list of subdomains associated with the cPanel account.

Example:

  • sub1.example.com
  • sub2.example.com
  • sub3.example.com

sds2

This file contains a list of subdomains associated with their relative document roots.

Example:

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

shadow

This file contains a copy of the user's password defined by ( getpwnam($user) )[1].

Example:

shell

This file contains the user's login shell.

Example:

  • /bin/bash

ssldomain

This file contains the domain that uses SSL associated with the cPanel account.

Example:

  • example.com

version

This file contains the package account version and the archive version for the cPanel account.

Example:

  • pkgacct version: 8.3
  • archive version: 3