CPanel User Documentation

cPanel User Documentation
This documentation describes the features of the cPanel interface.
How to Access cPanel & WHM Services This document details how to log in to cPanel, WHM,
and Webmail.
The cPanel Home Interface This document describes the Home interface, which provides access
to all of your cPanel functions.
Preferences These documents describe the features in the Preferences section. This section
includes a setup wizard and general cPanel settings.
Mail These documents describe the features in the Mail section. This section includes all of
cPanel's email-related features.
Files These documents describe the features in the Files section. This section includes
cPanel's backup system, file managers, HTML editor, FTP configuration, and WebDiskconfiguration.
Logs These documents describe the features in the Logs section. This section includes error logs,
information about bandwidth usage, and statistical analysis software.
Security These documents describe the features in the Security section. This section includes
shell access, leech protection, hot link protection, and other security-related features.
Domains These documents describe the features in the Domains section. This section includes
features that allow you to manage subdomains, addon domains, parked domains, and redirects.
Databases These documents describe the features in the Databases section. This section
includes features that allow you to manage MySQL and PostgreSQL databases.
Software/Services These documents describe the features in the Software/Services section. This
section includes features that allow you to install Perl packages, and manage CGI and PHP and
PEAR packages.
Advanced These documents describe the features in the Advanced section. This section includes
features that allow you to manage advanced cPanel tasks (for example, cron jobs or MIME types).
The Password Generator You can use the Password Generator to generate secure passwords for
your accounts.
Page 1
1.0
How to Access cPanel & WHM Services
1.1
Overview
How to read a URL
How to access cPanel
How to access WHM
How to access Webmail
o Access webmail from the cPanel interface
o Access webmail directly
How to change an interface's locale
Overview
This document describes how to access cPanel, WHM, and Webmail with or without SSL.
Important:
Icon
We strongly recommend that you log in over an encrypted SSL connection. An encrypted SSL
connection will not transmit your username and password in plain text over the Internet.
For more information about cPanel, WHM, and Webmail connections, read our How to Configure
Your Firewall for cPanel & WHM's Services documentation.
Note:
Icon
In the following examples, replace 192.168.0.1 with your IP address and
replace example.com with your domain name.
1.2
How to read a URL
The URL is composed of four sections:
Page 2
Section
Description
Example
Protocol
The protocol that your browser will use to communicate with a

remote server. For cPanel, WHM, and Webmail, this value is
either http or https. httpsis http over an encrypted
connection. We strongly recommend that you use https whenever
you access cPanel & WHM services.
https://
Address
The address can consist of either an IP address (for

example, 192.168.0.1) or a domain (for
example, example.com). This section of the URL specifies the
remote server that you wish to access. When you use a domain
name to access cPanel & WHM services name, make sure that the
domain's DNS information has propagated across the domain name
system (DNS).
example.com
Port
number
When you access most websites via http or https, the port
number is implied. However, cPanel & WHM services use their own
set of port numbers. If you wish to access a cPanel & WHM service
over an encrypted or unencrypted connection, you must specify the
port number. https and http port numbers are different, even for
the same service. To specify a port number, enter a colon (:)
followed by a number.
2083
Security
token
After you log in to your server, it will automatically append a

security token to the URL for your session. Security tokens help
prevent authorized use of a website through XSRF (Cross-Site
Request Forgery). Security tokens contain the string cpsess and a
10-digit number.
cpsess1234567890
1.3
How to access cPanel
Your domain's DNS information must propagate before you can access cPanel with your domain
name. If you cannot access the cPanel interface with your domain name, use your domain's IP
address.
Page 3
Your domain can take approximately 48-72 hours to propagate after you set up your website, After
your domain propogates, navigate to your website via your domain name (for
example,https://example.com:2083)
To access cPanel, perform the following steps:
1. Enter one of the following URLs in your preferred browser:
a. https://192.168.0.1:2083 This URL allows you to access cPanel over an encrypted
connection with your IP address.
b. https://example.com:2083 This URL allows you to access cPanel over an
encrypted connection with your domain name.
c. http://192.168.0.1:2082 This URL allows you to access cPanel over an
unencrypted connection with your IP address.
d. http://example.com:2082 This URL allows you to access cPanel over an
unencrypted connection with your domain name.
2. Enter your cPanel username in the Username text box.
3. Enter your password in the Password text box.
4. Click Log in.
1.4
How to access WHM
Your domain's DNS information must propagate before you can access WHM with your domain
name. If you cannot access the WHM interface with your domain name, use your domain's IP
address.
To access WHM, perform the following steps:
1. Enter one of the following URLs in your preferred browser:
a. https://192.168.0.1:2087 This URL allows you to access WHM over an encrypted
b. https://example.com:2087 This URL allows you to access WHM over an encrypted
connection with your domain name.
c. http://192.168.0.1:2086 This URL allows you to access WHM over an unencrypted
d. http://example.com:2086 This URL allows you to access WHM over an
2. Enter your WHM username in the Username text box.
3. Enter your password in the Password text box.
4. Click Log in.
Page 4
1.5
How to access Webmail
Your domain's DNS information must propagate before you can access to Webmail with your
domain name. If you cannot access the Webmail interface with your domain name, use your
domain's IP address.
1.5.1 Access webmail from the cPanel interface

The Webmail icon will not display if you logged in with the reseller or root password.
To access Webmail from the cPanel interface, either click the Webmail icon in the Mail section of the
cPanel Home interface, or perform the following steps:
1. Navigate to cPanel's Email Accounts interface (Home >> Mail >> Email Accounts).
2. Click More in the row that corresponds to the email account for which you wish to access
Webmail.
3. Select Access Webmail.
4. Enter the password for the selected email account, and click Log In.
5. Click the logo or the Read Mail Using link for your preferred webmail application. The
interface for your chosen webmail application will appear.
a. If you are not sure which webmail application you should use, read our Which
Webmail Application Should I Choose? documentation.
b. Click Enable AutoLoad if you want the chosen webmail application to load
automatically the next time that you access Webmail.
6. The webmail client will retrieve and display all of your email account's read and unread
messages.
1.5.2 Access webmail directly

To access webmail directly from your web browser, perform the following steps:
1. Enter one of the following URLs:
a. https://192.168.0.1:2096 This URL allows you to access your Webmail over an
encrypted connection with your IP address.
b. https://example.com:2096 This URL allows you to access your Webmail over an
encrypted connection with your domain name.
c. http://192.168.0.1:2095 This URL allows you to access your Webmail over an
unencrypted connection with your IP address.
d. http://example.com:2095 This URL allows you to access your Webmail over an
2. Enter the email address (for example, user@example.com) and password.
3. Click Log In.
Page 5
4. Click the logo or the Read Mail Using link for your preferred webmail application.The
interface for your chosen webmail application will appear.
a. If you are not sure which webmail application you should use, read our Which
Webmail Application Should I Choose? documentation.
b. Click Enable AutoLoad if you want the chosen webmail application to load
automatically the next time that you access Webmail.
5. The webmail client will retrieve and display all of your email account's read and unread
messages.
1.6
How to change an interface's locale
You can choose a new language setting (locale) in which to view an interface.
This change sets a cookie in your browser that expires after one year. You must perform this step
whenever you log in to an account from a new browser, when you delete cookies, and after the
cookie expires.
To change an interface's locale, perform the following steps:
1. At the bottom of the login interface, click the desired locale name.
2. The interface will refresh and a message of success will appear.
Note:
If your browser's Accept-Language header is set, then the login interface will attempt to display the
locale that corresponds to your browser setting. If the locale that the browser's header requests is
not available, the login interface appears in English.
2.0
The cPanel Home Interface
For cPanel & WHM 11.44
2.1
Overview
Customize the cPanel interface
cPanel interface features
o Stats
o Home interface preference links
Overview
cPanel's Home interface provides access to all of cPanel's features.
Page 6
Notes:
The options that are available in your cPanel Home interface, and its appearance, depend on the
way in which your web host configures cPanel and your account. For more information, contact your
hosting provider.
2.2
Customize the cPanel interface
The cPanel interface organizes features into boxed sections, to allow you to find related features
quickly.
2.3
To change the order in which these sections appear, click and drag a section's heading bar
to the new position in the interface.
To hide a section, click the icon in the top right corner of the heading bar.
To reveal a hidden section, click the icon in the top right corner of the header bar.
cPanel interface features
The following interface features are available in cPanel's Home interface, organized by location.
Feature
Description
Home
Click the Home icon from anywhere in the cPanel interface

to return to the Home interface. You can also click
the Home link at the bottom of any interface to return to
the Home interface.
This icon is located at the top of every cPanel interface.
Help
The Help feature opens a new window with information

about the current interface, a link to the cPanel & WHM
documentation, links to video tutorials, and a link to
the Contact Customer Support interface (Home >>
Contact Customer Support) that you can use to contact
customer support.
The Help icon is located at the top of every cPanel
interface.
Notes:
Icon
Page 7
Feature
Description
You can also access the Help and Contact Customer

Support features, and our documentation, from the links at the
bottom of the interface.
Your hosting provider determines if the Contact Customer
Support feature is available.
Click the Logout icon to log out of your cPanel

account. You can also access this feature from
the Logout link at the bottom of the interface.
Important:
Logout
Icon
Make certain that you click Logout after you access your
cPanel account from any computer that others may use.
This icon is located at the top of every cPanel interface.
The theme is the framework of the cPanel interface. Use

the Switch Theme menu to switch to a different theme.
Switch Theme
Your web host's configuration determines the themes that are

available to you.
This documentation is for the x3 theme. For more information
about the Paper Lantern (paper_lantern) theme, read our Paper
Lantern documentation.
This feature is located on the left side of the

cPanel Home interface.
The Notices feature displays important messages from your
hosting provider.
Notices
Enter a keyword in the Find text box to search for a cPanel

feature.
Find
The icons that display will automatically filter to show the

results.
To unfilter the Home interface, click X to the right of the text
Page 8
Feature
Description
box.

This section displays links to the cPanel features that you
access the most often.
Frequently Accessed Areas
The Stats table displays information about your cPanel

account and its resource usage. To increase your account's
resources, contact your hosting provider about an upgrade
to your hosting plan.
Stats
Switch Account
Click expand stats to view more information about your

account.
For more information about this feature, read the Stats section
below.

The Switch Account feature allows resellers to select
another cPanel account to manage from within the cPanel
interface.
Note:
Icon
This feature only appears in the cPanel interface if you are

the administrator of more than one cPanel account and
your hosting provider enables this feature.
This feature is located in the top center of the
cPanel Home interface .
2.3.1 STATS
Notes:
The CPU Usage, Memory Usage, and Entry Processes statistics are only available if your
server uses the CloudLinux operating system.
Page 9
The File Usage statistic is only available if your server administrator enables it.
The expanded Stats table displays the following information:
Statistic
Description
Main Domain
The primary domain on your account.
Home Directory
The directory on your server in which your websites folders and files reside.
Last login from
The IP address from which you last accessed your cPanel account.
CPU Usage
The amount of CPU that your cPanel account currently uses.
File Usage
The number of inodes (files and directories) that your account has used, and
your account's inode limit.
Memory Usage
The amount of memory that your cPanel account currently uses.
Entry Processes
The number of PHP scripts that are in use by your cPanel account.
Disk Space
Usage
The amount of disk space that your account occupies on the server, in Megabytes,
and the amount of disk space that is allocated to your account.
Monthly
Bandwidth
Transfer
The amount of data that has transferred to and from your account for the month
to date in Megabytes, and the total monthly bandwidth that is allocated to your
account.
Note:
If you see discrepancies between the information that cPanel provides and the
information that log processing programs (such as AWStats, Webalizer, or
Analog) provide, read our Apparent Discrepancies in Bandwidth Usage
Statistics documentation.
Email Accounts
The number of email accounts on your account, and the total number of email
accounts that your cPanel account allows.
Subdomains
The number of subdomains on your account, and the total number of subdomains
that your cPanel account allows.
Page 10
Statistic
Description
Parked
Domains
The number of parked domains on your account, and the total number of parked
domains that your cPanel account allows.
Addon Domains
The number of addon domains on your account, and the total number of addon
domains that your cPanel account allows.
FTP Accounts
The number of FTP accounts on your account, and the total number of FTP accounts
that your cPanel account allows.
Mailing Lists
The number of mailing lists on your account, and the total number of mailing lists that
your cPanel account allows.
All SQL
Databases
The number of SQL databases that you have created, and the number of databases
that you are able to create for each database type.
MySQL
Databases
The number of MySQL databases that you have created, and the potential number
of MySQL databases that you are able to create.
MySQL Disk
Space
The amount of disk space that your MySQL databases use.
Mailing List
Disk Space
The amount of disk space that your mailing lists use.
Hosting
package
The name of the web hosting plan that your hosting provider assigned to your cPanel
account.
Server Name
The name of your server.
cPanel Version
The version of cPanel & WHM that currently runs on your server.
Theme
The version of the cPanel interface layout that you currently use.
Page 11
Statistic
Description
Apache version
The version of the Apache server that currently runs on your server.
PHP version
The version of the PHP scripting language that currently runs on your server. This
information is useful when you install PHP scripts.
MySQL version
The version of MySQL that currently runs on your server. This information is useful
when you install MySQL databases on your website.
Architecture
The type of microprocessor that powers the server.
Operating
system
The system software that manages the server.
Shared IP
Address
If your domain uses a shared IP address, that IP address will display.

Note:
Icon
Multiple accounts on a cPanel & WHM server may share an IP address.

Dedicated IP
Address
If your domain uses a dedicated IP address, that IP address will display.
Path to
sendmail
The location of the sendmail program on your server. This is useful if, for example,
you create a script that allows visitors to send you email with a form on your website.
Path to Perl
The location of the Perl interpreter on your server. This information is necessary in
order to write Perl scripts.
Perl version
The version of Perl that runs on your server. This information is necessary in order to
write Perl scripts.
Kernel version
The version of your servers kernel, which is the central operating system component.
cPanel Pro
The version of the cPanel Pro software that currently runs on your server.
Page 12
Statistic
Description
Service Status
Click Click to View to display the Server Status interface, which displays the
status of the services on your server.
The Service Status interface may include the following services:
Service
Description
cpsrvd
The cPanel service daemon.
imap
An email protocol for mail retrieval.
httpd
The Apache webservers daemon. This daemon serves web pages

to your visitors.
named
The DNS server. This service is required in order for your domains
to appear on the Internet.
Server
Load
Your servers current CPU load. If this service's status icon is red,
your server has performance issues.
Memory
Used
The amount of RAM that your server uses, shown as a percentage.
Swap Used
The amount of swap memory that your server uses, shown as a

percentage. Servers use swap memory in place of RAM when there
is a RAM shortage.
Disk
/$volume
The amount of hard disk space that your server uses, shown as a
percentage. If this service's status icon is red, delete old or unused
files.
The Status column will display one of the following icons:

Status
Description
The service is running.
Page 13
Statistic
Description
The service is busy, or the disk space is almost full.

The service has a problem, or the disk space is full.
2.3.2 Home interface preference links

At the bottom of the Home interface, there are five links that change the basic display preferences of
cPanels interface.
Link name
Description
lite/full graphics
Toggles the display of the header and footer graphics, and allows for reduced
memory demands and load times.
hide/show icons
Toggles the display of the feature icons. They can display only hyperlinks, or both
icons and hyperlinks. Hide icons to reduce memory demands and load times.
reset all interface

settings
Click reset all interface settings to reset any changes to the interface.
Note:
Icon
The reset all interface settings link does not reset the current theme.
reveal all boxes
Click the reveal all boxes link to expand or reveal boxes that you minimized.
reset box order
Click the reset box order link to change the order of interface sections to cPanels
default setting.
3.0 Preferences
Page 14
(Home >> Preferences)

The following documents describe the features of the cPanel Preferences area.
3.1 Getting Started Wizard

The Getting Started Wizard appears the first time that you log in to cPanel and will guide you as you
configure some basic preferences. We strongly recommend that you complete this process.
(Home >> Preferences >> Getting Started Wizard)
Overview
Before you begin
Introduction to Web Hosting
Web Disk Accounts
New Email Account Setup
Set Default Address
Webmail
Contact Information & Preferences
Style
Manage SSH Keys
o Generate a key
o Import a key
Finish
Overview
After you log in for the first time, this wizard will appear. It functions as a guide to help you set up a
new cPanel account. If the Getting Started Wizard does not appear on the first login, or if it is
necessary to reconfigure your account, click Getting Started Wizard in the Preferences section of
cPanel's Home interface (Home).
Before you begin

Select the default display language for your cPanel interface and click Change.
Important:
When you choose a language that is not English, you may still see English text in some
areas of cPanel. We continue to work to provide 100% translation coverage, so there is no
need to report untranslated cPanel interfaces.
Page 15
Contact your web host if you need a language that does not appear in the Set my language
to menu.
Introduction to Web Hosting

The Getting Started Wizard displays information on an array of topics. Click Next Step to progress
through this information.
Note:
If this is your first website, we strongly recommend that you read these pages to better understand
website management.
Web Disk Accounts

cPanel offers a Web Disk application that you can use to manage and manipulate files. Newer users
may find that they are more comfortable with this file management method.
To log in to a Web Disk account, perform the following steps:
1. Click Access Web Disk.
2. Choose your the appropriate version or distribution of your operating system (OS).
Note:
3. If you use Windows Vista, Windows 7, or Windows 8, you must enable Digest
Authentication for your cPanel account. To do this, click Enable Digest Authentication.
4. Click Go under the appropriate operating system to download the script file.
5. Open and run the script file. Accept any certificates.
6. When the Web Disk configuration finishes, a new window that contains your websites
content will open on your computer. From this window, you can manage your websites files
just like you would manage files on your personal computer.
7. After you add a Web Disk account to you server, click Access Web Disk in the Web
Disk interface (Home >> Files >> Web Disk) to quickly access the account. You can also
change the password, delete, or password protect directories for existing Web Disk accounts
in this interface.
New Email Account Setup

To create a new email address, perform the following steps:
1. Enter the address that you wish to use in the Email text box.
Note:
Page 16
2. If your cPanel account includes more than one domain, select the domain from the menu.
3. Enter the password in the Password text box.
Note:
4. Click Generate Password to generate a strong password.
5. Confirm the password in the Password (Again) text box.
6. Enter the maximum amount of disk space to allow this email address to use in the Mailbox
quota text box.
7. Click Create.
Set Default Address

Your default address settings determine how cPanel handles any mail that was sent to an invalid
email address for the current domain.
To set up your default address settings, perform the following steps:
1. Select one of the following options:
a. Discard with error to sender Select this option to send an error message to the
sender when an email is sent to this address. Enter an error message in the text box.
b. Forward to email address Select this option to forward mail to another
address. Enter the address to which you wish to forward mail in the text box.
2. Click Advanced Options to view the following additional options:
a. Forward to your system account Select this option to forward mail to the system
account.
b. Pipe to a Program Select this option to forward messages to a program at the
path that you define in the Pipe to a Program text box.
Note:
3. For more information, read the Pipe to a Program section of our How to Configure Mail
Filters documentation.
a. Discard Select this option to delete incoming messages without a failure notice.
Important:
4. We do not recommend this option, because the sender will not know that the delivery failed.
5. Click Change.
6. Click Next Step.
Webmail
Webmail allows you to access your email accounts through a web browser (for example, Internet
Explorer or Safari). When you check your email on the web, rather than through an email
application on your computer, you can easily access your email account from any computer with an
Internet connection and a web browser.
Notes:
Page 17
To create a shortcut, drag the Access cPanel Webmail link to your desktop or Bookmarks
toolbar.
For more information, read our How to Access cPanel & WHM Services documentation.
Contact Information & Preferences

This feature allows you to define the email address(es) at which the server should send you
updates. These email addresses function as the main method to notify you of new information about
your website. We recommend that you use an email address that is not part of your cPanel account,
as this could be useful if your server experiences problems.
To configure these preferences, perform the following steps:
1. Enter the email address through which you wish the server to contact you.
2. Enter another email address through which you wish the server to contact you. This step is
optional.
3. Select or deselect the following checkboxes to specify when the server will contact you:
a. Send notifications to your contact email address when you are reaching your disk
quota. You will receive a notification if your website will soon reach the maximum
amount of disk space.
i. If you have a full disk quota, you cannot modify existing files or add new files
to your website.
ii. Delete old or unused files, or upgrade your hosting plan, to fix this issue.
b. Send notifications to your contact email address when you are reaching your
bandwidth usage limit. You will receive a notification if your website will soon have
received the maximum amount of traffic that it is allowed.
i. After you reach your maximum bandwidth, visitors cannot access your
website.
ii. You must upgrade your hosting plan to fix this issue. Otherwise, you must
wait until the limit resets. Generally, this limit resets at the end of each month.
c. Send notifications to your contact email address when one of your email accounts
approaches or is over quota. You will receive a notification if one of your email
addresses will soon use its maximum amount of disk space.
i. Delete old email, or upgrade your hosting plan, to resolve this issue.
4. Click Save.
Style
cPanel offers several interface styles. This includes a style for mobile web browsers.
To change your style, click Switch Style to ... for the style that you wish to use.
Page 18
Manage SSH Keys

Use SSH keys to confirm whether a specific computer can access your websites information
through an SSH session.
Generate a key
To generate a new key, perform the following steps:
1. Click Generate a new Key.
2. Fill in the appropriate information.
Note:
3. RSA keys yield a faster confirmation of identity, while DSA keys will speed up key generation
and signing times.
4. Select a key size from the menu.
Remember:
5. A larger key size is more secure, but will require a longer authentication time.
6. Click Generate Key to generate the new SSH key and automatically install it to the server.
Import a key
To import an existing key, perform the following steps:
1.
2.
3.
4.
Click Import Key.

Choose a name for the key.
Paste the private and public keys into the appropriate text boxes.
Click Import.
After you install a key on the server, you can edit, delete, or download it from the SSH/Shell
Access interface (Home >> Security >> SSH/Shell Access).
Important:
Keys will not work correctly until you authorize them.
Finish
After you finish the setup for your cPanel account, click Home in the upper left corner of the interface
to return to the Home interface and begin to use your cPanel account.
Page 19
Video Tutorials Click Video Tutorials to view the cPanel Video Tutorials site. These videos are
beneficial to new users who wish to better understand cPanel.
3.2 Change Password

(Home >> Preferences >> Change Password)
This interface allows you to change your cPanel interfaces main password.
Overview
Change password
Overview
This feature allows you to change your cPanel accounts main password.
Important:
To change your password, you must know your original password.
Change password
Important:
Use a secure password. A secure password is not a dictionary word and contains uppercase and
lowercase letters, numbers, and symbols.
To change your password, perform the following steps:
1. Enter the original password in the Old Password text box.
2. Enter and confirm the new password in the appropriate text boxes.
Notes:
a. The system grades the password that you enter on a scale of 100 points. 0 indicates
a weak password, while 100 indicates a very secure password.
b. Some web hosts require a minimum password strength. A green
password Strength meter indicates that you met the required password strength.
c. Click Password Generator to generate a strong password. For more information,
read our Password Generator documentation.
3. Select the Synchronize MySQL password checkbox if you wish to use the same password
for both MySQL and the cPanel account.
Note:
4. This option is only available if the .my.cnf file is present in the user's home directory.
Page 20
1. Select Enable Digest Authentication to enable Digest Authentication support.

a. This option allows you to access your Web Disk through a clear text connection or an
unencrypted connection.
b. If you use Windows Vista, Windows 7, or Windows 8 and you do not have an
SSL certificate that a recognized certificate authority has signed, you must enable
Digest Authentication.
2. Click Change your password now! to save the new password.
3. If you use this feature to change your password, your main FTP account password and
system email address password will also change.
Update Contact Info

This interface allows you to change your primary contact email addresses.
(Home >> Preferences >> Update Contact Info)
Overview
Contact settings
Overview
Use this interface to change your primary contact email addresses. These email addresses function
as the main contact points to notify you of new information about your website.
Note:
Icon
We recommend that you use an email address that is not affiliated with your website, in case you
experience problems with your websites email.
Contact settings
The series of check boxes below your email address(es) determine why cPanel might contact you.
cPanel may send you an email for any of the following occurrences:
Your disk quota is almost full Your website will soon reach the maximum amount of disk
space.
o If you have a full disk quota, you cannot modify existing files or add new files to your
website.
Page 21
o Delete old or unused files, or upgrade your hosting plan, to fix this issue.
Your bandwidth is reaching its limit Your website will soon have received the maximum
amount of traffic that it is allowed.
o After you reach your maximum bandwidth, visitors cannot access your website.
o You must upgrade your hosting plan to fix this issue. Otherwise, you must wait until
the limit is reset. Generally, this limit resets at the end of each month.
Your email accounts approach the quota One of your email addresses will soon use its
maximum amount of disk space.
o Delete old email, or upgrade your hosting plan, to resolve this issue.
3.3 Change Style

This interface allows you to choose from several cPanel styles. Styles (sometimes called
skins) change how the cPanel interface appears in your web browser.
3.4 Branding Editor

This interface allows you to edit the header and footer images in each theme as well as the main
page icons for the style.
(Home >> Preferences >> Branding Editor)
Overview
Create or Upload Branding
o Duplicate a branding style
o Upload a branding style
Download or Delete Branding
o Download a branding style
Edit a downloaded branding style
o Delete a Branding Style
Branding style options
Edit styles
o Change a Logo
o Change an Icon
o Change Headers and Footers
o Edit a User's GUI
o Change a Style's Preview Image
o Edit a Style's HTML
Use cPanel's HTML Editor
Upload Your Custom HTML page
o Edit a Style's CSS
Example branded login page
Page 22
Overview
This interface allows resellers to edit the header and footer images in each theme as well as the
main page icons for the style.
Important:
Icon
You must have root or reseller privileges in order to view this interface.
Create or Upload Branding

Click this option to duplicate the [root] style so that you may edit it, or upload a new style that you
created.
Duplicate a branding style

To duplicate a branding style, perform the following steps:
1.
2.
3.
4.
Click Create or Upload Branding.

Enter the new branding styles name in the Name text box.
Click Create. WHM will duplicate the [root] style.
Click one of the following options to edit the new style:
a. Go Back to Editing (style) Return to the Edit Branding Style interface.
b. Go Back to Branding Editor Return to the Branding Editor interface.
Upload a branding style

To upload a new branding style, perform the following steps:
1.
2.
3.
4.
5.
6.
7.
8.
Click Create or Upload Branding.

Click Choose File.
Select the file from your computer.
Note:
Icon
The expected file type is a tarball (.tar.gz).
Click Upload.
Click one of the following two options to edit the style that you uploaded:
a. Go Back to Editing (style) Return to the Edit Branding Style interface.
b. Go Back to Branding Editor Return to the Branding Editor interface.
Page 23
Download or Delete Branding

Click this option to download a style to your local computer so that you may edit it, or delete a style.
Download a branding style

To download a branding style, perform the following steps:
1. Click Download or Delete Branding.
2. Click the Download link that corresponds to the style that you wish to download.
Note:
3. If you have never downloaded the style before, click Download (System). If you have already
customized and uploaded a version of this style, you will have the option to select Download
(Yours) to re-download this style.
4. A *.tar.gz file will download to your computer.
Edit a downloaded branding style
After you download the style that you wish to edit, perform the following steps:
1. Extract the contents of the file. To accomplish this, perform one of the following actions:
a. If you use a Windows machine, download a program (for example, winRAR) to
extract the contents of the file. By default, Windows will not open a .tar.gz file.
b. If you use a Mac or *nix machine, use the tar -xvzf commandto extract the
contents of the .tar.gz file. You may also open it with an extraction program.
Note:
2. For more information on the tar command, run the man tar command from the command
line interface.
3. Make the desired changes to your files.
Remember:
a. The images that the .tar.gz file contains must maintain the same dimensions to
maintain the appearance of the style.
b. Make certain that the filenames remain the same, or the server will not place the files
correctly in the interface.
c. Use appropriate and clear icons to ensure that you and your cPanel users can easily
navigate the interface.
4. Before you upload the files to the server, place them in a .tar.gz file.
a. On a Windows machine, use the same program that you used to extract the original
file contents to place the new content in a .tar.gz file.
Page 24
b. On a *nix machine, use the tar -cvzf command or compression software to

compress the contents of the file into a .tar.gz file.
Delete a Branding Style

You cannot delete any of the styles that ship with cPanel & WHM.
To delete a branding style that you uploaded, perform the following steps:
1. Click Download or Delete Branding.
2. Click Delete Style next to the branding style you want to remove from your server.
3. To confirm that you wish to remove the style, click Yes on the following page.
Branding style options

From the Branding Editor interface, you can access the several options for existing styles on your
server.
You can use these options to perform the following actions:
Enabled Select this checkbox to make a style available to users.

Apply to My Account Click this option to use a style for your own cPanel account.
Apply to All Accounts Click this option to use a style for all of your users accounts.
Notes:
Icon
o If you accessed the Branding Editor interface after you selected a theme from
WHM's Branding interface (Home >> cPanel >> Branding), this option only applies to
accounts that use the selected theme.
o If you are a reseller, this option only applies to accounts that you own that use the
selected theme.
o For additional information about branding cPanel as the root user or as a reseller,
read our Advanced Guide to Branding.
Set Default for New Accounts Click this option to select a style as the default skin for new
accounts.
Edit This Style Click this option to edit a style.
Edit styles
When you choose to edit a style, the following options will display. They allow you to edit various
parts of the cPanel interface.
Change a Logo
To change a logo, perform the following steps:
Page 25
1. Click Edit Logos.

2. Logos display in the upper portion of your cPanel interface.
3. Click Choose File.
a. You must name the new logo with the following filename and extension: toplogo.png
4.
5.
6.
7.
8.
b. Click Reset to return to the default logo.

Select the file from your computer that you wish to use as the new logo.
Click Upload Images. Your logo will now appear at the top of the Edit Logos interface.
Select and drag the logo to the location in which you want it to appear.
To resize the logo, use the handles that appear when you place the cursor over it.
Note:
The CSS code in the middle of the interface will update accordingly whenever you move the
logo. Cut and paste this code into the Edit Style-sheet interface (click the edit link to access
this interface).
Change an Icon
To change an icon, perform the following steps:
1. Click Edit Icons.
Note:
2. Icons display in the cPanel Home interface (Home). Use them to highlight features for your
users.
a. The custom icons must have the same filenames as the originals.
b. Click Reset to return to the default icon.
4. Select the file from your computer that you wish to use as the new icon.
Warning:
5. cPanel does not support transparent images as icons. Uploaded images will lose their
transparency.
6. Click Upload Images.
a. Click Reset All Icons to return all icons to the default icons.
Note:
If your icon does not display properly, click Generate Sprites. This regenerates the cPanel file
that contains your icons, and may fix the problem.
To conserve bandwidth and improve performance, sprites reduce the number of requests to
your web server. To do this, they store all of your buttons and icons in a single image. When
you upload an image, the sprites should generate automatically.
The WHM interface includes a Generate Sprites link in case the process encounters a
problem. Use this link if the changes that you made to the appearance of the cPanel
interface do not display automatically.
Page 26
Change Headers and Footers
To change headers and footers, perform the following steps:

Click Edit Header/Footer.
Note:
Headers and footers display at the top and bottom of the cPanel interface and often serve as
consistent links to commonly-accessed sections of the interface.
Locate the image that you wish to replace.
Red numbers appear in the header and footer of the page. When you click a number, the
appropriate file will blink.
Each file also has a clickable image number. When you click the number, the appropriate
header or footer image will blink.
Click Choose File.
Custom headers and footers must have the same filenames as the original files.
Click Reset to return a header or footer to its default.
Select the file that you wish to use as an icon from your computer.
Click Upload Images at the bottom of the interface.
Click Reset All Icons to return to the default headers and footers.
Click Generate Sprites if your image does not display properly.
Edit a User's GUI

To change the general appearance of the user interface, perform the following steps:
1. Click Edit UI.
a. These images exist in many places in the interface and include borders and buttons.
b. Make certain to examine each picture and description to ensure that you replace the
correct files.
a. Custom images must have the same filenames as the original files.
b. Click Reset to return an image to its default.
3. Select the file that you wish to use as an icon.
4. Click Upload Images at the bottom of the page.
a. Click Reset All Icons to return to the default images.
b. Click Generate Sprites if your image does not display properly.
Change a Style's Preview Image

To change the appearance of the preview image for the style, perform the following steps:
1. Click Edit Preview Images.
a. The small preview image displays in the home interface of the Branding Editor.
Page 27
b. The large preview image displays when a user clicks the small image in the home
interface of the Branding Editor.
2. Click Choose File for the large preview image.
a. We recommend that you select a screenshot of the style.
b. Custom screenshots must have the same filenames as the original images.
c. Click Reset to return to the default preview image.
3. Repeat this process for the small preview image.
4. Click Upload Images at the bottom of the interface.
a. Click Reset All Previews to return both preview images to the defaults.
Edit a Style's HTML

When you edit a style's HTML directly, you can use cPanel's HTML Editor interface (Home >>
Files >> HTML Editor) or you can upload your own custom *.html file.
Use cPanel's HTML Editor
To edit the styles HTML pages in cPanel's HTML Editor interface, perform the following
steps:
1. Click the Edit HTML Pages link.
2. Click Edit to edit the HTML in the editor.
a. Click Revert to undo any changes you have made in the editor.
b. For more information about how to use this interface, read our HTML
Editor documentation.
3. Click Save to store the changes you have made with the editor.
a. Click Reset to return the HTML file to the default.
b. Right-click the HTML files name to download it and edit it in a text editor.
Upload Your Custom HTML page
To upload a custom *.html file, perform the following steps:
1. Click Choose File for the file that you wish to replace.
2. Navigate to and select the *.html file that you wish to upload.
3. Click Upload Pages at the bottom of the interface.
Click Reset to return the HTML file to the default.
Right-click the HTML files name to download it and edit it in a text editor.
Warning:
Icon
If you do not use an UTF-8 language, do not use it when you create your HTML pages. UTF-8
language data will result in a corrupted page.
Page 28
Edit a Style's CSS

To edit the styles cascading style sheet (CSS), perform the following steps:
1. Click Edit Style Sheet.
2. Make your changes or additions in the CSS editor text box.
3. Click Save CSS to store the changes.
Click Revert to return the style sheet to its default.
Warning:
Icon
If you do not use an UTF-8 language, take special care not to use it when you create your HTML
pages. UTF-8 language data will result in a corrupted page.
Example branded login page

Consider the following example of a branded login page:
<?php
#Login Configuration
#cPanel
$protocol = 'http';
$port = 2082;
#Secure cPanel
#$protocol = 'https';
#$port = 2083;
#WHM
#$protocol = 'http';
#$port = 2086;
#Secure WHM
#$port = 2087;
#Webmail
#$protocol = 'http';
#$port = 2095;
#Secure Webmail
Page 29
#$port = 2096;
?>
<html>
<h1>[Web Hosting Company Name Here]</h1>
<b>cPanel Login</b><br>
<?php
if ($_GET['failed'] == "1") {
?>
<font color=#FF0000>Your login attempt failed!</font>
<?php
}
print "<form action=\"" . $protocol . "://" . $_SERVER['HTTP_HOST']
. ":" . $port . "/login/\"
method=POST>";
?>
User: <input type="text" name="user"><br>
Pass: <input type="password" name="pass"><br>
<?php
print "<input type=hidden name=failurl
value=\"http://" . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF']
. "?failed=1\">";
?>
<input type="hidden" name="login_theme" value="default">
<input type="submit" value="Login">
</form><br>
<a href="cpanel-login.phps">Source</a><br>
Note: This examples requires cPanel 9.4.1 or later!
The login theme option requests cPanel 11.1.0 or later!
</html>
Change Language This interface defines the default display language of the cPanel interface.
Change Language
Skip to end of metadata
Created by Sync User, last modified on Aug 15, 2014
Go to start of metadata
Page 30

(Home >> Preferences >> Change Language)
Overview
Change the default language
Overview
The Change Language interface allows you to change the language of your cPanel interface. If you
need a new language, contact your hosting provider.
Change the default language

To change the default language of your cPanel interface, perform the following steps:
1. Select a language from the menu.
2. Click Change.
Important:
Icon
When you select a language that is not English, you may still see English text in some areas of
cPanel. We continue to work to provide 100% translation coverage, so there is no need to report
untranslated cPanel interfaces.
Shortcuts This interface allows you to create a shortcut (a quick way to access the cPanel
interface or your webmail).
Security Policy This interface allows you to update and manage your cPanel account's security
questions.
Security Policy
Created by Sync User on Jul 14, 2014
(Home >> Preferences >> Security Policy)
Page 31
o
o
Overview
Update Security Questions
Manage Recognized IP Addresses
Add an access IP address
Remove an access IP address
Overview
This interface allows you to update and manage your cPanel account's security questions. You can
also add access IP addresses. When you attempt to log in to your cPanel account from a verified
access IP address, the system will not require you to answer the security questions.
Your hosting provider may require you to answer these security questions if you attempt to access
your cPanel account from an unverified IP address. This policy helps to keep your server secure.
Note:
Icon
When you attempt to log in from an unverified IP address and successfully answer your security
questions, cPanel automatically adds that IP address to the list of verified IP addresses.
Update Security Questions

To update your security questions and answers, perform the following steps:
1.
2.
a.
b.
3.
4.
Click Update Security Questions and Answers.

For each security question that you wish to modify, perform the following actions:
Select or enter the desired question.
Enter an answer to the question in the appropriate text box.
Click Continue. Verify that the answers are correct.
Click Save Answers. A confirmation message will display.
Note:
Icon
If you used the root password to log in to a cPanel account, you cannot update security questions
and answers. Instead, click Reset Security Questions and Answers. The system will prompt the
cPanel account user to update the security questions and answers at the next login.
Manage Recognized IP Addresses

Remember:
Page 32
Icon
When you attempt to log in to your cPanel account from a verified access IP address, the system
will not require you to answer the security questions.
To add and remove access IP addresses, click Manage Access IPs.
Add an access IP address

To add an access IP address, perform the following steps:
1. Enter the IP address or range of addresses in the Access IP text boxes.
Note
Icon
You may use an asterisk (*) in the last octet. The system treats this asterisk as a wild card, which
means that any IP address within the specified IP address block is a verified access IP address and
may skip security questions when you log in.
2. Click Add.
Remove an access IP address

To remove an access IP address, click Remove in the Functions column for the IP address that you
wish to remove.
Mail
Created by Sync User, last modified on Jun 16, 2014
(Home >> Mail)
Email Accounts This interface allows you to add and manage your domain's email accounts.
Email Accounts
Page 33

(Home >> Mail >> Email Accounts)
Overview
Add an Email Address
Change password
Change quota
Delete an email address
Configure an email client
Notes about email client configuration
Access webmail
Default email account
Enable or Disable BlackBerry FastMail service
Overview
This set of features allows you to add and manage your domain's email accounts.
Add an Email Address

To add a new email address, perform the following steps:
1. Enter the email address that you wish to create in the Email text box.
If you manage more than one domain, make sure to select the appropriate domain from the menu.
Notes:
Icon
The system grades the password that you enter on a scale of 100 points. 0 indicates a weak
password, while 100 indicates a very secure password.
Some web hosts require a minimum password strength. A green password Strength meter indicates
that you met the required password strength.
Click Password Generator to generate a strong password. For more information, read our Password
Generator documentation.
3. Enter the quota in the Mailbox Quota text box.
The quota defines how much hard drive space the account may use to store email.
Important
Icon
Page 34
Due to mail server constraints, quotas cannot be greater than 2048 MB. Quotas that exceed this
amount must be unlimited.
4. Click Create Account.
The next section of the interface displays a table of email addresses that already exist on the
account. You can perform the following actions on these email addresses:
Display the amount of disk space that the account uses.

Change a password.
Change a quota limit.
Delete an email address.
Access an account through webmail.
Configure a mail client.
Change password
Important:
Icon
To change the password, perform the following steps:
1. Click Change Password next to the appropriate email account.
Notes:
Icon
3. Click Change Password to store the new password.
If you do not wish to change the password, click cancel.
Page 35
Change quota
The quota for an address defines the amount of mail (in Megabytes) that the account can store.
When your mailbox exceeds this limit, the system will return any incoming mail to the sender with a
message which states that the recipients mailbox is full. The system administrator can change this
behavior in WHM's Exim Configuration Manager feature (Home >> Service Configuration >> Exim
Configuration Manager).
It is important to keep track of quota usage, because a full quota will not allow you to receive mail.
Notes
Icon
The quota calculation does not include your mailbox's trash folder.
You cannot exceed the quota that your hosting provider sets. Also, due to mail server constraints,
you cannot set a quota that is greater than 2048 MB. Quotas that exceed this
amount must be Unlimited.
To change a mail quota, perform the following steps:
1. Click Change Quota.

2. Enter the new email quota (in Megabytes) in the appropriate text box. For an unlimited account,
click unlimited.
3. Click Change Quota to store the new value.
If you do not wish to change the quota, click cancel.
Delete an email address

To delete an email address, perform the following steps:
1. Click the Delete link that corresponds to the account that you wish to remove.
2. Click Delete to confirm that you wish to delete the email address.
If you wish to keep the email address, click cancel.
Configure an email client

This feature automatically configures your email client to access your cPanel email address(es). An
email client allows you to access your email account from an application on your computer.
Outlook Express and Apple Mail are examples of email clients.
To access this feature, click the More button that corresponds to the appropriate email account.
Note
Icon
Page 36
You must have already installed an email client on your computer in order to automatically configure
it with cPanel.
To configure your mail client, perform the following steps:
1. Select and download the appropriate configuration file from the list.
2. Run the script file to automatically configure your mail client to use the selected address.
When the configuration process completes, your email client should open automatically and log in to
your email account(s).
Note
Icon
If you wish to use an email client that interface does not list, you will need to manually configure it.
For more information on how to manually configure an email client, review the documentation of the
client that you wish to use. You can generally find documentation on the client's website.
Notes about email client configuration

If you have installed a non-wildcard SSL certificate that matches your hostname, the name of your
server will match your hostname. For example, if your hostname is www.example.com and your
SSL certificate matches your hostname, your server would be named www.example.com.
If your SSL certificate is a wildcard SSL, the name of your server will also match any subdomains
that correspond to the hostname's domain. For example, an SSL certificate
for *.example.comwould be valid for my.example.com and foo.example.com.
If you do not have an SSL certificate installed, the server will use the mail subdomain of your
domain. For example, mail.example.com. Also, the server will be named mail.example.com if
your certificate does not match your hostname.
Access webmail
This feature allows you to access an email account with a web browser. To access this feature,
perform the following steps:
1.
2.
3.
4.
Click the More button that corresponds to the appropriate email account.
Select the Access Webmail option from the menu.
Enter the password in the appropriate text box.
Click the Log in button.
Page 37
Default email account

Your default email address appears under the Default Email Account heading. The system created
this special email account when your hosting provider created your cPanel account. The account's
username and password are the same as your cPanel account name and password.
If your hosting provider configures this address to serve as a "catch-all" for all mail that was sent to
invalid usernames in your domain, it may receive a large amount of spam.
You can check and delete the mail that this account receives. To do this through webmail,
click Access Webmail and select your desired webmail application.
You can also use this account to send mail. To do this through webmail, click Access Webmail and
select your desired webmail application.
The actual address of the account is account@example.com, where account represents your
account user name. You cannot rename, delete, or place a quota on the default account, so we
recommend that you create a separate email account for daily use.
This address is also the default From and Reply-to address of outgoing email that your account's
PHP scripts send.
Enable or Disable BlackBerry FastMail service

You can use BlackBerry's FastMail service with your cPanel email account. For information on how
to enable or disable BlackBerry's FastMail service, read our BlackBerry FastMail
Servicedocumentation.
Webmail Webmail allows you to access your email through a web browser. For more information,
read our How to Access Webmail documentation.
Note:
Icon
The Webmail icon will not display if you logged in with the reseller or root password.
BoxTrapper BoxTrapper allows you to block unwanted email. Use the BoxTrapper interface to
configure your BoxTrapper settings.
BoxTrapper
Created by Sync User, last modified on Sep 08, 2014
Page 38

(Home >> Mail >> BoxTrapper)
o
o
o
o
o
o
Overview
Enable BoxTrapper
BoxTrapper Configuration
Configure BoxTrapper
Edit confirmation messages
Edit White/Black/Ignore lists
Forward List
Review Log
Review Queue
Overview
BoxTrapper filters spam from your inbox through challenge-response verification. When an account
that has BoxTrapper enabled receives an email, BoxTrapper automatically sends a verification email
in response. The sender must complete the verification process before the email can pass to your
inbox. If the sender does not verify the email, the verification fails and BoxTrapper never clears the
message for delivery. After a period of time, the system automatically deletes the spam.
Warning:
Icon
System administrators who have access to WHM and experience problems when they use
BoxTrapper and Apache SpamAssassin together must contact their hosting providers for more
information about the server configuration. BoxTrapper and Apache SpamAssassin only work
together if you disable the Old Style Spam System setting in WHM's Exim Configuration
Manager interface (Main >> Service Configuration >> Exim Configuration Manager):
** Old Style Spam System [?]
DEPRECATED: Use legacy transport based SpamAssassin system instead of the new ACL st
Enable BoxTrapper
To enable BoxTrapper, perform the following steps:
1. Click Manage next to the account that you wish to modify.
2. Click Enable.
Note:
Icon
Page 39
When you enable BoxTrapper, it automatically whitelists any email address to which you send email,
even if you disable the automatic whitelist.
BoxTrapper Configuration
To edit BoxTrapper settings, click Manage next to the account that you wish to modify.
The BoxTrapper Configuration interface will appear.
Configure BoxTrapper
To configure BoxTrapper settings, perform the following steps:
1. Click Configure Settings.
2. Enter any email addresses that forward mail to the account, separated by commas, in the Email
addresses going to this account text box.
3. Enter your name in the Your Name text box.
4. Enter the number of days for which you wish to keep logs and messages in the Number of days to
keep logs and messages in queue text box.
5. Enter the desired minimum spam score in the Minimum SpamAssassin Spam Scorerequired to
bypass BoxTrapper text box.
Note:
Icon
When BoxTrapper receives an email with a spam score lower than the value set in the Minimum
SpamAssassin Spam Score required to bypass BoxTrapper option, it automatically delivers the
message. The default value for this option is -2.5.
6. To enable or disable automatic whitelisting, select the appropriate box.
Note:
Icon
BoxTrapper will automatically whitelist any email address to which you send a message.
7. Select the Auto Whitelist To and From lines from whitelisted senders (whitelist by
association) checkbox to enable automatically whitelist addresses in the To and CC lines of an
incoming whitelisted email.
8. Click Save.
Edit confirmation messages

Click Edit to customize the verification and blacklist messages that sender will see when they
attempt to email you. Click Reset to Default to restore the default auto-response messages.
Page 40
Edit White/Black/Ignore lists

To edit lists, perform the following steps:
1.
2.
3.
4.
Click Edit White/Black/Ignore Lists.

Select the list that you want to modify.
Enter any messages, subjects, or email addresses for which you wish to filter.
Click Save.
BoxTrapper lists
Every new message you receive is compared against the following three lists:
Whitelist messages are delivered directly to your inbox.

Ignore list messages are deleted without notification.
Blacklist messages are deleted, and the sender receives a reply that indicates that the message
was blocked.
Forward List
Enter email addresses that you wish to add to the forward list, and click Save. The system will
automatically forward whitelisted emails to these addresses.
Review Log
This log is organized by day, and will show any activity for an email address that uses BoxTrapper.
This can be useful if you need to isolate problems with email delivery.
Review Queue
Click Review Queue to view any BoxTrapper mail that is unverified. To deliver or delete emails,
perform the following steps:
1. Select the checkbox for the desired day.
2. Select Delete or Whitelist & Deliver.
3. Click Submit.
To see the contents of a message, perform the following steps:
1. Click the emails sender, subject, or date to see the entire message, headers, and more delivery
options. For example, you can ignore or blacklist a sender.
2. Select the option for which you wish to filter.
3. Click Go.
Page 41
Apache SpamAssassin Apache SpamAssassin allows you to block unwanted email. Use
this interface to configure your Apache SpamAssassin settings.
Apache SpamAssassin
(Home >> Mail >> Apache SpamAssassin)
o
o
o
o
o
o
Overview
Enable or disable Apache SpamAssassin
Filters
Auto-Delete Spam
Enable Spam Box
Apache SpamAssassin Configuration
blacklist_from
required_score
score
whitelist_from
A note for system administrators
Overview
Apache SpamAssassin is an email utility that examines incoming email and tests for spam
characteristics. It uses Bayesian spam filtering and network tests to screen incoming email. This
results in an overall score that Apache SpamAssassin uses to determine whether it should discard a
message.
Note:
Icon
If you experience trouble when you use BoxTrapper and Apache SpamAssassin together, contact
your web hosting provider for more information about your server's configuration.
System administrators must disable the Old Style Spam System setting in WHM's Exim
Configuration interface (Home >> Service Configuration >> Exim Configuration Editor) for
BoxTrapper and Apache SpamAssassin to work together properly.
Page 42
Enable or disable Apache SpamAssassin

The Apache SpamAssassin interface displays the current status of the feature.
To enable Apache SpamAssassin, click Enable Apache SpamAssassin.

To disable Apache SpamAssassin, click Disable Apache SpamAssassin.
Filters
Auto-Delete Spam
This feature automatically deletes messages that meet or exceed the score limit.
To enable this feature, select the desired minimum spam score and click Auto-Delete Spam. This
setting defaults to 5.
To disable this feature, click Disable Auto-Delete Spam.
Notes:
Icon
If you enable this feature and a message that is not spam meets or exceed the defined score, you
may lose that email. Make certain to properly configure Apache SpamAssassin before you use this
feature.
Enable Spam Box

Notes:
Icon
Your hosting provider may need to enable this feature. If you want to redirect spam from your email
inbox, and this option is not available, create a spam email filter.
We recommend that you enable this feature.
When you click Enable Spam Box, the system creates a spam folder, to which Apache
SpamAssassin sends spam mail. This feature preserves mail that the system may mistakenly
classify as spam mail.
After you enable this feature, you can click Clear Spam Box to delete the messages in the Spam
Box.
Warning:
Icon
If you check your mail through a POP3 client, access and empty your spam box with the
username youraddress@example.com/spam and your email account password. If you do not do
Page 43
this frequently, spam may accumulate in the Spam Box and cause you to reach your email account
quota.
The above format is only functional to access the Spam Box. You cannot use this method to access
other folders on your account. Some webmail clients may require you to takeadditional steps. For
more information, read our How to Set Up Webmail Folders for Archived Email article.
If you are unsure of whether you use POP3 or IMAP to receive mail, you can find this information in
your email application's Preferences interface.
Apache SpamAssassin Configuration

When you click Configure Apache SpamAssassin, you will see the option to filter addresses
automatically.
Notes:
Icon
If you need to add more than five addresses to the blacklist, fill in the first five text boxes and
click Save. Additional text boxes will appear.
Click Save to store the configuration changes.
For more information, visit the Apache SpamAssassin documentation.
When you add the addresses to the blacklist or whitelist, use * as a wildcard to represent multiple
characters and ? to represent a single-character wildcard. The following examples demonstrate how
to properly use wildcards in the blacklist:
user@example.com Blacklists or whitelists a single email address.
*@example.com Blacklists or whitelists all of the addresses at example.com.
?ser@example.com Blacklists or whitelists a single character in an address at example.com (for

example, user@example.com, but not Auser@example.com).
blacklist_from
Apache SpamAssassin may incorrectly tag some mail as non-spam messages. If these messages
often come from specific addresses, you can blacklist them to ensure that Apache SpamAssassin
tags their messages correctly.
To do this, enter the address in one of the blacklist_from text boxes.
Note:
Icon
System administrators who wish to blacklist email addresses on multiple accounts should use
the Exim System Filter File.
Page 44
required_score
Apache SpamAssassin examines every email message for spam characteristics and assigns it an
overall score.
Use the required_score text box to set the required score to mark a message as spam. The default
setting is 5.0, which is aggressive. It is suitable for a single user, but ISPs should set the default to
be more lenient (for example, 8.0 or 10.0).
score
Apache SpamAssassin uses hundreds of tests, and you can assign scores to individual tests to
configure Apache SpamAssassin for your server.
To do this, perform the following steps:
1. To review the default scores, run the following command:
grep -R score /var/lib/spamassassin/* |less
2. You will need to know which version of Apache SpamAssassin runs on your server. To check your
version of Apache SpamAssassin, run the following command:
/usr/local/cpanel/3rdparty/bin/spamassassin --version
3. Enter individual test scores in the score text boxes in the following format:
"score" "TEST_NAME" "1 or 4 positive or negative numbers"
The following table indicates when Apache SpamAssassin uses each score.
Score used
Bayes test
Network test
First Score
Disabled
Disabled
Second Score
Disabled
Enabled
Third Score
Enabled
Disabled
Fourth Score
Enabled
Enabled
Example
For example, you could enter the following individual test score:
score INVALID_DATE 3.2 3.3 2.5 2.1
Page 45
This example sets the scores that Apache SpamAssassin assigns to a message with an invalid date
in its header.
Note:
Icon
If you only list one number, the test uses that score.
Set a score to 0 to disable the test.
In the example above, 3.2 is the first score, 3.3 is the second, 2.5 is the third, and 2.1 is the
fourth. If you enter four numbers, as in the example, the score that Apache SpamAssassin uses
depends on the Bayes and network tests that are enabled in your installation of
Apache SpamAssassin.
whitelist_from
Add email addresses that Apache SpamAssasin often blocks, but from which you wish to receive
mail, to the Apache SpamAssasin whitelist.
To do this, enter the address in one of the whitelist_from text boxes.
A note for system administrators

If you do not have access to a WHM interface, the following information does not specifically pertain
to you. If you experience trouble when you use BoxTrapper and Apache SpamAssassin together,
contact your web hosting provider for more information about how your server is configured.
BoxTrapper and Apache SpamAssassin will only work together if you disable the Old Style Spam
System feature in WHM's Exim Configuration interface (Home >> Service Configuration >> Exim
Configuration Editor).
Forwarders Forwarders allow you to forward incoming email from one address to another. Use
this interface to create and manage your domain's forwarders.
Forwarders
(Home >> Mail >> Forwarders)
Page 46
o
o
o
o
Overview
Email Account Forwarders
Add Forwarder
Pipe to a Program
Domain forwarders
Delete a domain forwarder
Add Domain Forwarder
Overview
You can use this interface to forward copies of one address's incoming emails to another address.
This allows you to use one account to check mail for several email addresses. You can also discard
email or send (pipe) mail to a program.
To view forwarders for a specific domain on your account, select the domain for which you wish to
set forwarders from the Managing menu.
Note:
Icon
Use the Box Trapper Forward List feature for email accounts that use BoxTrapper. For more
information, read our BoxTrapper documentation.
Email Account Forwarders

The Email Account Forwarders table lists all of the email accounts for which you have configured
forwarding.
To quickly find a specific email address, enter a keyword in the Search text box and click Go.
To view the route that a forwarded message takes, select Trace in the Functions column for that
email address.
To delete a forwarder, click Delete in the appropriate row. Click Delete Forwarder to confirm that you
wish to delete that forwarder.
Add Forwarder
To add a mail forwarder, perform the following steps:
1. Click Add Forwarder.
2. In the Address to Forward text box, enter the address for which you wish to forward email.
Forward to email address Select this option to forward mail to another address. Enter the address
to which you wish to forward mail in the text box.
Page 47
Discard with error to sender Select this option to discard incoming messages and automatically
send a failure notice to the sender. Enter the desired failure message in the Failure Message text
box.
Click Advanced Options to view the following additional options:
Forward to a system account Select this option to forward mail to a system user. Enter the
appropriate username in the text box.
Notes:
Icon
This text box accepts the username of any user on the server.
System accounts do not have a public-facing email address.
Pipe to a Program To automatically forward messages to a program, define a path to the program
(for example, /home/$utility) in the text box. For more information, read the Pipe to a
Program section below.
Discard (Not Recommended) Select this option to discard incoming messages without a failure
notice.
Important:
Icon
We do not recommend this option, because the sender will not know that the delivery failed.
4. Click Add Forwarder.
Important:
Icon
If you do not delete the cPanel account for which mail is forwarded, both accounts will receive mail.
If you wish to forward mail to another account but not receive mail at your cPanel account, create a
forwarder from an address that does not have a cPanel account.
If the account already exists, delete it in cPanel.
The system will forward all of the mail that you receive to the destination that you configure in this
interface.
Pipe to a Program
Important:
Icon
Page 48
Make sure that your script uses the proper file permissions (0700). To change your script's file
permissions, run the chmod 0700 myscript.php command, where myscript.php stands for your
script's location and file name.
You can use the Pipe to a Program option to parse and enter email information into a different
system. For example, you can use the Pipe to a Program option to pipe email information to a
program that enters email information into a ticket system.
STDIN pipes email and headers to the program.
Pipes can accept variables from the $_SERVER array and variables on the command line.
The language or environment that you use may cause memory limit issues.
If your script produces any output, even a blank line, the system will create a bounce message that
contains that output.
When you use the Pipe to a Program option, enter a path that is relative to your home directory. For
example, if your username is user and you wish to use the /home/user/script.pl script,
entertest.pl in the Pipe to a Program text box.
Note:
If you use PHP, ensure that you appropriately wrap your code in start and end tags.
PHP and Perl hashbangs
To ensure that the script will function properly, the script must be executable and the appropriate
hashbang line must exist at the top of the script.
If you use PHP, use the following hashbang line at the top of the script:
#!/usr/local/bin/php -q
If you use Perl, use the following hashbang line at the top of the script:
#!/usr/bin/perl
If your script does not include a hashbang, enter the path to the Perl or PHP interpreter in the Pipe to
a Program text box. Follow it with the full path to the script, as in the following examples:
/usr/local/bin/php /home/john/test.php
/usr/bin/perl /home/john/test.pl
Domain forwarders
You can use domain forwarders to forward copies of all of the incoming mail for all of a domain's
addresses to another domain. Domain forwarders override the default address for the forwarded
domain.
Note:
Page 49
Icon
Domain forwarders only forward mail when a delivery is not successful. For example, if a user sends
an email to john@example1.com, the following actions might take place:
If john@example1.com is an existing email address or autoresponder, cPanel will not forward the
email.
If john@example1.com is not an existing email address or autoresponder, cPanel will forward the
email.
Delete a domain forwarder

To remove a domain forwarder, click the button in the Delete column that corresponds to the domain
forwarder that you wish to remove.
Add Domain Forwarder

To add a domain forwarder, perform the following steps:
1. Click Add Domain Forwarder.
2. Enter the domain to which you would like to forward email.
3. Click Add Domain Forwarder.
Auto Responders Autoresponders allow you to send a message in response to incoming email
automatically. Use this interface to create and manage your domain's autoresponders.
Auto Responders
(Home >> Mail >> Auto Responders)
Overview
Current Auto Responders
Add or Edit an Auto Responder
Remove an Auto Responder
Page 50
Overview
This feature allows you to configure automatic email response messages. This is useful when the
recipient is unavailable.
Note
Icon
When an auto responder is active, emails that the mailbox receives still go to the inbox as usual.
Current Auto Responders

To view the auto responders for a specific domain on your account, select the desired domain from
the Managing menu on the top right side of the Auto Responders interface. A list of the auto
responders will appear in the table below.
To quickly find a specific email address of an auto responder, enter a keyword in the Search text box
and click Go.
Add or Edit an Auto Responder

To add an auto responder, perform the following steps:
1. Select the domain for which you wish to add or edit an auto responder from the Managing menu.
2. Choose one of the following actions:
If you wish to create a new auto responder, click Add Auto Responder.
If you wish to edit an auto responder, click Edit next to the auto responder that you wish to edit.
3. Select a character set from the Character Set menu.
Note
Icon
UTF-8 is the dominant character set that most internet users encounter, and it is the default value
that cPanel selects. We highly encourage users to use UTF-8.
4. Enter the interval, in hours, that you wish for the auto responder to wait between responses to the
same email address.
For example, if you set up an auto responder with an interval of 24 and you receive an email
from john@example.com at 8:00 AM on Monday, the auto responder will respond to his message
immediately. If, however, john@example.com continues to email you throughout the day, the auto
responder will not send him another response for 24 hours after his initial email (in this case, 8:00
AM Tuesday). If he emails you again after the 24-hour interval expires, the system will send him an
auto response.
Note
Page 51
Icon
If you set the interval to 0, cPanel sends an auto response to each email.
5.
6.
7.
8.
9.
In the Email text box, enter the email address for which you wish the server to respond.
In the From text box, enter the username that will appear in the response.
In the Subject text box, enter the subject that will appear in the response.
If the message includes HTML tags, select the HTML checkbox.
In the Body text box, enter the text of the response.
Note
Icon
You can use tags in the body of the message to represent information, such as the incoming email's
sender or subject. Tags use percentage signs (%) as markers.
Available tags are:
%subject% The subject of the message that was sent to the auto responder.
%from% The name of the sender of the message that the auto responder received. (If the sender's
name was not in the original email's header, %from% will print the sender's email address.)
%email% The sender's email address.
10. Select a start time. You can choose Immediately or Custom.
If you select Custom, a small calendar will appear. Use the arrows to navigate between months and
click your preferred start date. Then, enter a start time at the bottom of the calendar, and
include AM or PM from the menu. Finally, click anywhere outside of the calendar box to save the
configuration and close the calendar. Your chosen date and time will appear next to the Start option.
Notes
Icon
The time is based on the user's workstation operating system time and the system translates it into
GMT. If the workstation time is wrong, the time on the calendar will be proportionately wrong.
This feature uses 12-hour notation and will reformat times in 24-hour notation. For example, if you
select 18:30 as the start time, cPanel will automatically reformat the time to be 6:30 PM.
11. Select a stop time. You can choose Never or Custom.
If you select Custom, a small calendar will appear. Use the arrows to navigate between months and
click your preferred date. Then, enter a time at the bottom of the calendar and select AM or PM from
the menu. Finally, click anywhere outside of the calendar box to save the configuration and close the
calendar.
Note
Icon
Page 52
You must select a stop time that is later than the start time.
12. Click Create/Modify to save the auto responder.
Remove an Auto Responder

To delete an auto responder, perform the following steps:
1. Click Delete next to the auto responder that you wish to delete.
2. Click Delete Autoresponder to confirm that the you wish to delete the auto responder.
Default Address Use the Default Address interface to configure how cPanel will handle mail that
is sent to invalid email addresses for your domain.
Default Address
Created by Sync User on May 09, 2014
The email address to which cPanel routes any email message sent to email accounts which do not
exist at a domain. Also known as a Catch-All Address.
Mailing Lists Mailing lists allow you to specify a single address through which you can send an
email message to multiple addresses.
Mailing Lists
(Home >> Mail >> Mailing Lists)
Overview
How to create a mailing list
View current mailing lists
Page 53
o
o
o
o
o
How to manage a mailing list

How to enable spam filters for a mailing list
How to change a mailing list password
How to delegate a mailing list
How to delete a mailing list
Overview
Mailing lists allow you to use a single address to send mail to multiple email addresses.
Note:
Icon
cPanel handles mailing lists with the third-party Mailman application. For additional information,
read the Mailman documentation.
How to create a mailing list

cPanel includes an interface that allows you to define a name, password, and domain name for the
mailing list.
To add a new mailing list, perform the following steps:
1. Enter the mailing list name in the List Name text box.
2. Select a domain from the Domain menu.
Notes:
Icon
Important:
Icon
Page 54
4. Select one of the following privacy options:
private This mailing list has private archives, the administrator must approve subscriptions,
and the Mailman interface does not advertise the mailing list.
public This mailing list has public archives, the subscriptions are open, or the list is advertised on
the Mailman interface.
5. Click Add Mailing List to create the new mailing list.
After you create a mailing list with cPanel, you can use the functions below to modify, delete, or
change the password.
View current mailing lists

The Current Lists section of the interface displays a list of the mailing lists on the account. You can
use the Page buttons to navigate through the list of mailing lists.
The list of current mailing lists.
To search for a mailing list, enter a keyword in the Search text box and click Go.
The following table describes the Current Lists table:
Column
Description
List
Name
The full email address of the mailing list.
Usage
The amount of disk space that the mailing list uses.
Page 55
Column
Description
Access
The level of access that users have to the mailing list.
private This mailing list has private archives, the administrator must approve
subscriptions, and the mailing list is not advertised on the Mailman interface.
public This mailing list has public archives, the subscriptions are open, or the list is
advertised on the Mailman interface.
Admin
A delimited list of email addresses of the mailing list administrators.
Functions
Administrative functions for the mailing list (see below).
How to manage a mailing list

To manage a mailing list, perform the following steps:
1. In the Current Lists section of the interface, scroll to the name of the mailing list.
You can also enter a keyword in the Search box and click Go.
2. In the Functions column, click the Manage link next to the name of the mailing list.
Note:
Icon
cPanel will log you in to the mailing list management screen automatically. However, if you go
directly to the Mailman URL or prefer to use the email-based management functions, you will need
to use the administrator password.
After the Mailman management interface appears, you can define the various configuration options
in Mailman.
For more information about available Mailman configuration options, read the Mailman
documentation.
How to enable spam filters for a mailing list

Note:
Mailman's Spam Filters feature requires Apache SpamAssassin. To enable Apache
SpamAssassin for your cPanel account, select Enable Apache SpamAssassin in cPanel's Apache
SpamAssassin interface. (Home >> Mail >> Apache SpamAssassin)
To enable spam filters for a mailing list, perform the following steps:
Page 56
1. In the Current Lists section, scroll to the name of the mailing list.
You can also enter a keyword in the Search box and click Go.
2. In the Functions column, click the Manage link next to the name of the mailing list.
3. In the Configuration Categories section, click Privacy options.
4. Click Spam filters.
5. Enter the filter rules that you wish to apply. For more information on filter rules, view our How to
Create Mail Filter Rules For Mailing Lists documentation.
6. Click Submit Your Changes.
For more information on Mailman's Spam Filters feature, view the Mailman documentation.
How to change a mailing list password

You can use the cPanel interface to change the password for a mailing list without the old password.
This can be very useful to recover control of your mailing list in the event that you forget or lose the
password.
To change the password for a mailing list, perform the following steps:
You can also enter a keyword in the Search text box and click Go.
2. In the Functions column, click the Manage link next to the name of the mailing list. A new interface
will appear.
Notes:
Icon
Important:
Icon
Page 57
4. Click Change Password to activate the new password.
How to delegate a mailing list

You can delegate administrative rights on a mailing list to specified list members. Delegates can
approve messages that await approval.
To manage the Delegation settings on a mailing list, search for the name of the mailing list that you
wish to manage and click the appropriate Delegation link.
The Administrator Privileges Delegation section

How to delegate administrative rights to an additional user
To delegate administrative rights on a mailing list, perform the following steps:
1. Under Available Users, select the email addresses of the users to whom you wish to delegate
administrative rights.
2. Click the right arrow button.
3. Click Save.
How to remove administrative rights from a user
To remove administrative rights from an address on a mailing list, perform the following steps:
1. Under List Administrators, select the email addresses of the users from which you wish to remove
administrative rights.
2. Click the left arrow button.
3. Click Save.
Page 58
How to delete a mailing list

To delete a mailing list, perform the following steps:
You can also enter a keyword into the Search box and click Go.
2. In the Functions column, click the Delete link next to the name in the list.
3. Confirm that you with to delete the list on the following page.
Account Level Filtering Account-level filters allow you to create mail filters for your domain's main
email account.
Account Level Filtering

(Home >> Mail >> Account Level Filtering)
o
o
Overview
Create Filter
Current Filters
Edit a filter
Delete a filter
Filter Test
Overview
This interface allows you to set up how you wish to filter all of the email that your domains' email
accounts receive.
Important:
Icon
We strongly recommend that you use multiple, simple filters instead of a single large filter. Exim,
the server's mail transfer agent, handles many small rules more efficiently than it handles a single
large rule.
Page 59
Create Filter
To create a new filter, perform the following steps:
1. Click Create a new Filter.
2. Enter a name for the filter in the Filter Name text box.
3. Configure your filter's rules and actions as desired.
Note:
For detailed information on how to configure your filter, read our How to Configure Mail Filters article.
4. Click Create.
Current Filters
The Current Filters section lists all of the account-level filters for your cPanel account.
Edit a filter
To edit an existing filter, perform the following steps:
1. Click Edit next to the appropriate filter name.
2. Make the desired changes to the filter.
3. Click Create.
Delete a filter
To delete a filter, perform the following steps:
1. Click Delete.
2. Click Delete Filter to confirm that you want to delete the selected filter.
Filter Test
To test your filter, perform the following steps:
1. Enter a test email message in the Filter Test text box.
Note:
Icon
Make certain that your test message includes the characters or words for which you wish to filter.
Page 60
2. Click Test Filter. The Filter Trace Results indicate whether your filters would alter delivery for that
test message.
User Level Filtering User-level filters allow you to create mail filters for specific email accounts on
your domain.
User Level Filtering

( Home >> Mail >> User Level Filtering )
o
o
Overview
Create a filter
Current Filters
Edit a filter
Delete a filter
Filter Test
Overview
This interface allows you to filter the email for each email account in your domain.
Important:
Icon
We strongly recommend that you use multiple, simple filters instead of a single large filter. Exim,
the server's mail transfer agent, handles many small rules more efficiently than it handles a single
large rule.
Create a filter
To create a new filter, perform the following steps:
1. In the Filters by Users table, click Manage Filters in the row that corresponds to the email account
for which you wish to create a filter.
2. Click Create a new Filter.
3. Enter a name for the filter in the Filter Name text box.
4. Configure your filter's rules and actions as desired.
Page 61
Note:
For detailed information on how to configure your filter, read our How to Configure Mail Filters article.
5. Click Create.
Current Filters
To view the list of current filters for an email account, click Manage Filters in the row that
corresponds to the email account for which you wish to create a filter. The Current Filters table lists
all of the user-level filters for the selected email account.
Edit a filter
To edit an existing filter, perform the following steps:
1. Click Edit next to the appropriate filter name.
2. Make the desired changes to the filter.
3. Click Create.
Delete a filter
To delete a filter, perform the following steps:
1. Click Delete.
2. Click Delete Filter to confirm that you want to delete the selected filter.
Filter Test
To test a filter, perform the following steps:
1. In the Filters by Users table, click Manage Filters in the row that corresponds to the email account
for which you wish to create a filter.
2. Enter a test email message in the Filter Test text box.
Note:
Icon
Make certain to include the characters or words that you set up your filter to catch.
3. Click Test Filter.
Page 62
Email Trace Use this interface to review details about email delivery attempts for your account.
Email Trace
(Home >> Mail >> Email Trace)
Overview
Search for the delivery status of an email
The Delivery Report table
The Table Options button
The Email Server Trace diagram
Overview
This interface displays reports about email delivery attempts from your account and allows you to
trace email delivery routes. You can also trace an email's delivery route with this feature, which can
help you to locate problems with email delivery.
Search for the delivery status of an email

To see the delivery status of an email, perform the following steps:
1. Enter a recipient email address in the Search text box.
2. Click Run Report to show the Delivery Report table and the Email Server Trace diagram.
The Delivery Report table

By default, the system sorts your query's results into the following columns:
Column
Description
Event
An icon that indicates the message's delivery status:
The message was delivered successfully.
Page 63
Column
Description
The message's status is unknown, or delivery is in progress.
The message was deferred.
The message encountered a delivery error.
The message was rejected at SMTP time. Typically, this

occurs because the sender's server does not have a secure configuration or appears on a
Real-time Blackhole List (RBL).
The mail server accepted the message but did not deliver it
to the recipient's inbox. This typically occurs because spam software filtered the message.
User
The cPanel user who owns the email account that sent the message.
Sender
The email address on your system that sent the message.
Sent Time
The date and time when the user sent the message.
Spam
Score
A score that is based on the number of spam-related traits within the message.
Recipient
The email address to whom the user sent the message.
ID
The unique identifier of the outgoing email message.
Result
This column contains a short message about the delivery.
Actions
Click the
icon to view and print information about the selected
message. This information includes the message's sender, recipient, username, and more.
Page 64
The Table Options button

To select the columns that you wish to display in the Delivery Report table, click the options icon (
) on the right. To hide information, deselect the box.
From the Table Options window, select the following column headers that you wish to view:
Option
Description
Select All
Selects all the options listed.
Event
The delivery status, indicated by an icon (see list in table above).
User
The sender's cPanel username.
Domain
The sender's domain.
Sender
The email address on your system that sent the message.
Sent Time
The date and time when the user sent the message.
Sender Host
The sender's host's IP address.
Sender IP Address
The sender's IP address.
Authentication
The sender's authentication type.
Spam Score
The email's Apache SpamAssassin score.
Recipient
The email address to whom the user sent the message.
Delivery User
The username that owns the recipient's email address.
Delivery Domain
The recipient's domain.
Delivered To
The recipient's email address.
Page 65
Option
Description
Router
The internal router that the mail server used to determine the message's
destination.
Transport
The recipient's SMTP type.
Out Time
The date and time when the intended recipient received the message.
ID
The unique identifier of the outgoing email message.
Delivery Host
The recipient mail exchanger's hostname.
Delivery
IP Address
The recipient mail exchanger's IP address.
Size
The size of the outgoing message.
Result
This column contains a message that describes the delivery results.
Actions
Click on the magnifying glass to open the Delivery Event Details information
window and print the report.
The Email Server Trace diagram

This feature shows the delivery route that the sent email took from source to destination. There are
four icons under the Legend with their meanings. The icons show you the error, filter, destination, or
local mailbox that your email encountered during its journey.
Import Addresses/Forwarders Use this interface to create multiple email accounts or forwarders
when you upload a list of usernames.
Import Addresses/Forwarders
Page 66
(Home >> Mail >> Import Addresses/Forwarders)
Overview
How to create the import file
Import the file
Overview
This feature allows you to use two types of file to create multiple email addresses or forwarders for
your account simultaneously. You may use Excel spreadsheet files (.xls) or comma-separated
values sheet (CSV) files (.csv) to import the data.
How to create the import file

To create the import file, add a series of email addresses and passwords to your spreadsheet or
plain text file. Use a new row in the spreadsheet or a new line in the plain text file to separate the
information for each account or forwarder that you wish to create.
You may import the following information for each address or forwarder:
Usernames
For example, user1 or user@example.com.
You are not required to include the domain portion of the address (for example, @example.com).
Passwords, if you wish to import email addresses.
Quotas
For example, 10 indicates for 10 Megabytes.
A .csv file is a plain text file to which you assign the .csv extension. When you use a .csv file,
separate your email addresses and passwords consistently. You can use commas (,), periods (.),
or any other character (delimiter) to separate the information that you will import for each account.
A sample .csv file might contain the following lines:
1
user1@example.com, Password, 10
Remember:
Icon
Page 67
You do not have to use a comma (,) as your delimiter.
Import the file

After you finish your file, import that file to create the accounts. cPanel will use the information in the
file to create all of the accounts automatically.
To import the file, perform the following steps:
1. In Step 1, select whether you wish to import E-mail Accounts or Forwarders.
2. In Step 2, click Choose File to select the file that you wish to import.
3. In Step 3, select the delimiter for your file.
If you used a delimiter that does not appear in the list, select Other and enter that character in the
text box to the right.
4. Click Treat first row as column headers if you placed column headers in the first row of the file.
5. Click Next.
6. Use the menus above each column of values to assign the properties of each delimited value.
For example, if you chose to use a comma as the delimiter, and input the line account,
password, domain, use the menus above each value to
assign account to Email, password to Password, and domain to Domain.
Select Ignore for any columns that contain unnecessary data.
7. From the Step 2 menu, select the domain you wish to use for these accounts.
8. Click Next.
9. Review the information and click Finish.
Click Import More to return to the first screen of this interface and import additional addresses.
Email Authentication Use this interface to configure DKIM, SPF, and other settings that help
prevent spam.
Email Authentication
(Home >> Mail >> Email Authentication)
Overview
Set up DKIM
Page 68
o
o
Advanced Settings
Additional information
Add Headers in DKIM
The spf_installer
Overview
cPanels email authentication features provide information about outgoing messages. This helps the
server that receives the messages verify that the email comes from a trusted sender.
Note
Icon
Both the DKIM and SPF authentication functions require the server to be a DNS server for the
domain name. For more information about DNS servers, review the terms of your hosting contract.
Set up DKIM
DKIM helps to verify the sender and integrity of a message. It allows an email system to prove that a
message was not altered while in transit (which means that it is not forged), and that the message
came from the specified domain.
To use DKIM, click Enable.

To disable DKIM, click Disable.
Note
Icon
If a warning displays that claims that cPanel is unable to verify that the server is an authoritative
nameserver for the specified domain name and either of the following scenarios is true, ignore the
warning.
The server has been changed to be the authoritative DNS server for the domain name, but the
change has not yet propagated.
The server does not view itself as the authoritative DNS server, but outside servers do view it as
authoritative.
Set up SPF
This function attempts to deny spammers the ability to send email while they forge your domains
name as the sender (spoofing). This authentication function adds IP addresses to a list that specifies
computers that are authorized to send mail from your domain(s). It verifies that messages that are
sent from your domain(s) come from the listed server, which will reduce the amount of backscatter
you receive.
Page 69
To use SPF, click Enable.

To disable SPF, click Disable.
Note
Icon
If a warning displays that claims that cPanel is unable to verify that the server is an authoritative
nameserver for the specified domain name and either of the following scenarios is true, ignore the
warning.
The server has been changed to be the authoritative DNS server for the domain name, but the
change has not yet propagated.
The server does not view itself as the authoritative DNS server, but outside servers do view it as
authoritative.
Advanced Settings
This section includes the following ways to configure SPF authentication:
Additional Hosts that send mail for your domains (A): The additional hosts specified here are
automatically approved to send mail from your domain(s). You may add and remove hosts with the
appropriate buttons.
Additional MX servers for your domains (MX): MX entries specified here are able to send mail from
your domain(s).
Additional Ip blocks for your domains (IP4): IP addresses that are approved to send mail from your
domain(s). Your server's main IP address is automatically included in this list. If you add IP
addresses, you must use CIDR notation. (For example, 192.168.0.1/32)
Include List (INCLUDE): This feature allows you to specify additional hosts to include in your SPF
settings. This is useful when you send mail with another service.
All Entry (ALL): If you enable this option, the SPF feature causes hosts that are not defined in the
above lists to fail. If you disable this option, the SPF feature will not cause undefined hosts to
automatically fail; instead, undefined hosts will be marked as Neutral. When a server receives mail
from a neutral host, the server will act as if SPF was not enabled. After you have tested the entries in
the above lists and confirmed that they are correct, you should enable this feature.
Overwrite Existing Entries: If you select this option, the system will overwrite existing SPF entries.
Click Update to save your changes.
Page 70
Add Headers in DKIM
If you already use DSO and you enable DKIM, emails sent will not have information in the ReturnPath, Reply-To, or From fields in the email header. As a result, DKIM will show that nobody is the
sender. If you use a PHP script, you should manually add the headers. The following is an example
of a PHP script that adds the missing parts to an email header:
1
<?php
$to
$subject = 'the subject';
$message = 'hello';
$headers = 'From: webmaster@example.com' . "\r\n" .
'Return-Path: webmaster@example.com' . "\r\n" .
'Reply-To: webmaster@example.com' . "\r\n" .
8
9
= 'nobody@example.com';
mail($to, $subject, $message, $headers);

?>
The spf_installer
You can use the spf_install function from the command line to add an SPF record to the zone
files for all domains that belong to a user.
For example, to add an SPF record to all domains registered to username john on the cPanel
server, run the following command as root:
/usr/local/cpanel/bin/spf_installer john
If the script is successful, you will not receive confirmation from the command line. Instead, navigate
to Home >> cPanel >> Email Authentication on each domain that is owned by the user. The SPF
status will show as Enabled.
MX Entry Use this interface to add and manage MX entries.
MX Entry
Page 71
(Home >> Mail >> MX Entry)
Configure Email Routing

Add a New MX Entry
Delete an MX Entry
Edit an MX Entry
Overview
This feature allows you to route a domain's incoming mail to a specific server. Changes that you
make to the MX entry will also result in changes to the DNS records.
This feature is useful if you wish to create a backup mail exchanger to handle mail when the server
is down.
Configure Email Routing

Warning:
Icon
Misconfigured MX entries can completely disable your ability to receive mail. If you are unsure which
option to choose, contact your system administrator.
To determine how your server routes mail for a domain, perform the following steps:
1. Select the desired domain from the menu.
2. Select one of the following options under Email Routing:
Automatically Detect Configuration The server will automatically detect, and use, the configuration
set below and detailed under the MX Records heading at the bottom of the interface.
Local Mail Exchanger The domain will accept mail, regardless of whether a higher-priority mail
exchanger has been designated. If a higher-priority mail exchanger exists, the server will route mail
to both domains.
Note:
Icon
Choose this option if your server uses SmartHost or another gateway service to filter mail.
Backup Mail Exchanger The domain will act as a backup mail exchanger, and will hold mail in the
queue if the primary exchanger becomes unavailable.
Note:
Page 72
Icon
You will need to configure the primary MX entry to point to the appropriate exchanger.
Remote Mail Exchanger The domain will not accept mail. Instead, it will send it to the primary mail
exchanger.
Note:
Icon
You will need to configure the primary MX entry to point to the appropriate exchanger.
3. Click Change.
Add a New MX Entry

To add a new MX entry to the domain, perform the following steps:
1. Under Add New Record, set the priority for the new MX entry.
Remember:
Icon
Lower values denote higher priority. The highest priority is 0.

The primary mail server(s) (those with the lowest priority values) will receive mail that is sent to your
domain.
Backup, or secondary, mail servers (those with higher priority values) are used for backup or other
purposes.
If you assign the same priority value to multiple mail servers, when that level of mail server is
needed, the system will distribute mail to those servers randomly.
2. In the Destination text box, enter the hostname of the new mail exchanger.
Important:
Icon
This must be a fully qualified domain name (FQDN). You cannot specify an IP address here.
3. Click Add New Record.
Delete an MX Entry
To delete an MX entry, perform the following:
1. Click Delete next to the appropriate MX entry in the MX Records list.
2. Click Delete again to confirm that you wish to delete the entry.
Page 73
Edit an MX Entry
To edit an MX entry, perform the following:
1. Click Edit next to the appropriate MX entry in the MX Records list.
2. Change the Priority or Destination as needed.
3. Click Edit again to confirm that you wish to change the entry.
Email Archiving Use this interface to save incoming, outgoing, or mailing list messages for a
specified amount of time.
Email Archiving
(Home >> Mail > Email Archiving)
o
o
o
o
Overview
Default Mail Archiving Configuration
Manage Archiving
Modify email archiving for a domain
IMAP Access
Download Archives
Access Webmail
Overview
The Email Archiving feature allows users to save incoming, outgoing, or mailing list messages for a
specified amount of time. cPanel stores the messages in the mail directory in the user's home
directory. Each day, the system generates a new directory with the archivetype.YYYY-MMDD format to contain all of the messages for the specified archive type.
When the server receives a message, it will immediately archive it.

This action takes place before the system applies any filters.
The system will archive both spam and non-spam emails.
Email that you received before you enabled the Email Archiving feature is not archived.
Run the /usr/local/cpanel/scripts/email_archive_maintenance script to archive these
messages.
Page 74
You can view the messages from the cPanel interface or in a mail client.
Warning
Icon
The Email Archiving feature will not appear in your cPanel interface unless your System
Administrator enables the Enable Email Archiving support setting in the Mail section of
WHM's Tweak Settings interface (Home >> Server Configuration >> Tweak Settings >> Mail).
Note
Icon
When you enable Email Archiving, the amount of disk space that the feature uses can quickly grow
based on the length of time over which you store messages. Verify that your disk drive has ample
space before you enable Email Archiving.
Default Mail Archiving Configuration

To enable a default configuration to use for all of your domains, perform the following steps:
1. Select the desired archive type.
2. Select the length of time during which mail should remain in the archive.
3. Click Apply to All My Domains to apply the default configuration to all of the domains that you
currently own.
Manage Archiving
The Manage Archiving table lists the archiving settings for each of your domains.
Modify email archiving for a domain

To make changes to an existing email archiving configuration, perform the following steps:
1.
2.
3.
4.
In the table, find the domain for which you wish to enable email archiving.
Select the desired archive type.
Select the length of time during which mail should remain in the archive.
You will receive a notification that the Email Archiving feature is enabled.
IMAP Access
You can view messages in multiple ways through an IMAP connection:
To use a cPanel-provided auto-configuration script, perform the following steps:
Page 75
1.
2.
3.
4.
Click on the IMAP Access option next to the domain for which you wish to view messages.
Choose from the list of mail clients and select either IMAP over SSL/TLS (recommended) or IMAP.
Follow the instructions to complete the setup.
Use the provided settings to manually set up a read-only configuration via IMAP.
To manually configure your mail client, perform the following steps:
1. Click on the IMAP Access option next to the domain whose messages you want to view.
2. In the selected mail client, provide the following information, where example.com is your domain
name:
Mail Server Username: archive@example.com
Your password is the same as your account password.
Incoming Mail Server: (SSL) mail.example.com
IMAP port: 993
Incoming Mail Server: (non-SSL) mail.example.com
IMAP port: 143
3. After you provide the information to your mail client, the daily directories will appear in the folder list.
Download Archives
To download the archives to your PC, perform the following steps:
1. Click the Download Archives option next to the domain for which you wish to view messages.
2. Select from the following options:
All archives
incoming
mailing lists
outgoing
3. A .zip file that contains the archived messages will download to your local computer.
Access Webmail
Use the Access Webmail link to view archived messages through Webmail.
Note:
Icon
You may need to take additional steps on some webmail clients.
Files
Page 76
(Home >> Files)
The following documents describe the features in the cPanel Files area.
Backups This feature allows you to download and store website files, databases, forwarders, and
filters.
Backups
(Home >> Files >> Backups)
o
o
o
o
o
Overview
Full backups
Create a Full Backup
Download a Full Backup
Store a Backup file remotely
Partial Backups
System Backups
Restore the site from the Backups link
Important information about your backups
Contents of the home directory backup
Can I exclude files from a backup?
Overview
The Backups area allows you to download and store all or some of the websites files, databases,
forwarders and filters.
Experienced users who wish to expedite the backup process will prefer this tool.
Note:
Icon
Newer users may prefer to use the Backup Wizard.
Page 77
Full backups
You can use this interface to create a full backup. The full backup will include your /home directory,
databases, email forwarders, and filters.
Create a Full Backup

To save a copy of your website to the web server, perform the following steps:
1.
2.
3.
4.
Click Download or Generate a Full Web Site Backup.

Select Home Directory from the Backup Destination heading.
Enter your email address.
Click Generate Backup. You will receive an email after the backup is complete.
The backup file's creation date appears in the filename (which begins with backup-MM-DD-YYYY).
The system will store the file as a tarball, or compressed data file, with the .tar.gzfile extension.
Download a Full Backup

To download a full backup to your computer, perform the following steps:
1. Click Download or Generate a Full Web Site Backup.
2. Under Backups Available for Download, select the backup file that you wish to save to your
computer.
The backup file's creation date appears in the filename (which begins with backup-MM-DD-YYYY).
The system will store the file as a tarball, or compressed data file, with the .tar.gzfile extension.
Store a Backup file remotely

You can use the Full Backup interface to log in to a remote computer through FTP or SCP and store
the backup files there.
To remotely store a backup file, perform the following steps:
1. Select Remote FTP Server, Remote FTP Server (passive mode transfer), or Secure Copy
(SCP) from the Backup Destination menu.
2. Enter the remote server's information in the text boxes that appear when you select the backup
destination.
3. Click Generate Backup.
You will receive an email after the process is complete.
Notes:
Icon
This feature is intended for advanced users.

Page 78
You cannot use a full backup to restore your site through the cPanel interface. You must download
and compress the file prior to restoration. After you decompress the file, you will be able to upload
and restore individual portions of your website that the full backup contained.
Partial Backups
The Backups interface allows you to download individual pieces of your account.
If you wish to download your entire /home directory, your SQL database(s), and your email
forwarders and filters, click the appropriate links under the Partial Backups headings. This method
downloads the backup file(s) to your computer and saves them to a specified directory.
Warning:
Icon
The Email Filters backup file that you download will only store the domain account-level email filters
that are found in the /etc/vfilters/$domain file. The backup file will not store user account-level
email filters.
System Backups
If your webhost has enabled system backups, you can use the System Backups interface to
download a compressed copy of your websites files.
You will see options to download the most recent backup made at daily, weekly, or monthly intervals.
Download Options for System Backups
Restore the site from the Backups link

This function will restore portions of your site from a backup file on your computer.
To restore a portion of your site, perform the following steps:
1. Click the appropriate Choose File button.
For example, if you wish to restore your MySQL database, click Choose File under the Restore a
MySQL Database heading.
Page 79
2. Select the backup file from your computer.

3. Click Upload to restore that portion of your site.

Contents of the home directory backup
When you back up your /home directory, the backup includes the following files:
All of the files that you own.

Files that you do not own but have access to.
Note:
Icon
Backup files do not include files from your /home directory that you do not own and do not have
access to.

To exclude certain files and directories from a backup, place a configuration file in
your /home directory. For more information, read our How to Exclude Files From
Backups documentation.
Backup Wizard The Backup Wizard is a user-friendly interface that allows you to create a partial
or full backup of your website. It also allows you to restore your website from the last backup that
you saved.
Backup Wizard
(Home >> Files >> Backup Wizard)
Overview
Back up your entire site
Create a partial backup
Restore a portion of your site
Page 80

o
o

What is included in my home directory backup?
Overview
The Backup Wizard is a user-friendly interface that allows you to create a back up your entire site,
back up part of your site, or restore your site from the most recent backup. New users may find this
tool easier to use than the standard Backups interface.
To begin, select whether you wish to back up or restore your website.
Back up your entire site

To create a full backup, perform the following steps:
1. Select Backup on the first interface.
2. Select Full Backup on the second interface.
3. Select one of the following destinations for the backup files:
Home Directory This option stores the files in your home directory.
Remote FTP Server or Remote FTP Server (passive mode transfer) These options use FTP to
transfer the files to another server. Fill in the appropriate information about the destination server.
Secure Copy (SCP) This option uses SCP to transfer the files to another server. These options
use FTP to transfer the files to another server. Fill in the appropriate information about the
destination server.
4. Click Generate Backup.
5. If you selected Home Directory, click the filename under Backups Available for Download to
download the backup file.
The filename of the backup file contains its creation date in the following format: backup-MM-DDYYYY. The system will store the file as a tarball, a compressed data file that ends with
the .tar.gzextension.
Note:
Icon
You cannot use a full backup to restore your site through the cPanel interface. You must download
and compress the file prior to restoration. After you decompress the file decompressed, you will be
able to upload and restore individual portions of your website that the full backup contained.
Create a partial backup

To back up a portion of your site, perform the following steps:
Page 81
1. Select Backup on the first interface.

2. Click Home Directory, MySQL Databases, or Email Forwarders and Filters to select the portion of
your site to back up.
3. Click the appropriate link or button on the following interface to store the required information to your
computer or web server.
Note:
Icon
The type of the backup file will depend on what portion of your site you are saving to your computer.
The following table contains a list of backups and their file types:
Part of Site
File Type
Home Directory
*.tar.gz
Email Forwarders
*.net, *.com
Email Filters
*.net, *.com
SQL Database
*.sql
Restore a portion of your site

To restore a portion of your site:
1. Select Restore from the first page.
2. Click Home Directory, MySQL Databases, or Email Forwarders and Filters to select the portion of
your site that you wish to restore.
3. Select the file on your computer from which you wish to restore the desired portion of your website.
4. Click Upload to begin the restoration process.
Note:
Icon
The type of the backup file will depend on what portion of your site you wish to restore. The following
table contains a list of backups and their file types:
Part of Site
File Type
Page 82
Part of Site
File Type
Home Directory
*.tar.gz
Email Forwarders
*.net, *.com
Email Filters
*.net, *.com
SQL Database
*.sql

What is included in my home directory backup?
When you back up your home directory, the backup includes the following files:
All of the files that you own.

Files that you do not own, but to which have access.
Note:
Icon
Backup files do not include files from your /home directory that you do not own and do not have
access to.

To exclude certain files and directories from a backup, place a configuration file in your home
directory. For more information, read our How to Exclude Files From Backups documentation.
File Manager The File Manager allows you to manage website files through your web browser.
File Manager
Page 83
( Home >> Files >> File Manager )
o
o
Overview
The File Manager Directory Selection window
The File Manager toolbar
Character encoding verification
Select a directory
The file window
The navigation toolbar
File and folder actions
Search for a file
Overview
The File Manager interface allows cPanel users to manage and edit their files.
The File Manager Directory Selection window

When you open the File Manager interface, perform the following steps:
1. The File Manager Directory Selection window will appear. Select which of the four main directories
you wish to view in the file window:
Home Directory (/home/user)
Web Root (/public_html/www)
Public FTP Root (/public_ftp)
Document Root (/public_html)
2. If you wish to see hidden files, select the Show Hidden Files checkbox.
3. If you do not wish to see the File Manager Directory Selection window again, select the Skip this
question checkbox.
4. Click Go.
The File Manager interface opens in a new browser window. The selected directory will display in
the file window.
The File Manager toolbar

The File Manager toolbar shows the following functions to manage your files:
Feature
Icon
Description
Page 84
Feature
Icon
Description
New File
Creates a new file with a user-defined file extension.
New Folder
Creates a new folder in the current directory.
Copy
Copies selected items to a user-specified directory.
Move File
Moves the selected files to a new directory.
Upload
Uploads files to the selected directory.
Download
Downloads selected files to your computer.
Delete
Deletes selected files from the server.
Rename
Renames the selected file or folder.
Edit
Opens the selected files in a text editor.
Code Editor
Opens the selected files in a code editor.
HTML Editor
Opens the selected HTML file in a visual HTML editor.

Note:
To learn more about the editor's functions, visit our HTML
Editor documentation.
Change
Permissions
Changes the read, write, and execute permissions for selected files.
Page 85
Feature
Icon
Description
View
Opens the selected file so that you can view the code.
Extract
Extracts the selected *.zip, *.Gz, or *.Bz2 archive and stores the files in
a directory.
Compress
Compresses the selected files to a single *.zip, *.Gz, or *.Bz2 archive

and stores the compressed file in a specified directory.
Notes:
Icon
When a toolbar action is not available, the function icon turns gray.
We designed certain File Manager functions for use with only one file at a time. Select the desired
file in the file window before you attempt these actions.
Any attempt to Rename, Edit, or View multiple files at once will only affect the first listed file in the
directory.
The Extract and Compress functions will only work with the .zip format if Zip is installed on your
server. Your system administrator can run the yum install zip command to install the Zip
module.
Character encoding verification

When you edit a file with Edit, Code Editor, or HTML Editor, a window will appear to confirm the file's
character encoding. Use the menu to select the correct character encoding for the file. Then,
click Edit to continue.
Click Toggle Help to display more information about how to select the correct character encoding.
Click Disable Encoding Check to turn off future verification dialogs.
You can also turn Character Encoding Verification Dialogs on or off:
1. Click Settings in the top left corner of File Manager. A new window will appear.
2. Enable or disable Character Encoding Verification Dialogs:
To turn the encoding verification off, select the Disable Character Encoding Verification
Dialogs checkbox.
To turn the encoding verification on, deselect the Disable Character Encoding Verification
Dialogs checkbox.
3. Click Save
Page 86
Warning:
Icon
If you choose the wrong initial encoding, your file may become corrupt. If your file displays as a
series of special characters, immediately abort the edit and select the correct encoding. Do not save
the file.
Select a directory
You can use the file tree or the location text box to navigate your files and folders.
There are several ways you can use the file tree (located to the left of the file window) to browse
your files:
Click on the name of the folder you wish to view

Click on the
next to the
icon to view a list of subfolders in that folder.
You can click on the
next to an expanded directory to collapse it.
Note:
Icon
After you expand a list of subfolders, click on the folder name to view the folder's contents.
To use the location text box directly above the file tree, perform the following steps:
1. Enter the path of the folder you wish to view.

2. Click Go. The file window will display the contents of the chosen folder.
The file window

The file window displays the contents of the selected directory. If there are no files or folders in the
selected folder, the file window will display the message "This directory is empty."
Information about files and subfolders will display in the following columns:
Feature
Description
File Icon
Files will display an icon that corresponds to the file type. Folders will display the
icon.
Name
The filename.
Page 87
Feature
Description
Size
The size of the file.
Last
Modified
The date and time the file was last modified.
Type
The media (MIME) type and subtype.
Perms
The permissions setting for the file, in octal notation. The default permission setting
is 0644.
Note:
Icon
Click on a column's heading to sort the file list by that column's value.
The navigation toolbar

Use the toolbar at the top of the file window to navigate between folders in the file window.
Feature
Description
Home
Navigates directly to the home directory (/home/user).
Up One
Level
Navigates to the folder that contains the currently selected folder. This option greys out
when you select the home directory.
Back
Returns to the folder that you viewed immediately before the currently selected folder.
Forward
Navigates to the next folder that you viewed, after you use Back.
Reload
Refreshes the displayed list of files and folders.
Select all
Selects all displayed files and folders.

Note:
Icon
Any attempt to Rename , Edit , or View multiple files at once will only affect the
Page 88
Feature
Description
first listed file in the directory.

Unselect all
Deselects all files and folders that the interface currently displays.
File and folder actions

Right-click on files or folders in the file window to choose from a menu of actions customized to the
file's type.
Feature
Displays for
Description
Download
Files,
Compressed
Files
Downloads the selected file to your computer.
View
Files,
Compressed
Files
Opens the selected file so you can view the code.
Edit
Files
Opens the selected files in a text editor.
Code Edit
Files
Opens the selected files in a code editor.
HTML Edit
Files
Opens the selected HTML file in a visual HTML editor.
Move
Files,
Compressed
Files, Folders
Move the selected file or folder to a new directory.
Copy
Files,
Compressed
Files, Folders
Copies the selected file or folder to a user-specified directory.
Page 89
Feature
Displays for
Description
Rename
Files,
Compressed
Files, Folders
Renames a selected file or folder.
Change
Permissions
Files,
Compressed
Files, Folders
Allows a user to change the read, write, and execute permissions for
selected files or folders.
Delete
Files,
Compressed
Files, Folders
Deletes the selected files or folders from the server.
Extract
Compressed
Files
Extracts the selected *.zip, *.Gz, or *.Bz2 archive and stores the
files in a directory.
Compress
Files,
Compressed
Files, Folders
Compresses the selected files or folders to a single *.zip, *.Gz,

or *.Bz2 archive and stores the compressed file to a specified
directory.
Password
Protect
Folders
Sets a username and password to restrict access to a folder.

Note:
Icon
Your service provider must enable this feature.

Leech
Protect
Folders
Redirects users who may have shared the password to a

restricted area of your site with others. The system will redirect
accounts that exceed a set number of logins in a two hour period
to a selected URL, or visitors will receive an internal server
error message.
Note:
Icon

Manage
Indices
Folders
Customizes the way in which users view a directory on the

web.
Note:
Page 90
Feature
Displays for
Description
Icon
Search for a file

The Search tool at the top right corner of the interface allows users to search for a specific file. By
default, Search will search all files in the home directory. You can also limit the search to the
document root at/home/user/public_html, or to the directory that displays in the file window.
To search for a file, perform the following steps:
1. Use the Search menu to choose the directory to search: All Your Files, only public_html or Current
Directory.
2. Enter the desired file name in the text box.
3. Click Go.
A new window displays the filenames that match your search. To go to a folder, or to the folder that
contains the desired file, double-click the desired item in the list. If there are no files that include your
search term, you will see the message No records found.
Legacy File Manager The Legacy File Manager offers an older web-based interface to users who
wish not to use the newer interface.
Legacy File Manager

(Home >> Files >> Legacy File Manager)
Overview
Legacy File Manager Directory Selection
Navigation toolbar
The Legacy File Manager toolbar
Properties menu
Page 91
o
o
o
Folder options
File options
Character encoding verification dialogs
Overview
The Legacy File Manager interface offers file manipulation options in an older web-based interface.
Users who are already familiar with an older version of cPanel may wish to use the Legacy File
Manager interface rather than cPanel's current File Manager interface (Home >> Files >> File
Manager).
Legacy File Manager Directory Selection

When you open the Legacy File Manager interface, perform the following steps:
1. The Legacy File Manager Directory Selection window will display. Select which of the following main
directories you wish to view:
Home Directory (/home/user)
Web Root (/public_html/www)
Document Root (/public_html)
2. Select the Show Hidden Files checkbox to see hidden files.
3. Select the Skip this question checkbox if you do not want to see the Legacy File Manager Directory
Selection window again.
4. Click Go.
The Legacy File Manager interface opens in a new browser window. The selected directory displays
in the file window.
Navigation toolbar
Use the toolbar at the top of the file window to navigate between folders in the file window.
Feature
Icon
Description
Home
Navigates directly to the home directory (/home/user).
Go Up One Dir
Navigates to the folder that contains the currently selected folder.
To navigate the files and folders in your current directory, perform one of the following actions:
Click a
to navigate the file tree.
Page 92
Click the folder name to view the file or folders properties.

Note:
Icon
After you expand a list of subfolders, click the folder name to view the folder's contents.
The Legacy File Manager toolbar

The toolbar, which is located above the folder list, shows the functions that are available to create or
upload files and folders to the Legacy File Manager .
Feature
Icon
Description
Upload files
Uploads files to the current directory.
Create a New
Folder
Creates a new folder in the current directory.
Create a New File
Creates a new file in the current directory with a user-defined file

extension.
Properties menu
This menu, which is located on the right-side of the interface, shows the functions available to
manage your folders and files.
Folder options
Click a folder to see the following options:
Feature
Icon
Description
Delete this folder and all files

under it
Deletes the selected folder and all subfolders from the

server.
Change Permissions
Changes the Read, Write, and Execute permissions for the

selected files.
Page 93
Feature
Icon
Description
Rename Folder
Renames the selected file or folder.
Copy this folder
Copies the selected folder to a user-specified directory.
Move this folder
Moves the selected folder to a new directory.
File options
Click a file to see the following options:
Feature
Icon
Description
Show File
Opens the selected file in a new window.
Delete File
Deletes selected files from the server.
Edit File with Code

Editor
Opens the selected file in a code editor.
Edit File
Opens the selected file in a text editor.
Change Permissions
Changes the Read, Write, and Execute permissions for the selected file.
Rename File
Renames the selected file.
Copy File
Copies the selected items to a user-specified directory.
Move File
Moves the selected file to a user-selected directory.
Download File
Downloads the selected file to your computer.
URL
Displays the selected file as it would look on the website.
Page 94
Feature
Icon
Description
Empty Trash
Recovers any deleted files and folders.
Click on the name of the file or folder that is listed below the trash icon
to recover that item.
Click on the icon to permanently delete the items in the trash.
Note:
Icon
These options are specific to the type of file that you select. All options will not appear for each type
of file.
Character encoding verification dialogs

When you edit a file with the Edit or Code Editor options, use the menu to select the correct
character encoding for the file. Then, click Edit to continue.
You can also turn Character Encoding Verification Dialogs on or off through Settings:
1. Click Settings in the top left corner of the interface.
2. Select Disable Character Encoding Verification Dialogs:
To turn the encoding verification off, select the Disable Character Encoding Verification
Dialogs option.
To turn the encoding verification on, deselect the Disable Character Encoding Verification
Dialogs option.
3. Click Save
Warning:
Icon
If you choose the wrong initial encoding, your file may become corrupt. If your file displays as a
series of special characters, immediately abort the edit and select the correct encoding. Do not save
the file.
Web Disk The Web Disk application allows you to manage files through your operating system's
interface.
Web Disk
Page 95
(Home >> Files >> Web Disk)
o
o
o
o
o
Overview
Main Web Disk Account
Create an Additional Web Disk Account
Manage Additional Web Disk Accounts
Password protect a Web Disk directory
Create a user to access a protected Web Disk directory
Remove an authorized user from a protected directory
Access a Web Disk account
Enable or disable digest authentication
Change the Web Disk password
Delete a Web Disk account
Set Web Disk account permissions
Note for Windows XP and Vista users
Note for Windows 7 users
Related documentation
Overview
The Web Disk application allows you to manage and manipulate files on your server in multiple
types of interfaces, such as your PC, mobile device, or certain types of software. You can choose a
more familiar interface that will make file management tasks easier to complete.
For example, if you access Web Disk from your computer, it will open in a window with which you
can move, add, or delete files on the server, as shown below:
The Web Disk Utility
Page 96
Main Web Disk Account

By default, the Main Web Disk Account is created with the user's home directory set as the Web
Disk location. This account uses the same login information as your cPanel account and has access
to all of the files in your home directory.
The Main Web Disk Account Login and Directory are displayed in the Main Web Disk Account table.
From this table you can choose to perform the following actions:
Click Access Web Disk to open Web Disk on your computer.

Click Enable Digest Authentication to allow Windows Vista, Windows 7, or Windows 8 to access
your Web Disk over a clear text or unencrypted connection.
Note:
Icon
The Main Web Disk Account cannot be deleted.
Create an Additional Web Disk Account

You can create additional users to use with the home directory, or any subdirectory under the home
directory, as the Web Disk location.
Create an Additional Web Disk Account.

To create a Web Disk account, perform the following steps:
Page 97
1. Enter the desired username in the Username text box.

If you have more than one domain, select a domain or subdomain from the menu.
Notes:
Icon
Icon
The password must be at least five characters long.
3. Enter the directory that you wish Web Disk to connect to on startup in the Directory text box.
4. Select the Permissions level for this account.
Read-Write This access level permits all supported operations inside the assigned directory.
Read-Only This access level only permits this account to read, download, and list files inside the
assigned directory.
5. If you use Windows Vista, or later versions of Windows, and you wish to use Digest
Authentication without SSL, select the checkbox next to Enable Digest Authentication without SSL
(Windows Vista (or later) support).
Note:
Icon
If you are unsure of this feature, it can be enabled at a later time.
6. Click Create.
Manage Additional Web Disk Accounts

The Manage Additional Web Disk Accounts table displays all additional user accounts that you
create for Web Disk. If you have a large number of Web Disk accounts, you can use the Search box
above the table to find specific accounts.
Page 98
Column
Description
Login
The login for the account, in username@domainname.com format.
Directory
The assigned directory for the account.

* Click on the directory path to open the directory in a new File Manager window.
* Click
to change the assigned directory.
* Click to change password protection for the directory. See below for more
information.
Access
Web Disk
Click Access Web Disk to go to that account's Web Disk interface. See below for more
information
Actions
From this column you can Enable Digest Authentication, Change Password, Delete the
account, and toggle permissions between Read-Only and Read-Write. See below for more
information.
Password protect a Web Disk directory

Note:
Icon
Password protection does not control Web Disk access to a directory. This feature allows you to
ensure that the files you upload remain password protected if they are uploaded to a publicly
accessible directory that is linked to your account. If you choose to password-protect a Web
Disk directory, you must create a user to access that directory.
To password protect a Web Disk directory, perform the following steps:
1. Click for the Web Disk account that you wish to protect. A new window will appear.
Note:
Icon
Page 99
This feature affects the Web Disk account's assigned directory.

2. Select the Password protect this directory box.
3. Enter a name for the protected directory in the Name the protected directory text box.
4. Click Save.
Create a user to access a protected Web Disk directory
To create a user who can access the protected directory:
1. From the Manage Additional Web Disk Accounts table, click for the Web Disk account and
directory that you wish for the new user to access. A new window will open.
2. Enter the desired username in the Username text box.
Notes:
Icon
Icon
4. Click Add/modify authorized user.

Remove an authorized user from a protected directory
To delete a user:
1. From the Manage Additional Web Disk Accounts table, click for the Web Disk account and
directory that you wish the new user to access. A new window will open.
2. Select the username you wish to delete from the text text box under the Authorized Users heading.
3. Click Delete User.
Tip
Icon
This feature does not delete the Web Disk account, only the user account for the password
protected directory.
Page 100
Access a Web Disk account

To log in to a Web Disk account:
1.
2.
3.
4.
Click the Access Web Disk button that corresponds to the account that you wish to access.
Select your operating system's version from the appropriate menu.
Select the SSL checkbox if you wish to connect with SSL.
Follow the Manual Connection Instructions or the Quick Start Script Instructions to connect to
your Web Disk.
The Quick Start Script will download and run a script on your PC to connect to your Web Disk.
If you use Nautilus or Konqueror on a Linux system, you do not need to download a script. Follow
the instructions that appear on the page.
Enable or disable digest authentication

To enable digest authentication:
1. Click Enable Digest Authentication.
2. Confirm your password in the Enable Digest Authentication dialog box.
3. Click OK.
To disable digest authentication:
1. Click Disable Digest Authentication.
2. A Disable Digest Authentication confirmation dialog box will appear.
3. Click OK.
Note
Icon
Digest Authentication is required if you use Windows Vista, Windows 7, or Windows 8 and you
access Web Disk over a clear text, unencrypted connection. If a signed SSL certificate is present for
the domain, you do not need Digest Authentication enabled.
Change the Web Disk password

To change a Web Disk password:
1. Click the Change Password link that corresponds to the account for which you wish to change the
password.
Notes:
Icon
Page 101
Icon
3. If desired, check Enable Digest Authentication.

4. Click Change.
Delete a Web Disk account

To delete a Web Disk account, perform the following steps:
1. Click the Delete link that corresponds to the account that you wish to delete. A new page will appear.
2. Click Yes.
If you wish to keep the account, click Cancel.
Set Web Disk account permissions

To change a Web Disk account's permissions, perform the following steps:
1. Select the Permissions level for the account.
Read-Write This access level permits all supported operations inside the assigned directory.
Read-Only This access level only permits this account to read, download, and list files inside the
assigned directory.
2. A Setting Read-Only Access or Setting Read-Write Access confirmation dialog box will appear.
3. Click OK.
Note for Windows XP and Vista users

If you use Windows XP or Vista, you may need to download a patch from Microsoft's website to
use Web Disk without errors.
Page 102
Note for Windows 7 users

If you use Windows 7, you may notice a discrepancy between the amount of disk space that is
reported and the amount of disk space that is actually available. This is due to the fact that the
WebDAV protocol, which Web Disk uses, is unable to query a server's disk capacity.
For more information, read Microsoft Support's article about this problem.
Disk Space Usage The Disk Space Usage interface displays how much disk space your website
uses and information about the content in that space.
Disk Space Usage

(Home >> Files >> Disk Space Usage)
Overview
Notes
Overview
This interface displays information about how you use your disk space. It can also help you manage
your disk space quota, because it indicates files and directories that use large amounts of hard disk
space.
The Disk Space Usage feature lists all of the subdirectories contained within your home directory.
You can click any of the listed directories to open the appropriate subdirectory in cPanel's File
Manager feature. This function allows you to view specific disk usage information about individual
files and directories contained within the subdirectory.
Note:
Icon
The Disk Space Usage feature does not display disk usage information for individual files contained
within your home directory.
This feature also displays disk space usage summaries for:
Files contained within your home directory

Files in hidden subdirectories
Page 103
Mailing lists in Mailman

Files not contained within your home directory (see Other Usage bar)
Note:
Icon
The bars in the graph represent disk usage figures relative to the largest directory, not a fixed scale.
Notes
Due to the nature of storing files electronically, most files occupy slightly more disk space than their
actual size. For example, a 300 byte file may occupy 4 KB of actual disk space. As a result, you may
find some discrepancies between data in the File Manager feature and the Disk Space
Usage feature.
The disk space usage information contained in this feature does not indicate how much space the
directory itself uses. It only displays disk usage information about the directory's contents. Typically,
directories themselves occupy a negligible amount of disk space.
The figures contained in the Disk Space Usage feature may not reflect recent changes in your
account's disk space.
FTP Accounts The FTP Accounts interface allows you to manage File Transfer Protocol (FTP)
accounts.
FTP Accounts
(Home >> Files >> FTP Accounts)
o
o
o
o
Overview
Add an FTP account
Manage FTP accounts
Change an FTP account's password
Edit an FTP account's quota
Remove an FTP account
Configure an FTP client
View the FTP logs
Page 104
Overview
File Transfer Protocol (FTP) allows you to manage your website's files. cPanel includes an FTP
server that is pre-configured and easy to use.
If you are a website owner, and your system administrator enables FTP services, your FTP access
should already be configured. You can use your cPanel account username and password to log in to
FTP. You can also set up FTP accounts for additional users.
Note:
Icon
You can only access the FTP Accounts feature if your system administrator has enabled FTP
services on your server.
Add an FTP account

FTP accounts allow users to access the domain's folder on the server's hard disk.
To create an FTP account, perform the following steps:
1. Enter the desired username in the Login text box.
Notes:
Icon
3. Specify the FTP account's home directory.
Note:
Icon
The Directory text box defines the top level of directory access that the new account will have. For
example, if you enter example in the Directory text box, the FTP account will have access to
the /home/$user/example directory and all of its subdirectories.
Important:
Icon
Page 105
You cannot use symbolic links (symlinks) to upload data outside of this directory.
4. Set the disk space quota. The Quota text box determines how much disk space to allocate to the
FTP account.
If the desired quota is not Unlimited, enter the maximum amount of data in MB.
Note:
Icon
If your system administrator has chosen to use ProFTPD, you will not be able to use quotas. For
more information, contact your system administrator.
5. Click Create FTP Account. The new account will appear in the FTP Accounts table.
Important
Icon
If you experience problems when you attempt to upload files with FTP, you may need to adjust the
quota to allow more disk space for your account.
Manage FTP accounts

The FTP Accounts table allows you to manage existing FTP accounts.
To search for a specific FTP account, perform the following steps:
1. Enter a keyword in the text box.
2. Click Search Accounts. The FTP Accounts table will display only the FTP accounts that contain the
keyword.
3. To return to the list of all FTP accounts, click Clear Search.
Change an FTP account's password

To change an FTP account's password, perform the following steps:
1. Click Change Password for the FTP account for which you wish to change the password.
Notes:
Icon
Page 106
3. Click Change Password.
Edit an FTP account's quota

Quotas limit the amount of data that a user can upload to your server.
To change an FTP account's quota, perform the following steps:
1. Click Change Quota for the FTP account for which you wish to change the quota.
2. Select the desired FTP Quota option.
If the desired quota is not Unlimited, enter the maximum amount of data in MB.
Note:
Icon
The user will not be able to upload more than the total disk space allotment for your hosting
account, regardless of the quota that you set here.
3. Click Change Quota.
Note:
Icon
You cannot use quotas if ProFTPD is your FTP server. ProFTPD does not support quotas. For more
information, contact your system administrator.
Remove an FTP account

To remove an FTP account, perform the following steps:
1. Click Delete for the FTP account that you wish to remove.
2. Confirm that you wish to delete the FTP account.
Note
Icon
Click Delete Account to remove the FTP account. This will not remove the files that the FTP
account's home directory contains.
Click Delete Account and Files to remove the FTP account and all of the files that the FTP account's
home directory contains.
Click Cancel to hide the Delete options if you do not wish to delete the account.
Page 107
Configure an FTP client

When you configure an FTP client through this interface, a script will download to your computer.
Run this script to automatically open, configure, and connect the FTP client to your FTP server.
Important
Icon
You must install the FTP client on your computer before you download and run the script file. For
instructions, visit the FileZilla or Core FTP websites for Windows computers, or
theCyberduck website for Mac computers.
To configure an FTP client, perform the following steps:
1. Click Configure FTP Client for the desired FTP account.
2. Click the appropriate FTP Configuration File to select an FTP client. You can choose between
Filezilla, Core FTP, or Cyberduck.
Note:
Icon
cPanel currently only supports these three FTP clients for auto-configuration. You may use another
client, but you will need to manually configure the client yourself. Click Instructions (new window) to
view detailed instructions for your chosen client.
3. Open the configuration script file that has downloaded to your computer. The FTP client will
automatically open, configure itself, and connect to your FTP server. Then, you will be free to
manage your websites content.
Remember
Icon
If you encounter problems when you try to automatically configure your FTP client, make sure your
client is properly installed on your computer. If problems persist, consult your FTP clients
documentation.
Note:
Icon
If you choose to use a different FTP client or the command line, reference the Manual
Settings section for your FTP Username, FTP Server, and SFTP Server Port that you should use to
connect to your account.
View the FTP logs

If you need to see who has accessed your site with FTP, you can view this information in the raw
access log files for your website.
Page 108
To view past FTP connections to your site, navigate to cPanel's Raw Access Logs interface (Home
>> Logs >> Raw Access Logs). FTP logs will include ftp_log in the filename. For more information,
read our Raw Access Logs documentation.
FTP Session Control The FTP Session Control interface allows you to view and disconnect FTP
sessions that are currently connected to your account.
FTP Session Control

(Home >> Files >> FTP Session Control)
Overview
View current FTP sessions
Disconnect users from an FTP session
Overview
Use the FTP Session Control interface to view general information about who logs in to your FTP
server. You can also use the FTP Session Control interface to terminate FTP connections to your
site.
Note:
Icon
You will only see the FTP Session Control icon if your system administrator enables FTP services on
your server.
View current FTP sessions

The FTP Session Control interface includes the following information about connections to your FTP
server:
Column
Description
Example
User
The username for the FTP account that is logged in.
user
Logged in
From
The host through which the user connected to your

FTP server.
ns1.example.com
Page 109
Column
Description
Example
Login Time
The time and date at which the FTP session started.
Fri Jul 19 13:19:20

2013
Status
The status of the FTP session.
IDLE
Disconnect
Click Disconnect (
Process ID
The process ID for the FTP session.
) to stop an FTP session.

13926
The Reload button refreshes the list of FTP sessions. Click Reload to see if any other users have
logged in to your FTP server since you last viewed the list.
Disconnect users from an FTP session

If you suspect malicious activity from a user, or if the user is idle, you can disconnect their FTP
session.
To disconnect users from an FTP session, perform the following steps:
1. Click the Disconnect icon (
) that corresponds to the FTP session that you wish to disconnect.
2. To verify that the account is no longer connected, click Reload.
Anonymous FTP Controls The Anonymous FTP interface allows you to define how anonymous
users interact with your FTP server.
Anonymous FTP Controls

(Home >> Files >> Anonymous FTP)
Overview
Controls
Page 110
Welcome message
Overview
The Anonymous FTP interface allows you to define how anonymous users interact with your FTP
server.
Note:
Icon
You will only see the Anonymous FTP icon if your system administrator has enabled FTP
services and anonymous FTP.
Controls
Warning:
Icon
We strongly recommend that you deny anonymous users the ability to upload files to your FTP
server. This setting will prevent malicious software uploads, which can harm your website.
To configure Anonymous FTP Controls, perform the following steps:
1. Select the boxes for any permissions that you wish to allow.
2. Deselect the boxes for any permissions that you wish to deny.
3. Click Save Settings.
When users log in to FTP anonymously, they must format usernames
as anonymous@example.com, where example.com represents the user's domain name. This
formatting requirement directs your server to the correct public_ftp directory. If a user does not
include a domain name, one of the following errors will appear:
If your server uses Pure-FTP as the FTP server, users will receive a 421 Can't change
directory to /var/ftp/ error message.
If your server uses ProFTP as the FTP server, users will receive a 530 Login Authentication
Failed error message.
Welcome message
You can set a message that anonymous FTP users see when they connect to your FTP server.
To save a welcome message, perform the following steps:
1. In the text box, enter the message that you wish visitors to see.
2. Click Save Message.
Page 111
Logs
(Home >> Logs)
The Logs interface provides access to logs and statistics for your websites.
Latest Visitors This feature displays information about the most recent 300 visitors to your site.
Latest Visitors
(Home >> Logs >> Latest Visitors)
Overview
View latest visitor details
Overview
This feature gives detailed information about the last 1,000 visits to your website. This information
helps you get to know your audience and monitor repeat visitors so that you can tailor your website
content to fit their needs. It also helps you locate and fix errors that your visitors encounter.
View latest visitor details

To view your latest visitor details, click the
button that is associated with the domain name.
By default, the interface displays the following information:
Detail
Description
Page 112
Detail
Description
IP
Specifies the visitors' IP address.
Time
Specifies the time at which the page was visited.
Size
Specifies the amount of data that was accessed.
URL
Specifies the specific URL that was visited.
Referring URL
Specifies the web address from which your visitor linked to your site.
User Agent
Specifies the browser that was used to access your website.
Click the
button to choose additional options that you wish to display.
Select any of the following options from the menu:
Option
Description
Status
The HTTP code indicates whether the page loaded successfully or resulted in an error.
Method
Specifies the request-response between the client and server (for example, GET or POST).
Protocol
Specifies the version of HTTP the page served when the visitor accessed the page (for
example, 1.1).
To search for additional records, enter your search criteria into the Search text box.
Bandwidth This feature provides information about the bandwidth that your account uses.
Bandwidth
Page 113
(Home >> Logs >> Bandwidth)
Overview
The bar graphs
The Today graph
The Past 7 Days graph
The Past 12 Months graph
Monthly pie charts
o
o
The Bandwidth Transfer Detail interface

The Bandwidth By Day table
The All Traffic monthly graph
Monthly traffic graphs by service
o
o
All Traffic daily graph

Daily traffic graphs by service
Overview
The Bandwidth interface displays bandwidth usage information in several sets of graphs. Each graph
contains information about bandwidth usage over a specific period of time.
The graphs display bandwidth information in six categories:
Http (web traffic)

Pop3 (received email)
Imap (received email)
Ftp (file transfer)
Smtp (sent email)
All
Notes:
Icon
Page 114
The All category displays in green and provides the combined total of all of the other categories.
The system only records bandwidth for outgoing SMTP messages. The system does not include
incoming messages in bandwidth calculation.
This information allows you to monitor the heaviest traffic times for your website, and helps you
decide whether to purchase additional bandwidth.
The bar graphs

The Today graph
The Today graph shows the data transfer rate in bits per second for the current day, averaged into
five minute intervals.
A sample Traffic for Today graph.

By default, this graph updates every two hours. However, if your hosting provider adjusts
the bandwidth data process interval in WHM's Statistics Software Configuration interface (Home >>
Server Configuration >> Statistics Software Configuration) the amount of bandwidth data that the
system displays is affected.
Use this graph to view the following information:
Small-scale trends, for example, quick spikes in traffic at specific times.

Changes over the course of the day, for example, increases and decreases in traffic.
The Past 7 Days graph

The Past 7 Days graph shows the data transfer rate, in bits per second, over the past seven days,
averaged into five-minute intervals.
Page 115
A sample Past 7 Days graph.

Use this graph to view the following information:
Larger-scale trends; for example, for example, spikes in traffic at the same time each day for the
past three days.
Changes from the past week, for example, increases or decreases in traffic over a period of two to
seven days.
The Past 12 Months graph

The Past 12 Months graph shows the total amount of data that the system transferred over a period
of 12 months.
A sample Past 12 Months graph.
Use this graph to find long-term trends over an entire year. For example, your account receives a
heavy burst of traffic at mid-month every month.
Page 116
Monthly pie charts

The monthly pie charts allow you to visually compare the relative amounts of data that your cPanel
account's various services and domains run.
A sample pie chart.

Use the pie charts to view the following information:
The total amount of data that the system transferred for the month.
When there is a noticeable change in the relationships between services from month to month.
For example, SMTP total bandwidth increased from 5% to 50% in one month, while
HTTP bandwidth decreased.
When there is a change in the bandwidth usage of one domain relative to another.
For example, The domain example1.com accounts for about half of the overall traffic of all sites,
and example2.com accounts for about 25%.
To view the Bandwidth Transfer Detail interface for that month, click a pie chart.
Note
Icon
Click the appropriate usage link next to the monthly pie chart to look up usage information for an
individual website or service. The system will take you to a new interface which displays detailed
monthly traffic information for that particular service and website.
The Bandwidth Transfer Detail interface

To view the bandwidth transfer information for a particular month, click Total (all services).
This interface contains a series of bandwidth usage graphs that pertain to a particular month for the
following types of traffic:
HTTP
SMTP
FTP
POP3
IMAP
Page 117
The Bandwidth By Day table

The Bandwidth by Day table lists the total amount of the cPanel user account's data that the system
transferred on a specific day of the month, in megabytes.
Click a day in the table to view more information about that day's traffic.
A sample Bandwidth by Day table.

Note
Page 118
Icon
We recommend that you view the Bandwidth by Day table at least 24-48 hours after the last day of
the period for which you wish to obtain data. This allows the system to gather and process the traffic
data.
The All Traffic monthly graph

The All Traffic monthly graph shows the hourly average bytes that the system transferred for the
month that you select. It provides a more detailed version of the data than the Past 12 Monthsgraph.
A sample All Traffic monthly graph.

Use this graph to find trends over a period of several days or weeks. For example, whether traffic is
heavier at certain times of day, or on certain days of the week.
Monthly traffic graphs by service

The monthly traffic graphs serve the same purpose as the All Traffic graph, but the system
separates the data to make it easier to recognize trends for a service.
A sample Http Traffic monthly graph.
Page 119
All Traffic daily graph

The All Traffic daily graph shows 30-minute averages of bits transferred per second. It is a more
detailed version of the All Traffic monthly graph from the Bandwidth Transfer Detail interface.
A sample All Traffic daily graph.
Daily traffic graphs by service

Under the All Traffic graph is a series of one or more bar graphs for specific services. These serve
the same purpose as the All Traffic graph, but the system separates the data to make it easier to
recognize a single service's trends.
A sample daily Http Traffic graph
Logaholic This feature provides access to the Logaholic software. Logaholic is a web analytics
program that delivers information about your website's traffic, keywords, and content. If you do not
have this feature, contact your hosting provider.
Logaholic
Page 120
(Home >> Logs >> Logaholic)
Overview
Logaholic statistics
Overview
The Logaholic interface allows you to access data from the Logaholic web analytics software, which
provides information about your website's traffic, keywords, and content.
Notes:
Icon
If the Logaholic feature is not available, contact your hosting provider.

The Logaholic software stores data in a server-level MySQL database.
Logaholic statistics
To view Logaholic's statistics for a domain click the View Stats link that corresponds to the domain
that you wish to view. The interface will display the Logaholic software statistics in a new browser
window.
For more information about Logaholic, view the Logaholic Web Analytics website.
Webalizer This feature provides access to the Webalizer software. Webalizer compiles and
analyzes information about your web traffic.
Webalizer
(Home >> Logs >> Webalizer)
Overview
Page 121
View your Webalizer Logs

Overview
Webalizer is a complex statistical analysis program that produces charts and graphs about your
website.
View your Webalizer Logs

To begin, click the
button under the View heading next to the appropriate domain name.
Webalizer will open in a new window.
Webalizer displays a series of bar graphs, with a key below the graphs. The summary is displayed
by month and by day over several different categories.
These categories are:
Hits
Files
Pages
Visits
Sites
Kilobytes
Page 122
Usage statistics in Webalizer

When you click the link for a month, Webalizer shows more details:
Referrers (sites visitors link from)

HTTP codes
Browser information
For more information about Webalizer, visit the webalizer website.

To view all possible configuration options for your Webalizer, visit Configuration Files Documentation
for Webalizer.
Webalizer FTP This feature provides access to the Webalizer FTP software. Webalizer FTP
compiles and analyzes information about your FTP server.
Webalizer FTP
Page 123
(Home >> Logs >> Webalizer)
Overview
Webalizer FTP
Overview
This feature displays your FTP site's statistics.
Webalizer FTP
The interface displays the statistics in bar graphs and divides them into monthly and daily averages.
To use Webalizer FTP, perform the following steps:
1. Select the Click here to view link that corresponds to the domain that you wish to view.
2. Webalizer FTP opens in a new window.
For more information about Webalizer, visit the Webalizer website.
AWStats This feature provides access to the AWStats software. AWStats compiles information
about the way users access your website.
AWStats
(Home >> Logs >> Awstats)
Overview
View AWStats data
Page 124
Overview
The Awstats interface allows you to access data from the Advanced Web Statistics (AWStats)
software, which compiles information about the way users access your website.
AWStats displays the following details about the visitors to your website:
Monthly, daily, and hourly averages in graphs and tables

The links through which visitors access your website
HTTP error codes
Operating systems
Browsers
Countries of origin
View AWStats data

To view AWStats data for a domain, click the
icon that corresponds to the domain you wish to
view. A new browser window will open with the AWStats software statistics for that domain.
For more information about AWStats, view the AWStats official website.
Raw Access Logs This feature allows you to view your access logs, which allows you to see what
content has been accessed on your account.
Raw Access Logs

(Home >> Logs >> Raw Access Logs)
Overview
Configure Logs
Download and View Your Raw Access Logs
Archived Raw Logs
Page 125
Overview
Raw access logs are text files that contain information about your website's visitors and the content
on your website that they have accessed. This feature allows you to download a zipped version of
your access log.
Configure Logs
This section allows you to configure cPanel to automatically archive logs and when to automatically
delete them.
Select the Archive logs in your home directory at the end of each stats run box to save archived logs
into the /home directory each time the system processes your website's statistics.
Note:
Icon
The system processes website statistics approximately every 24 hours.
Select the Remove the previous month's archived logs from your home directory at the end of each
month box to remove the previous month's logs at the end of each month.
Click Save to store your changes.
Download and View Your Raw Access Logs

This section lists the domains on your account, as well as the log information.
Domain A list of the domains on your account. To access a domain's raw access log, perform the
following steps:
1. Click the desired link to download that domain's raw access log.
2. The log file will automatically download to your computer.
3. Unzip the file to view it.
Last Update The date of the most recent update to the log file.
Disk Usage The amount of disk space that the log files uses.
Linked Domains A list of the domains that are parked on top of the domain.
Archived Raw Logs

This section lists the archived logs that are contained in your /home directory.
Click the filename to download an archived log.
Page 126
You can also view the log file through the command line in your /home/username directory. Use
your preferred text editor to open the access-logs file.
Note:
Icon
If you do not have any archived log files, the directory will be empty.
Analog Stats This feature provides access to the Analog Stats software. Analog Stats allows you
to analyze website traffic.
Analog Stats
(Home >> Logs >> Analog Stats)
Overview
View Analog Stats
Overview
The Analog Stats interface allows you to access data from the Analog software. Analog compiles
traffic statistics for your domain, and organizes the data by month so that it is easy to manage and
interpret. The software also presents the data for each month in graphs to show additional
categories.
View Analog Stats

To view Analog's statistics for a domain, perform the following steps:
1. Click the
icon that corresponds to the domain that you wish to view. This will open a new
browser tab.
2. Select the month for which you wish to view traffic statistics. The interface will display the Analog
software statistics for that month.
For more information about the Analog software, visit the Analog website.
Page 127
Error Log This feature displays 300 of your website's most recent errors.
Error Log
(Home >> Logs >> Error Log)
Overview
Error Log details
Overview
The Error Log displays recent errors that may affect your website. Use this log to find and fix broken
links and misconfigured web applications.
Error Log details

This log displays up to 300 of the most recent entries from Apache's error logs.
Notes:
Icon
Only error log listings that include /home/user, where user is the username for the account,
appear in the Error Log.
The data includes entries from the /usr/local/apache/logs/suexec_log file and
the /usr/local/apache/logs/error_log file.
The error log contains the most recent 2 MB of each log file.
Access the individual log files to view older entries.
The Apache logs document all of the requests that Apache handles. Tasks that other services
handle may have separate log locations.
The server handles the configuration of the log files. Contact your system administrator to change
the level of information in the log files.
For more information about individual error messages and other configuration options, visit
the Apache documentation.
Page 128
Choose Log Programs This feature allows you to choose the statistical analysis programs that
you wish to use.
Choose Log Programs

(Home >> Logs >> Choose Log Programs)
Overview
Available programs
Overview
Your hosting provider can allow you to choose multiple log programs to record statistics about your
website.
Available programs
You can select any of the following log programs:
Webalizer
Analog Stats
Logaholic
AWStats
1. For each domain on your account, select the checkbox of the stats program(s) that you wish to use.
For example, if you wish to use Analog over other stats programs, select the checkbox
under Analog and leave the others blank.
2. Click Save.
Note:
Icon
This option is only available if your web host enables it. If your web host does not allow you to select
log programs, a lock icon (
) appears.
Note:
Page 129
Icon
If this feature does not allow you to select a log program, contact your hosting provider.
Security
(Home >> Security)
The following documents describe the features of the cPanel Security box.
Password Protect Directories This feature allows you to restrict access to certain parts of your
website.
Password Protect Directories

(Home >> Security >> Password Protect Directories)
Overview
Configure a password for a directory
Change password
Remove password protection
Overview
Use this feature to configure a password that will protect certain directories of your account. If you
enable this feature, a user who tries to open a protected folder will be prompted to enter a username
and password before they can access the content.
Page 130
Configure a password for a directory

To password protect a directory, perform the following steps:
1. Select the directory that you wish to lock with a password. Click
navigate to a different folder. Click the folder name to select it.
Note:
to
Icon
Any subdirectories located in the directory that you select will also be password protected.
2. Select the Password protect this directory checkbox.
3. Enter the name that you want visitors to see in the Name the protected directory text box.
Note:
Icon
The directory name can be anything, regardless of what the directory itself is named.
4. Click Save.
After you complete this process, you must create a user that can access the directory.
Change password
To change the authorized user's password, perform the following steps:
1. Reenter the user's information in the Create User section.
2. In the Password text box, enter the new password that you wish to save for that user.
3. Click Add/modify the authorized user.
Remove password protection

To remove password protection from the directory, unselect the Password protect this
directory checkbox in the Security Settings section and click Save.
IP Deny Manager This feature can block a single IP address or a range of IP addresses.
IP Deny Manager
Page 131
(Home >> Security >> IP Deny Manager)
Overview
Block an IP address
Current blocked IP addresses
Unblock an IP address
Overview
The IP Deny Manager interface allows you to block access to your site for one or more IP addresses
or fully qualified domain names (FQDNs).
Block an IP address
Note:
Icon
If you enter IP addresses directly in the .htaccess file, enter them in CIDR format only.
To deny access to an IP address or range of IP addresses, perform the following steps:
1. Enter the IP address or range in the IP Address or Domain text box. You can enter IP addresses in
any of the following ways:
Single IP Address (for example, 10.5.3.333).
Range (for example, 10.5.3.3-10.5.3.40).
Implied Range (for example, 10.5.3.3-40).
CIDR Format (for example, 10.5.3.3/32).
Implied IP Address (for example, 10.).
2. Click Add.
Warning:
Icon
10. as an implied IP address implies 10.*.*.*, where each * represents a positive whole number.
If you enter 10., cPanel will now allow IP addresses that begin with 10. to access your site.
Page 132
Current blocked IP addresses

cPanel separates the IP address ranges that you enter through the IP Deny Manager interface into
subnets in CIDR format. Then, the system adds them to the .htaccess file. The interface will
display blocked IP addresses and ranges in CIDR notation.
For example, if you enter the range 208.74.124.96-208.74.124.128, the Current IP addresses
being blocked table will appear similar to the following example:
Unblock an IP address
To remove an IP address from the list of blocked IP addresses, perform the following steps:
1. Click
in the Remove column for the appropriate IP address.
2. Click Yes to confirm.
SSL/TLS Manager This feature allows you to manage SSL/TLS keys, certificates, and signing
requests. These features are intended to make your website more secure.
SSL/TLS Manager
(Home >> Security >> SSL/TLS Manager)
Overview
Documents available
SSL certificate creation privileges
Page 133
Overview
The features in this interface allow you to generate and manage SSL certificates, signing requests,
and keys, all of which enhance your website's security. They are useful for websites that regularly
work with sensitive information, such as login credentials and credit card numbers. Encryption
makes it difficult for malicious users to intercept communications between visitors and your website.
Documents available
The following documents provide more information about the sections of this interface:
Private Keys Generate, view, upload, or delete your private keys.
SSL Certificate Signing Request Generate, view, or delete SSL certificate signing requests.
Certificates Generate, view, upload, or delete SSL certificates.

Manage SSL Hosts Set up an SSL certificate for your site.
Note:
Icon
To view this interface, your domain must have a dedicated IP address, or your server must support
SNI.
Manage Certificate Sharing Change your site's certificate sharing permissions.
SSL certificate creation privileges

The following table describes a user's privileges to create an SSL certificate:
User Type
Privileges
Website owners
Website owners can only create SSL certificates on domains that they own that
are hosted on a dedicated IP address.
Reseller
Resellers can create SSL hosts on any IP address that is dedicated to the
reseller. This IP address cannot be dedicated to an SSL resource.
Reseller
with rootprivileges
The root user, or a reseller with root privileges, can create an SSL certificate
on any available IP address on the server. This IP address cannot be dedicated
to an SSL resource.
Page 134
SSH/Shell Access These features allow you to connect to your server remotely.
SSH/Shell Access
(Home >> Security >> SSH/Shell Access)
o
o
o
o
o
Overview
How to SSH with PuTTY
How to SSH with Mac OS X or Linux
Manage SSH keys
Generate a New Key
Import an existing key
Delete a key
View or download a key
Manage a Key's Authorization
Connect with SSHTerm
Connect with Java Telnet Applet
Overview
SSH (secure shell) and Telenet are network protocols that allow you to connect to another computer
(for example, your web server) over the Internet through a command line interface (CLI). You can
use them to remotely manage your server, configure CGI scripts, and perform other tasks.
Many modern operating systems, such as Mac OS X and Linux distributions, include SSH and
Telnet. If you use Microsoft Windows to connect to your server, you will need an SSH client to log
in to your server. Putty is a popular SSH client, and you can download it
from http://www.chiark.greenend.org.uk/~sgtatham/putty/.
Many commands have been standardized on Unix-based operating systems, such as Mac OS or
Linux, . For a list of standardized Unix-based (POSIX) commands, visit http://www.oneserve.com/tools/unix_commands.php or consult your preferred Internet search website.
Note:
Icon
Not all hosting providers allow shell access.
Page 135
How to SSH with PuTTY

To use PuTTY to connect to your server with SSH, perform the following steps:
1. Download and install the client from the URL above.
2. Open the client.
3. Under the Sessions menu, enter the IP address of the server.
Note
Icon
Be sure to select SSH.
4. Click Open.
5. Use root as the login name.
6. Enter the root password.
If the username and password are correct, you will log in to the server.
How to SSH with Mac OS X or Linux

To use SSH to connect your server, perform the following steps:
1. Open a terminal session.
2. Run the following command:
ssh -p $port $user@$IP
Note
Icon
In the above command:
$port represents the port number.
$user represents your username.

$IP represents your IP address.
Manage SSH keys

You can use cPanel to create, import, manage, and remove SSH keys. The system will use these
keys when you confirm that a specific computer has the right to access your websites information
with SSH.
Page 136
Generate a New Key

To generate a new key, perform the following steps:
1. Click Manage SSH Keys.
2. Click the Generate a new Key icon.
3. Fill in the appropriate information.
Note
Icon
RSA keys yield a faster confirmation of identity, while DSA keys will speed up key generation and
signing times.
4. Click Generate Key to generate the new SSH key and automatically install it to the server.
Import an existing key

To import an existing key, perform the following steps:
1.
2.
3.
4.
Click the Import Key icon.

Choose a name for the key.
Paste the private and public keys in to the two text boxes.
Click Import.
Delete a key
To delete a key, perform the following steps:
1. Click Delete next to the key that you wish to delete. A new interface will appear.
2. Click Delete Key to confirm that you wish to delete the key.
View or download a key

To view or download a key, perform the following steps:
1. Click View/Download next to the key. A new interface will appear.
2. Click Download Key to download the key. You can also copy the key and save it on your computer.
Note:
Icon
When you click View/Download in the Private Keys table, you also have the option to convert the key
into .ppk format.
Page 137
To convert a private key and save it onto the server, perform the following steps:
1. Enter the key's passphrase into the text box.
2. Click Convert. A new interface will appear.
Note:
Icon
At this point, the system saves the .ppk key file
ias ~/.ssh/putty/$file.ppk (where $file represents the name of the original SSH key).
3. Click Download Key to download the converted key to your computer.
Manage a Key's Authorization

To authorize or deauthorize a key, perform the following steps:
1. Click Manage Authorization next to the key. A new interface will appear.
2. Click Authorize or Deauthorize.
Warning:
Icon
You may only authorize or deauthorize public keys on your web server. If you deauthorized a public
key, a user cannot log in with the corresponding private key.
Connect with SSHTerm

cPanel includes the SSHTerm application, which is a Java application that allows you connect to
your account via SSH through the cPanel interface.
To connect through SSHTerm with a username and password, perform the following steps:
1. Click Connect using SSHTerm.
2. If the system prompts you to accept a certificate, accept the certificate. The application will load after
a few moments.
3. Within the SSHTerm window, select File > New Connection.
4. Enter the web servers IP address.
5. Click Advanced.
6. Enter the username in the Username text box.
7. Select password under the Authentication Methods heading.
Note:
Icon
Page 138
You can also select publickey to authenticate with a public key.

8. Click Connect.
9. Enter the username and password.
10. Click Ok.
Connect with Java Telnet Applet

Warning
Icon
We recommend that you use SSH instead of Telnet when possible, because SSH connections are
more secure than Telnet.
cPanel contains a Java application called Java Telnet Applet, which allows you to connect to
your account through a Telnet connection via the cPanel interface.
To connect with Java Telnet Applet, perform the following steps:
1. Click Connect using Java Telnet Applet. Two new windows will appear.
2. In the window that requests login information, enter your username and password.
3. Click Login.
Notes
Icon
You cannot use keys as an authentication method for Java Telnet Applet. You must use a
username and password.
To learn more about Telnet and your operating system's commands, consult your preferred Internet
search engine.
HotLink Protection These features allow you to prevent the theft of bandwidth by other websites.
HotLink Protection
(Home >> Security >> HotLink Protection)
Page 139
Overview
Enable hotlink protection
Disable hotlink protection
Overview
A hotlink occurs when someone embeds content from your site in another site and uses your
bandwidth to serve the files. You can use this interface to prevent this issue.
Notes:
Icon
When you disable hotlinks, make certain that you allow hotlinks for any necessary domains (for
example, your website's subdomains and the URL that you use to access your cPanel account).
If the URL that you use to access your cPanel account is excluded from the URLs to allow
access list, you may not see embedded images in the HTML Editor in the File Managerinterface
(Home >> Files >> File Manager).
Enable hotlink protection

To enable hotlink protection, perform the following steps:
1. Click Enable.
2. To allow specific sites to hotlink to your site, add their URLs to the URLs to allow access list.
3. To block direct access to files of specific types, add those file extensions to the Block direct access
for these extensions list.
For example, if you wish to block all .jpg images, add .jpg to the Block direct access for these
extensions list.
When you block these file types, others will not be able to hotlink those types of files from your
website, regardless of any other settings.
4. Select Allow direct requests to allow visitor to access specific content through the URL.
For example, if you enable this setting, a visitor could
enter www.example.com/folder/example.jpg as a URL to access the example.jpg file.
5. To redirect requests for certain content, enter the URL to which you want to redirect your visitor in
the Redirect request to this URL text box.
6. Click Submit.
Disable hotlink protection

To disable hotlink protection, click Disable.
Note:
Icon
Page 140
When you click Disable, cPanel deletes the entries in the URLs to allow access list. Before you
disable hotlink protection, we recommend that you save the list locally.
Leech Protect These features allow you to deny users the ability to share passwords publicly.
Leech Protect
(Home >> Security >> Leech Protect)
Overview
Enable leech protection
Disable leech protection
Manage users
Overview
Leeching occurs when users publicly post their username and password to a restricted area of your
site, which allows other visitors to use the login information. You can configure cPanel to redirect or
suspend the leeched user. The protection function sets the maximum number of logins that can
occur within a two-hour period. If the account exceeds the login limit, the system presumes that the
user has allowed other visitors to use their login information.
Enable leech protection

To enable leech protection for your website, perform the following steps:
1. Click the name of the directory that you wish to protect.
To navigate directories, use the folder icon located next to the name of the directory.
2. Enter the maximum number of logins you wish to allow each user within a two-hour period.
3. To redirect users who exceed the maximum number of logins within a two-hour period, enter a URL
to which to redirect them to.
4. If you want the system to send an email alert when leech protection activates, select the Send Email
Alert to checkbox and enter the email address to alert.
5. To disable an account that exceeds the maximum number of logins within a two-hour period, select
the Disable Compromised Accounts checkbox.
Page 141
6. Click Enable.
Disable leech protection

To disable leech protection, click Disable in the Disable Protection section.
Manage users
To add, etc, and delete users, click Manage Users to go to the Password Protect
Directories interface
Note
Icon
If you wish to manage the users manually, you can edit
the /home/USERNAME/.htpasswds/public_html/passwd file, where USERNAME represents the
account name.
GnuPG Keys These features allow create and manage GnuPG keys, which use the public key
approach to encryption.
GnuPG Keys
(Home >> Security >> GnuPG Keys)
Overview
Create a New Key
Import Key
Delete or view keys
Overview
GnuPG keys use the public key approach to encryption. Servers that use GnuPG keys encrypt
outbound messages with a public key. Only the intended recipient, who has the private key, can
decrypt the message.
Page 142
Create a New Key

To add a GnuPG key, perform the following steps:
1. Fill in the text boxes below Create a New Key.
Warnings:
Icon
Use an appropriate expiration date for your key. One year is the default.
2. Select the key size from the Key Size menu.
3. Click Generate Key.
Import Key
To import an existing GnuPG key, perform the following steps:
1. Copy and paste the key into the available text box.
2. Click Import.
The system will automatically install the key.
Delete or view keys

After you add a key set to the server, you can delete it or view it under the appropriate
(Public or Private) heading.
Domains
Page 143
(Home >> Domains)
The following documents describe the interfaces in the cPanel Domains section.
Subdomains The Subdomains interface allows you to create and manage subdomains.
Subdomains prefix to your domain name and point to a subdirectory within
your public_htmldirectory.
Subdomains
(Home >> Domains >> Subdomains)
o
o
o
Overview
Create a subdomain
Search subdomains
Modify a subdomain
Modify the document root for a subdomain
Enable or disable subdomain redirection
Remove a subdomain
Overview
A subdomain is a subsection of your website that exists as a subdirectory in
your public_html (Document Root) directory. Subdomains use a prefix in conjunction with the
domain name. For example, if the registered domain name is example.com, the subdomain will
be prefix.example.com.
It is important to remember that it takes time for the subdomain to become recognized by other
computers on the web. Visitors will not be able to view your subdomain immediately; the process
takes anywhere from two days to a week.
You can use subdomains to create unique user accounts for vanity domains. This is helpful if, for
example, you have a blog, or any other type of website that uses a domain specifically titled for a
user.
Page 144
Create a subdomain
To create a subdomain, perform the following steps:
1. Enter the desired prefix in the Subdomain text box.
2. Select the desired main domain from the menu.
3. Enter the home directory for the subdomain in the Document Root text box.
This directory will be where files that pertain to the subdomain will be placed.
4. Click Create.
Warning:
Icon
Due to the order in which Apache processes its configuration file, wildcard subdomains may disrupt
the functionality of proxy subdomains. We strongly recommend that you use wildcard subdomains
only when absolutely necessary, or when you do not need to use proxy subdomains.
To open the subdomains main directory with the File Manager, click the link under Document
Root that corresponds to the subdomain that you want to view in the File Manager.
Search subdomains
To search through existing domains, perform the following steps:
1. Enter the search criteria into the Search text box.
2. Click Go.
Results that match your search criteria will populate the list.
Modify a subdomain
Modify the document root for a subdomain
To modify the document root for a subdomain, perform the following steps:
1. Click the notepad icon that corresponds to the subdomain that you want to manage.
2. Enter the new file path that you want to use as the document root in the available text text box.
3. Click Change.
Enable or disable subdomain redirection

To enable or disable redirection of a subdomain, perform the following steps:
1. Click the Manage Redirection link that corresponds to the subdomain that you wish to manage.
Page 145
2. If you wish to redirect the subdomain, enter the link to which you want to redirect the subdomain in
the available text text box.
3. Click Save.
4. To disable the redirect, click Disable Redirection.
Remove a subdomain
To remove an existing subdomain, perform the following steps:
1. Click the Remove link that corresponds to the subdomain that you want to remove.
2. Click Yes to confirm that you want to remove the subdomain.
3. To keep the subdomain, click No.
Addon Domains The Addon Domains interface allows you to create and manage addon domains.
Some hosts do not allow cPanel users to have addon domains.
Addon Domains
(Home >> Domains >> Addon Domains)
o
o
o
Overview
Create an addon domain
Modify Addon Domain
Modify the document root for an addon domain
Enable or disable addon domain redirection
Remove an addon domain
Email accounts in addon domains
Search addon domains
Addon vs. parked domains
Overview
An addon domain allows a new domain name to link to a subdirectory of your account. The system
stores the addon domains files in a subdirectory of your public_html (Document Root) directory.
Addon domains allow you to control multiple domains from a single account. Your hosting provider
Page 146
can enable addon domains in WHM's Tweak Settings interface (Home >> Server Configuration >>
Tweak Settings).
Create an addon domain

To create an addon domain, perform the following steps:
1. Enter the new addon domain's domain name in the New Domain Name text box.
Note
Icon
When you enter the domain name, cPanel automatically populates the Subdomain or FTP
Username text box. If you want to create multiple addon domains that have the same username and
different extensions (such as example.com and example.net), manually enter a unique username
into the Subdomain/FTP Username text box.
2. Enter the directory that will contain the addon domains files in the Document Root text box.
3. Enter the password for the addon domain into the Password text box.
Notes:
Icon
Make sure that you use a secure password.

You can use the Generate Password feature to generate a secure password.
4. Confirm the password in the Password (Again) text box.
5. Click Add Domain
Note:
Icon
When you create an addon domain in the cPanel interface, the system automatically creates a
subdomain. If you alter or delete the subdomain after you create it, you may affect or delete the
information that the addon domain's website displays.
6. To add files to the addon domains home directory, click File Manager.
Note:
Icon
You can find web statistics for the addon domain under the subdomain's URL in the statistics
application.
Page 147
Modify Addon Domain

Modify the document root for an addon domain
To modify the document root for an addon domain, perform the following steps:
1. Click the notepad icon that corresponds to the addon domain that you wish to manage.
2. Enter the new file path that you wish to use as the document root in the available text box.
3. Click Change.
Enable or disable addon domain redirection

To disable or enable an addon domain's redirection, perform the following steps:
1. Click the Manage Redirection link that corresponds to the addon domain that you wish to manage.
2. If you wish to redirect the domain, enter the link to which you wish to redirect the addon domain in
the available text box.
3. Click Save.
To disable the redirect, click Disable Redirection.
Remove an addon domain

To remove an existing addon domain, perform the following steps:
1. Click the Remove link that corresponds to the addon domain that you wish to remove.
2. To confirm that you wish to remove the addon domain, click Yes.
3. To keep the addon domain, click No.
Email accounts in addon domains

You can create email accounts for addon domains. To learn how to set up an email account for an
addon domain, read our Email Accounts documentation.
When you remove the addon domain, its email accounts will no longer appear in the cPanel
interface. However, the contents for this email account still exist in
the home/username/mail directory
If you add the domain back to the same account as the primary domain, an addon domain, or a
parked domain, the email accounts will reappear in the cPanel interface.
If you move the domain to a different account, you must move the email accounts and the contents
of the email accounts to the new account manually. The email accounts must follow the same name
and same domain format that they previously followed.
You can use the cPanel interface to add new accounts, or you can run the /scripts/addpop script
to manually add new email accounts.
Page 148
To move one email account under a domain, run the following command:
mv /home/old_account/mail/domain_name/email_account /home/new_account/mail/domain_name/
After you run this command, the system creates

the /home/new_account/mail/domain_name/ directory.
To move all of the email accounts under a domain, run the following command:
mv /home/old_account/mail/domain_name /home/new_account/mail
After you move the files, change the ownership of the new account with the following command:
chown -R new_account:new_account /home/new_account/mail/domain_name
Note:
Icon
Verify ownership of the email account after you move it.
Search addon domains

To search the list of addon domains, perform the following steps:
1. Enter the search criteria into the Search box.
2. Click Go.

Characteristic
Addon
domains
Parked
domains
The main domain appears in the address bar.
Yes
No
The domain uses the following Apache directive:
VirtualHost
ServerAlias
The domain uses separate logs.
Yes
No
The domain uses separate stats.
Yes
No
The system treats the domain as a subdomain (other than the
Yes
No
Page 149
Characteristic
Addon
domains
Parked
domains
No
Yes
URL).
This type of domain is ideal for multiple domains that share the
same address.
Parked Domains The Parked Domains interface allows you to create and manage parked
domains. Parked domains allow you to redirect website visitors to another domain.
Parked Domains
(Home >> Domains >> Parked Domains)
Overview
Create a New Parked Domain
Enable or disable parked domain redirection
Remove Parked Domains
Search parked domains
Email accounts in parked domains
Overview
Parked domains are domains that you own but that do not contain any content. You can use parked
domains to hold a domain that is for sale or redirect traffic to another domain.
Create a New Parked Domain

To add a parked domain, perform the following steps:
1. Enter the name of the domain that you wish to park in the available text box.
Page 150
2. Click Add Domain

To open the parked domains home directory with the File Manager (Home >> Files >> File
Manager), click the link under Document Root that corresponds to the parked domain that you wish
to view.
Note:
Icon
You can create email accounts for parked domains. To learn how to set up an email account for a
parked domain, read the Email Accounts documentation.
Enable or disable parked domain redirection

To enable or disable redirection of a parked domain, perform the following steps:
1. Click the Manage Redirection link that corresponds to the parked domain that you wish to manage.
2. If you wish to redirect the domain, enter the link tto which you wish to redirect the parked domain in
the available text box.
3. Click Save.
To disable the redirect, click Disable Redirection.
Remove Parked Domains

To remove an existing parked domain, perform the following steps:
1. Click the Remove link which corresponds to the parked domain that you would like to remove.
2. Click Yes to confirm that you wish to remove the parked domain.
To keep the parked domain, click No.
Remember:
Icon
We strongly suggest that you create a full account backup before you remove a parked domain.
Search parked domains

To search through the list of parked domains, perform the following steps:
2. Click Go.
Page 151
Email accounts in parked domains

You can create email accounts for parked domains. To learn how to set up an email account for a
parked domain, read the Email Accounts documentation.
When you remove the parked domain, the parked domain's email accounts will no longer appear in
the cPanel interface. However, the contents for this email account still exist in the mail folder of the
user's home/username/mail directory.
If you add the domain back to the same account as the primary domain, an addon domain, or a
parked domain, the email accounts will reappear in the cPanel interface.
If you move the domain to a different account, you must add the email accounts manually and move
the contents of the email accounts manually. The email accounts must follow the same name and
same domain format that they previously followed.
These email accounts will also appear in the Email Accounts interface if you change the accounts
primary domain name to the unparked domain name. You can perform this action in WHMsModify
an Account interface (Home >> Account Functions >> Modify an Account). When you perform this
action, the former primary domain names mailboxes will not appear in the Email Accounts interface.
However, the files will still exist.
You can add new accounts with the Email Accounts interface (Home >> Mail >> Email Accounts), or
you can run the /scripts/addpop script to manually add new email accounts.
To move one email account under a domain, run the following command:
mv /home/old_account/mail/domain_name/email_account /home/new_account/mail/domain_name/
When you run this command, the system creates

the /home/new_account/mail/domain_name/ directory.
To move all the email accounts under a domain, run the following command:
mv /home/old_account/mail/domain_name /home/new_account/mail
After you move the files, change the new account's ownership with the following command:
chown -R new_account:new_account /home/new_account/mail/domain_name
Note:
Icon
Verify ownership of the email account after you move it.

Characteristic
Addon
domains
Parked
domains
Page 152
Characteristic
Addon
domains
Parked
domains
The main domain appears in the address bar.
Yes
No
The domain uses the following Apache directive:
VirtualHost
ServerAlias
The domain uses separate logs.
Yes
No
The domain uses separate stats.
Yes
No
The system treats the domain as a subdomain (other than the

URL).
Yes
No
This type of domain is ideal for multiple domains that share the
same address.
No
Yes
Redirects The Redirects interface allows you to create and manage domain redirection.
Redirects
(Home >> Domains >> Redirects)
Overview
Add a redirect
Remove a redirect
Search your redirects
Page 153
Overview
The Redirect feature allows you to send all of the users that access a domain or particular page to a
different URL.
For example, if you have a long URL that you can not shorten, you can use the Redirect feature to
add a redirect from a short URL to the long URL. Users can then access the content of the long URL
via the short URL.
Add a redirect
To add a redirect, perform the following actions:
1. Select a redirect type from the Type menu.
The Permanent 301 option will notify the visitors browser to update its records.
The Temporary 302 option will not update the visitors bookmarks.
2. Select **All Public Domains** or a domain name from the menu.
Use the **All Public Domains** option to redirect all of the domains that your cPanel accounts
control.
3. In the text box to the right of the domain selection menu, enter the rest of the URL that you want the
server to redirect.
4. In the redirects to text box, enter the URL to which you wish to redirect users.
Important:
Icon
You must specify a protocol in this text box. For example, http://, https://, or ftp://.
The Only redirect with www option will only redirect users who enter www in front of the page name.
The Redirect with or without www. option will redirect all users regardless of whether the www. prefix
is included with the URL.
The Do Not Redirect www. option will not redirect users who enter www. with the URL.
6. Select the Wild Card Redirect option if you wish to redirect all files within a directory to the same
filename in the new directory.
For example, if you enable the Wild Card Redirect option and example1.com redirects
to example.com, then a visitor who tries to access the http://example1.com/pic.jpg URL will
redirect to the http://example.com/pic.jpg URL.
7. Click Add.
To test the redirect, click the link under Directory in the Current Redirects table. This will take you to
the original domain, which should be redirected, if it is properly configured.
Important
Page 154
Icon
You cannot edit a redirect. To modify a redirect, you must delete and then recreate it.
Remove a redirect
To remove a redirect, perform the following steps:
1. Click the
button that corresponds to the redirect that you want to remove.
2. To confirm that you want to remove the redirect, click Yes.
To keep the redirect, click No.
Search your redirects

To search your redirects, perform the following steps:
2. Click Go.
The redirects that match your search criteria will populate the list.
To sort your list of redirects, click the appropriate table heading. For example, Directory or Type.
Simple DNS Zone Editor The Simple DNS Zone Editor allows you to add and remove A and
CNAME DNS records.
Simple DNS Zone Editor

(Home >> Domains >> Simple DNS Zone Editor)
Overview
Add an A record
Add a CNAME record
Delete a record
Page 155
Overview
DNS is the component of the Internet that converts human-readable domain names (for
example, example.com) into computer-readable IP addresses (for example, 192.0.32.10). DNS
uses DNS zone files that reside on your server to link domain names to IP addresses.
There are several different types of records in a domain's zone file. This feature allows you to create
and delete A and CNAME records.
Note:
Icon
You cannot set a record's time to live (TTL) in this interface. cPanel will use the TTL that your
webhost has specified.
Add an A record
An A record is a DNS record that maps hostnames to IP addresses. A records are essential
because they allow DNS servers to identify and locate your website and its various services on the
Internet. Without appropriate A records, your visitors will not be able to access your website, FTP
servers, or email accounts.
To add an A record, perform the following steps:
1. If this account owns more than one domain, select the domain that you wish to manage from the
menu.
2. Enter the Name and Address of the A record.
3. Click Add A Record.
Important
Icon
cPanel will configure your DNS records so that visitors can resolve your website and its services (for
example, FTP and Email). You should only add A records when you add a service that cPanel or
your web host do not provide.
Add a CNAME record

A CNAME record (Canonical Name Record) creates an alias that allows a server to continue the
DNS lookup under the new name.
To add a CNAME record, perform the following steps:
menu.
2. Enter the Name and CNAME of the CNAME record.
Page 156
3. Click Add CNAME Record.
Delete a record
To delete an A or CNAME record, perform the following steps:
menu.
2. Click the Delete link that is next to the record that you wish to remove.
3. Click Delete to confirm that you wish to delete the record.
Advanced DNS Zone Editor The Advanced DNS Zone Editor allows you to add, edit, and remove
A, CNAME, and TXT DNS records.
Advanced DNS Zone Editor

(Home >> Domains >> Advanced DNS Zone Editor)
Overview
Reset zone files
Add a Record
Edit a record
Delete a record
Overview
DNS is the component of the Internet that converts human-readable domain names (for
example, example.com) into computer-readable IP addresses (for example, 192.0.32.10). DNS
does this through DNS zone files that reside on your server and link domain names to IP addresses.
There are several different types of records in a domain's zone file. This feature allows you to create,
edit, and delete A, CNAME, and TXT records.
Reset zone files

Warning:
Page 157
Icon
This feature erases any modifications that you make to your zone records, either with this feature or
with the Simple DNS Zone Editor (Home >> Domains >> Simple DNS Zone Editor). It attempts to
save .txt entries. Before you use this feature, be sure to write down any changes that you wish to
save.
To reset your DNS zone files to the defaults, perform the following steps:
1. Click more.
2. Select the Are you sure you want to erase all entries and revert to the default state? checkbox.
3. Click Reset Zone File.
Add a Record
To add a record, perform the following steps:

menu.
2. Enter the name of the record in the Name text box.
3. Enter the record's time to live (TTL) in the TTL text box.
TTL specifies how long the system should keep a particular record in memory, in seconds, before it
should refresh.
4. Select a record type:
An A record is the DNS record that maps hostnames to IP addresses. The A record is essential
because it allows DNS servers to identify and locate your website and its various services on the
Internet. Without an A record, your visitors cannot access your website, FTP servers, or email
accounts.
Remember
Icon
Page 158
The system will configure your DNS records so that visitors can resolve your website and its
services (for example, FTP and email). You should only add A records when you add a service that
cPanel or your web host does not provide.
CNAME record stands for "canonical name record." This record creates an alias, which allows a
server to continue the DNS lookup under the new name.
A TXT record is a text record that contains certain information that querying servers will read. These
records can carry useful data for the SPF or DKIM email authentication systems.
5. Enter the Address, CNAME, or TXT Data of the record.
6. Click Add A Record.
Edit a record
To edit a record, perform the following steps:

1.
2.
3.
4.
5.
Click Edit for the record that you wish to edit.

Edit the Name text box as necessary.
Edit the TTL text box as necessary.
Select the Type as necessary.
Enter the Address, CNAME, or TXT Data as necessary.
Page 159
6. Click Edit Record to save your changes.

To cancel your changes, click cancel.
Delete a record
To delete a record, perform the following steps:
menu.
2. Click Delete next to the record that you wish to remove.
3. Click Delete to confirm that you wish to delete the record.
Databases
(Home >> Databases)
The following documents describe the features in cPanel's Databases section. Databases offer a
method by which you can manage large amounts of information easily over the web. They are
necessary to run many web-based applications (for example, bulletin boards, content
management systems, and online retail shops).
MySQL Databases This interface allows you to manage your MySQL databases
and MySQL database users.
MySQL Databases

Page 160
(Home >> Databases >> MySQL Databases)
Overview
Create a New Database
Modify Databases
o Check a database
o Repair a database
Current Databases
o Search databases
o Modify a user's privileges
o Remove a user from a database
o Rename a database
o Delete a database
Create a MySQL user
Add a user to a database
Current Users
o Set Password
o Rename
o Delete
Overview
This interface allows you to create, manage, and delete MySQL databases and database users.
Note:
Icon
To perform these functions, some cPanel users may prefer to use the streamlined MySQL
Database Wizard interface (Home >> Databases >> MySQL Database Wizard).
Create a New Database

To create the database, perform the following steps:
1. In the New Database text box, enter a name for the database.
Note
Icon
The maximum length of the database name is 64 characters. If you enable database
prefixing, this length includes the database prefix and underscore character.
Page 161
2. Click Create Database.

3. Click Go Back. The new database will appear in the Current Databases table.
Note
Icon
To enter information in a database, use the phpMyAdmin interface (Home >> Databases >>
phpMyAdmin).
Modify Databases
Check a database
If you experience problems with a database on your server, check your databases for errors.
To check a database for errors, perform the following steps:
1. In the Check DB menu, select the database that you wish to check.
2. Click Check DB.
3. cPanel will run a script that checks to make sure the database is functional.
o If cPanel detects a problem in the database, it displays the name of the corrupt table.
o If the Check Complete message displays, that database is functional.
Repair a database
If one of your databases is corrupt, you will need to repair it.

To repair a database, perform the following steps:
1. In the Repair DB menu, select the database that you wish to repair.
2. Click Repair DB.
3. cPanel will run a script that attempts to automatically repair the database.
Note:
Icon
This will only attempt to repair the database. The repair may not succeed. If it does not, cPanel
will attempt to help you locate the source of the corrupt data.
Page 162
Current Databases
This table contains a list of databases on your server.
For each database, the table displays the following information:
Database The name of the database.

Size The size of the database.
Privileged Users Users who can manipulate the database.
Actions Click the appropriate icon in this column to rename or delete a database.
Search databases
To search the Current Databases table, perform the following steps:

1. Enter the desired criteria in the Search text box.
2. Click Go. The table will display the search results.
Modify a user's privileges
To modify a users privileges for database management, perform the following steps:
1. Click the users name in the row that corresponds to the database for which you wish to modify
privileges. The MySQL Account Maintenance interface will appear.
2. Select the checkboxes that correspond to the privileges that you wish to grant to the user.
Deselect any privileges that you do not wish to grant to the user.
3. Click Make Changes.
Remove a user from a database
When you remove a user from a database, you also remove the user's privileges for that database.
To remove a user from a specific database, perform the following steps:
1. In the Privileged Users column, click the
icon next to the name of the user in the row that
corresponds to the database.
2. If you are sure that you wish to remove the user from the database, click Revoke User Privileges.
Rename a database
Warning:
Icon
It is potentially dangerous to rename a MySQL database. We strongly recommend that you

perform a backup of the MySQL database before you attempt to rename it.
Page 163
If you rename a database, it will terminate all active connections to the database.
You must manually update configuration files and applications to use the new database name.
The system requires more time to rename larger and more complex databases.
To change a database's name, perform the following steps:

1. Click the Rename icon in the row that corresponds to the database that you wish to
rename.
Note
Icon
The maximum length of the database name is 64 characters. If you enable database
2. Enter the new database name in the New name text box
3. Click Proceed.
How cPanel renames a MySQL database
MySQL does not natively allow you to rename a database. When cPanel & WHM "renames" a database,
the system performs the following steps:
1.
2.
3.
4.
The system creates a new database.

The system moves data from the old database to the new database.
The system recreates grants and stored code in the new database.
The system deletes the old database and its grants.
Warning:
Icon
If any of the first three steps fail, the system will return an error and attempt to restore the
database's original state. If the restoration process fails, the API calls error response will also
describe these additional failures.
In rare cases, the system creates the second database successfully, but fails to delete the old
database or grants. The system treats this as a success; however, the API call will return
warnings that describe the failure to delete the old database or grants.
Delete a database
To delete a database from the server, perform the following steps:

1. Click the Delete icon in the row that corresponds to the database that you wish to delete.
2. If you are sure that you want to permanently delete the database, click Delete Database.
Page 164
Create a MySQL user

After you create a database, add users to fill and manage it.
Note:
Icon
You must create MySQL user accounts separately from mail and web administrator accounts.
To create a new user account, perform the following steps:

1. Enter a username in the Username text box.
Notes:
Icon
o
o
o
The system grades the password that you enter on a scale of 100 points. 0 indicates a
weak password, while 100 indicates a very secure password.
Some web hosts require a minimum password strength. A green password Strength
meter indicates that you met the required password strength.
Click Password Generator to generate a strong password. For more information, read
our Password Generator documentation.
Warning:
Icon
The password must contain seven characters or less.

3. Click Create User.
Add a user to a database

When you add a user to a database, you must also select privileges for that user. Privileges define
how the user is able to interact with the database. For example, they determine whether the user
can add and delete information for a specific database.
To add a user to a database, perform the following steps:
Page 165
1. Select a user from the User menu.

2. Select the database to which you wish to allow the user access from the Database menu.
3. Click Add. The MySQL Account Maintenance interface will appear.
4. Select the checkboxes that correspond to the privileges that you wish to grant to the user.
Note:
Icon
To grant all of the available privileges to the user, select the ALL PRIVILEGES
checkbox.
5. Click Make Changes.
Current Users
The Current Users table lists all of your MySQL users. Use the functions in this table to change
user passwords, rename users, and delete users.
Set Password
To change a MySQL user's password, perform the following steps:

1. Click the Set Password icon in the row that corresponds to the user whose password you wish to
change.
Notes:
Icon
o
o
o
Warning:
Icon

Page 166
Rename
To change the name for a MySQL user, perform the following steps:
1. Click the Rename icon in the row that corresponds to the user that you wish to change.
2. Enter the new username in the New Username text box.

Note
Icon
The maximum length of the database username is 64 characters. If you enable database
3. Click Change Username.
Delete
To delete a MySQL user account, perform the following steps:

1. Click the Delete icon in the row that corresponds to the user that you wish to delete.
2. If you are sure you want to permanently delete the account, click Delete MySQL Users.
MySQL Database Wizard This wizard provides steps to set up a MySQL database, as
well as the requisite accounts and privileges.
MySQL Database Wizard


(Home >> Databases >> MySQL Database Wizard)
Overview
Set up a database
Page 167
Overview
This wizard guides you through the setup of a MySQL database, MySQL user accounts, and
user privileges.
Set up a database
To set up a database with the MySQL Database Wizard, perform the following steps:
Note
Icon
The maximum length of a database name is 64 characters. If you enable database

2. Click Next Step.
3. In the Username text box, enter a name for the user who you wish to allow to manage the
database.
Notes:
Icon
o
o
o
Warning:
Icon

6. Select the checkboxes that correspond to the privileges that you want to grant the user, or
select ALL PRIVILEGES.
7. Click Next Step. cPanel will display a message that states that the database and user account
were set up successfully.
Page 168
o
o
o
Add another database Returns to the start of the MySQL Database Wizard.
Add another user using the MySQL Databases Area Opens the MySQL Databases
interface ( Home >> Databases >> MySQL Databases ).
Return to Home You will return to the cPanel Home interface (Home).
Note:
Icon
When you use the MySQL Database Wizard interface to add a user and a database, cPanel
automatically grants the user access to the database. There is no need to use the Add User to
Database feature in the MySQL Databases interface (Home >> Databases >> MySQL
Databases).
phpMyAdmin phpMyAdmin is a third-party tool that you can use to manipulate

MySQL databases. For more information about how to use phpMyAdmin, visit
the phpMyAdmin website.
PostgreSQL Databases This interface allows you to manage your PostgreSQL

databases and PostgreSQL database users.
PostgreSQL Databases

(Home >> Databases >> PostgreSQL Databases)
Overview
Create a database
Create a database user
Current Databases
o Search databases
o Change a database's name
o Remove a user from a database
o Delete a database
Define a user's privileges
Current Users
Page 169
o
o
o
Change a PostgreSQL user's name

Change a PostgreSQL user's password
Delete a PostgreSQL user
Overview
Databases allow you to manage large amounts of information easily over the web. They are
necessary to run many web-based applications such as bulletin boards, content management
systems, and online retail shops.
Notes:
Icon
Some users may prefer the PostgreSQL Database Wizard interface (Home >> Databases >>
PostgreSQL Database Wizard), which allows you to create PostgreSQL databases and users in
one process. You can also create databases, add users, and link users to databases with this
interface.
The maximum length of a database name is 63 characters. If you enable database prefixing, this
length includes the database prefix and underscore character ( _ ).
To allow you to enter new information in a PostgreSQL database, cPanel includes
a phpPgAdmin client. For more information about phpPgAdmin, visit the phpPgAdmin website.
Create a database
To create a PostgreSQL database, perform the following steps:
1. In the Database Name text box, enter a name for the database.
2. Click Create Database. The new database will appear in the Current Databases table.
Warning:
Icon
Some versions of PostgreSQL are ANSI SQL-92 compliant and do not support recursive grants,
wildcard grants, or future grants. To allow multiple users to access your PostgreSQL tables, click
Synchronize Grants after you add a table.
Create a database user

After you create the database, add users to the database and configure their privileges.
Note:
Icon
Page 170
You must create PostgreSQL user accounts separately from mail and web administrator
accounts.
To create a new user account, perform the following steps:
1. Under the PostgreSQL Users section of the interface, enter a username in the Username
text box.
Notes:
Icon
o
o
o
Warning:
Icon
The password must contain at least five characters.

Current Databases
The Current Databases table contains a list of all of the PostgreSQL databases on your server.
For each database, the table displays the following information:
The name of the database.

The size of the database.
Users who may manipulate the database.
A link that allows you to delete the database.
Search databases
To search for a specific database in the Current Databases table, enter your criteria in the Search
text box and click Go. The table will display the search results.
Page 171
Change a database's name
Warnings
Icon
If you rename a database, this will terminate all active connections to the database. You must
manually update configuration files and applications to use the new database name.
The system requires more time to rename larger and more complex databases.
To rename a database, perform the following steps:

1. In the Current Databases table, click the Rename icon in the Actions column of the user
that you wish to rename.
2. Enter the new database name in the New Database Name text box.
3. Click Change Database Name.
Remove a user from a database
To remove a user from a database, perform the following steps:

1. In the Current Databases table, click the
icon that is next to the user that you want to delete.
2. If you are sure that you want to remove the users privileges to manage the database, click Yes.
Delete a database
To delete a database, perform the following steps:

1. In the Current Databases table, click the Delete icon in the Actions column of the database that
you wish to rename.
2. If you are certain that you want to permanently delete the database, click Yes.
Define a user's privileges

Privileges define how the user is able to interact with the database. For example, they determine
whether the user can add and delete information.
To define a users privileges, perform the following steps:
1. Under the Add User to Database section of the interface, select a user from the User menu.
2. From the Database menu, select the database to which you wish to allow the user access.
3. Click Submit.
Page 172
Current Users
Change a PostgreSQL user's name
To change a PostgreSQL user's name, perform the following steps:

1. In the Current Users table, click the Rename icon in the Actions column for the user who you
wish to rename.
2. Enter the new username for the account in the New Username text box.
3. Click Change Username.
Warning
Icon
If you rename a PostgreSQL user, the Change Password interface will automatically appear to
allow you to reset the password for the database user. The md5 hash that PostgreSQL creates to
store user passwords requires this step.
Change a PostgreSQL user's password
To change a PostgreSQL user's password, perform the following steps:

1. In the Current Users table, click the Set Password icon in the Actions column of the user that you
wish to change.
Notes:
Icon
o
o
o
Warning:
Icon
The password must contain at least five characters.

Page 173
Delete a PostgreSQL user
To delete a PostgreSQL user account, perform the following steps:

1. In the Current Users table, click the Rename icon in the Actions column of the user that you wish
to rename.
2. If you are sure that you want to permanently delete the account, click Yes.
PostgreSQL Database Wizard This wizard provides steps to set up a PostgreSQL

database, as well as the requisite accounts and privileges.
PostgreSQL Database Wizard


(Home >> Databases >> PostgreSQL Database Wizard)
Overview
Set up a database
Additional options
Overview
This wizard guides you through the set up up of a PostgreSQL database, as well as the creation
of a user account for that database.
Set up a database
To set up a database, perform the following steps:
Note:
Icon
Page 174
The maximum length of a database name is 63 characters. If you enable database

2. Click Create Database.
3. In the Username text box, enter a name for the user who you wish to allow to manage the
database.
Note:
Icon
The maximum length of a database username is 63 characters. If you enable database

Notes:
Icon
o
o Some web hosts require a minimum password strength. A green password Strength
o Click Password Generator to generate a strong password. For more information, read
6. Review the User and Database names and click Submit.
cPanel will display a message that states that the database and user account were set up
successfully.
Additional options
After you complete the database setup process, select one of the following options:
Add another database Returns to the start of the PostgreSQL Database Wizard. Select this
option if you want to add more databases.
Add another user using the PostgreSQL Databases Area Opens the PostgreSQL
Databases interface (Home >> Databases >> PostgreSQL Databases), which you can
use to create additional user accounts and assign them to a database.
Note:
Icon
Page 175
When you use the PostgreSQL Database Wizard to add a user and database, the user is
automatically given access to the database. There is no need to use the Add User to
Database feature in the PostgreSQL Databases interface for that user.
Return to Home Returns to the cPanel Home interface.
phpPgAdmin phpPgAdmin is a third-party tool that you can use to manipulate

PostgreSQL databases. For more information about how to use phpPgAdmin, visit
the phpPgAdmin website.
Warning:
Icon
Some versions of PostgreSQL are ANSI SQL-92 compliant and do not support recursive
grants, wildcard grants, or future grants. To allow multiple users to access your
PostgreSQL tables, click Synchronize Grants in the PostgreSQL Databases interface
(Home >> Databases >> PostgreSQL Databases) after you add a table.
Remote MySQL This interface allows you to configure the ability of other web
servers to access your databases remotely.
Remote MySQL

(Home >> Databases >> Remote MySQL)
Overview
Allow a remote server to access your databases
Deny a remote server access to your databases
Overview
Other web servers can remotely access databases in cPanel. This can be useful if you want to
allow applications like shopping carts or guestbooks on your other servers to access your
databases.
Page 176
Allow a remote server to access your databases

To specify remote servers that can access MySQL databases on your server, perform the
following steps:
1. Enter the hosts name or IP address in the Host text box.
o You may enter a fully qualified domain name (FQDN) or an IP address.
o You may use % as a wildcard. For example, to allow access from all IP addresses that
begin with 192.68.0, enter 192.68.0.%.
2. Click Add Host.
Deny a remote server access to your databases

To deny a host access to databases on your server, perform the following steps:
1. Click the X icon next to the hosts name or IP address.
2. If you are sure that you want to deny access to your databases, click Yes.
Software/Services
(Home >> Software/Services)
The following documents describe cPanel's Software and Services features.
CGI Center Common Gateway Interface (CGI) allows a web server to run pieces of
software called scripts. The CGI Center interface provides CGI scripts that you can use to
set up a guestbook, clock, hit counter, countdown clock, and banner ads.
CGI Center
Page 177

(Home >> Software/Services >> CGI Center)
Overview
Simple CGI wrapper
Random HTML Generator
Simple Guestbook
Advanced Guestbook
Counter (Add a Counter, Clock, or Date)
Clock
Countdown
CGI Email
FormMail Clone
Entropy Search
Entropy Banners
o How to upload banners
o How to control a banner's schedule
o How to add rotating banners to a web age
Overview
CGI (Common Gateway Interface) allows you to run scripts. cPanels CGI Center provides a list
of CGI scripts that display and manage guestbooks, clocks, hit counters, and banner ads.
Simple CGI wrapper

The Simple CGI Wrapper creates the /public_html/scgi-bin directory. When you add
scripts to this folder, your web server handles them as CGI scripts.
When a visitor views the script in a web browser, the system runs the script. For example, when a visitor
navigates to http://www.example.com/scgi-bin/examplescript.cgi , the system runs the
/public_html/scgi-bin/examplescript.cgi script. You can also embed CGI scripts in a webpage with
the <action> tag.
Notes:
Icon
Every CGI script has unique configuration needs; be sure to consult the scripts installation
instructions. For example, you may need to define URLs and variables. Use the cPanel File
Manager interface (Home >> File >> File Manager) or a text editor in the command line interface
(CLI). To use the CLI, you will need SSH access to the web server as well as a command line text
editor.
Page 178
If your hosting provider uses suEXEC to run CGI scripts, the Simple CGI Wrapper will be
unnecessary. Contact your hosting provider to determine whether suEXEC is available.
Random HTML Generator

The Random HTML Generator script randomly selects and displays a line of user-defined text
every time that a visitor views your website.
To insert random text on a web page, perform the following steps:
1. Click Random HTML Generator.
2. In the text box, enter the text that you would like to display. Use line breaks to separate
each line of text. For example:
This is a funny quote.
This is another funny quote.
This is a third funny quote.
3. Click Save.
4. Paste the text into the HTML file where you want a randomly-selected line of text to
appear. The code will appear similar to the following:

Each time that a visitor views the web page, they will see a randomly-selected line from the list
that you entered in the Random HTML Generator.
Warning:
Icon
The file must use the .shtm or .shtml file extension.
Simple Guestbook
The Guestbook script allows visitors to leave comments about your website. To add a Guestbook,
copy and paste the HTML code at the bottom of the interface into your web page.
Click View Guestbook to view the Guestbook. To delete entries from the Guestbook or email a
guest, click Manage Guestbook.
To edit the appearance of the Guestbook, perform the following steps:
Page 179
1. Click Guestbook.
2. Click Edit Guestbook Template feature.
3. Edit the template.

Icon
You will need to be familiar with HTML to edit the template. Consult your preferred
search engine for tutorials and information about HTML.
4. Click Save.
Advanced Guestbook
Note:
Icon
Advanced Guestbook is now available as a cPAddon (Home >> Software/Services >> Site
Software ). If Advanced Guestbook is not available for your web site, contact your hosting
provider.
The Advanced Guestbook allows visitors to leave comments and greetings. You can configure it
to allow visitors to add photos and preview their entries.
To configure the Advanced Guestbook, perform the following steps:
1. Click Advanced Guestbook.
2. Read the License Terms before you continue.
3. Enter your desired username in the Admin User text box.

Warning:
Icon
This username will have administrative privileges for the guestbook.

4. Enter your desired password in the Admin Pass text box.
o You can use the Generate Password button to generate a secure password.
5. Confirm the password in the Admin Password (Again) text box.
6. In the Email text box, enter the email address at which you would like to receive guestbook
entries.
7. In the Installation URL text box, enter the web address where you want your guestbook to
appear.
o This will be the URL that your visitors will access to sign your guestbook.
8. In the Table Prefix text box, enter a unique prefix for the databases that the guestbook will use.
Page 180
This will ensure that your web server does not confuse guestbook entries with other
information on your website.
9. From the MySQL DB menu, select the database where you would like to save information about
guestbook visitors (for example, their names, email addresses, and websites).
o You can select a database that already exists or select Create New Database to create a
new database.
10. Click Install.
Click the displayed link to view the completed guestbook.
Counter (Add a Counter, Clock, or Date)

This script adds a counter to your website that tells you how many times visitors have viewed
your web site. You can also use this script to display the current time or date.
1. Click Counter.
2. Under Please select functionality, select Counter, Clock, or Date.
3. Configure the appearance of the counter, clock, or date display as desired.

4.
5.
6.
7.
8.
In the Counter Name text box, enter the name that you wish to use to save the configuration.
To preview the counter, clock, or date display, click Preview.
Click HTML to generate the HTML code that displays the counter, clock, or date.
Copy the text that begins with <img src= and ends with >
Paste the text into the HTML file where you want the counter, clock, or date to appear.
o If you wish to change the name of the script, enter the new name in the Counter Name
text box and click Commit Changes.
o To reset the count, enter a number in the New Count text box and click Commit
Changes.
Clock
This script displays a clock on your website.
To create a clock, perform the following steps:
1.
2.
3.
4.
5.
Click Clock.
Configure the appearance of the counter, clock, or date display as desired.
Click Create HTML to generate the HTML code that displays the clock.
Copy the text that begins with <applet and ends with </applet>
Paste the text into the web page where you want the clock to appear.
Countdown
This script displays a countdown clock on your website to show visitors how much time is left
until a certain event.
To add a countdown clock, perform the following steps:
Page 181
1. Click Countdown.
2. From the Select your TimeZone menu, choose the correct zone.
o For example, if you want your website to display Eastern Standard Time (U.S.), then
select GMT-0500.
3. Choose the year, month, day, and hour of the event to which you want to count down.
4. Click Create HTML to preview the countdown clock. The HTML code that creates the countdown
clock will appear.
5. Copy the text that begins with <applet> and ends with </applet>
6. Paste the text into the HTML file where you want the clock to appear.
CGI Email
Warning:
Icon
If CGI Email is not available for your web site, contact your hosting provider.
The CGI Email script allows visitors to email comments to you.
CGI email requires a number of steps to set up, and it can be complex to configure. Click cgimail
user guide for help to set up a CGI email form. You can also view the documentation at the CGI
Email site.
FormMail Clone
The FormMail Clone script allows visitors to send email messages through a customizable form
on your website.
Warning:
Icon
If FormMail Clone is not available for your web site, contact your hosting provider.
To use FormMail Clone, perform the following steps:
1. Click FormMail Clone.
2. Copy the text that appears after The actual script is here.
3. Paste this text into the HTML file, in a <form action> tag.
To learn more about setting up FormMail, view the documentation for FormMail.
Page 182
Entropy Search
Entropy Search allows visitors to find information on your website quickly.
To use Entropy Search, perform the following steps:
1. Click Entropy Search.
2. Copy the text that begins with <form> and ends with </form>.
3. Click Rebuild Search Index.

Warning:
Icon
o
This sets up an internal list of your websites contents to allow searches. Click this link
whenever you add new pages to your website.
o The larger your website, the longer the Rebuild Search Index link will take.
4. Paste the text into the HTML file where you want the search box to appear.
Note:
Icon
Entropy Search only searches static files. It does not work with dynamic files, such as PHPgenerated files.
If you are comfortable with HTML and wish to change the appearance of the results web page
that visitors will see, perform the following steps:
1. Click Edit Search Results Template.
2. Customize the background color, add a background image, and edit the title of the results web
page as desired.
3. Click Save.
Entropy Banners
Entropy Banners allow you to manage a rotation schedule for banner advertisements. This is
useful if you would like your visitors to see different logos or advertisements each time that they
access your site.
To set up Entropy Banners, you must add banners to your site's banner pool, configure the
display schedule, and add the banner code to a web page.
Page 183
How to upload banners
To add banners to your site's banner pool, perform the following steps:
1. Click Entropy Banners.
2. Click Add Banners.
3. Click Choose File and select the image to upload from your computer.
o Repeat this process for each banner that you wish to add. You may upload a maximum
of 12 images at a time.
4. If you wish to replace an existing banner, select the Overwrite existing files checkbox.
o This will replace older ads with newer ones, as long as they have the same filename.
5. Click Upload.
How to control a banner's schedule
To control a banner's display schedule, perform the following steps:

1. In the Entropy Banners interface, click Modify Rotation.
2. Select High, Medium, or Low priority for the banner, which determines how often the banner
will appear on your site.
3. Click Save.
4. In the Linked to text box, enter the URL where visitors will go when they click the banner.
5. Click Save.
To delete a banner, click Delete.

How to add rotating banners to a web age
To add rotating banners to a web page, perform the following steps:

1. Copy the text that begins with .
2. Paste the text into the HTML file where you want the banner to appear.
Warning:
Icon
The file must use the .shtm or .shtml file extension.
Site Software The Site Software interface allows you to add useful software to your
website. Your web host controls which software is available.
Site Software
Page 184

(Home >> Software/Services >> Site Software)
Overview
How to manage cPAddons
Overview
The Site Software interface allows you to add, manage, upgrade, and remove cPAddons (cPanel
Addons), which are software packages that add useful functions to your website. cPAddons are
available to help you run blogs, bulletin boards, ecommerce, guest books, and other services.
Note
Icon
Your hosting provider controls which cPAddons are available. If you need an additional
cPAddon for your website, contact your hosting provider.
How to manage cPAddons

To toggle whether the system will notify you when updates for your cPAddons are available,
click here.
To inspect a cPAddon, click the name of the cPAddon. A new window will appear that displays
the following information:
A link to the creator's website, where you can learn more about the cPAddon.
License terms
Configuration information, such as an admin username, admin password, installation location,
and other settings.
Additional links are available to install, upgrade, and uninstall the cPAddon.
Warning:
Icon
Page 185
Most cPAddons were created by third-party software developers, not cPanel. For assistance with
a cPAddon, contact your hosting provider or the software developer.
How to use Wordpress with cPanel
Perl Modules The Perl Modules interface allows you to add and manage Perl modules.
Perl Modules

(Home >> Software/Services >> Perl Modules)
Overview
View available Perl modules
Search available Perl modules
Install a Perl modules
The Installed Perl Module(s) table
System modules
Overview
Perl modules are software components that are written in the Perl language. The Perl Modules
interface allows you to search for and add Perl modules from the CPAN repository to your
website.
View available Perl modules

To view all of the Perl modules that are available for you to install, perform the following steps:
1. Click Show Available Perl Module(s).
2. Locate the module that you wish to install and click Install.
Page 186
Search available Perl modules

If you do not know the name of the Perl module that you wish to install, you can search for it
based on a topic or keyword.
1. Enter the keyword in the Search box and click Go.
2. Locate the Perl module that you wish to install and click Install.
Install a Perl modules

If you know the name of the Perl module that you wish to install, perform the following steps:
1. Enter it in the text box under Install a Perl Module.
2. Click Install Now.
The Installed Perl Module(s) table

The Installed Perl Modules table allows you to manage the modules that you have installed. The
table shows the module name, version, and what you can do with it.
If you believe that a Perl module is out-of-date, cPanel can update it for you. To update a Perl
module, click Update.
If you believe that an installed Perl module has become corrupted or lost, you can reinstall it. To
do this, click Reinstall.
To uninstall a Perl module, click Uninstall.
To view the Perl module creators documentation, click Show Docs.
System modules
cPanel includes specific pre-installed Perl modules. To see a list pre-installed Perl modules, click
Show System Installed Modules.
Click Show Docs to view the documentation for an installed module.
PHP PEAR Packages The PHP PEAR Packages interface allows you to add and
manage PHP packages.
PHP PEAR Packages

Page 187

(Home >> Software/Services >> PHP PEAR Packages)
Overview
Install a PEAR package
o View available PEAR packages
o Search for a PEAR package
o Enter the name of a PEAR package
Installed PHP modules
System modules
Overview
PHP PEAR packages are software components that are written in the PHP language. The PHP
PEAR Packages interface allows you to search for and add PEAR packages to your website, or
view all of your website's available PHP packages.
Install a PEAR package

View available PEAR packages
To view all of the PEAR packages that are available for you to install for your website, perform
the following steps:
1. Click Show Available PHP Extension(s) and Application(s).
2. Click Install for the PEAR package that you wish to install.
Search for a PEAR package
If you do not know the name of the PEAR package that you wish to install, you can search for a
PEAR package based on a topic or keyword.
1. Enter the keyword in the Search text box and click Go.
2. Click Install for the PEAR package that you wish to install.
Enter the name of a PEAR package
If you already know the name of the PEAR package that you wish to install, perform the
following steps:
Page 188
1. Enter the name of the PEAR package in the text box under Install a PHP Extensions and
Applications Package.
Installed PHP modules

The Installed PHP Extension(s) and Application(s) table allows you to manage the PEAR
packages that you have already installed. The table shows the module name, version, and the
actions you can perform for each package.
To update a PEAR package, click Update.

To reinstall a PEAR package, click Reinstall.
To uninstall a PEAR package, click Uninstall.
To view the PEAR package's documentation, click Show Docs.
System modules
cPanel includes specific pre-installed PEAR packages. To see a list of pre-installed PEAR
packages, click Show System Installed Modules.
Warning:
Icon
You cannot remove cPanel's system modules.
PHP Configuration The PHP Configuration interface allows you to view specific
information about your server's PHP configuration.
PHP Configuration

(Home >> Software/Services >> PHP Configuration)
Overview
PHP directives
Page 189
Select a PHP version
Overview
If you encounter problems with the way that your server handles PHP packages, you may wish to
view information about the PHP configuration. Use the PHP Configuration interface to display
some of the most commonly referenced configuration options.
Note:
Icon
You cannot change your server's PHP configuration with the PHP Configuration interface. To
change your server's PHP configuration, contact your web host.
PHP directives
The following table contains a brief description of each directive in the PHP Configuration
interface.
Directive
Description
asp_tags
Specifies whether your server allows PHP code to include the <% and %> tags
instead of the standard <?php and ?> tags. If you turn this option off, a PHP
script with ASP tags will not work properly.
file_uploads
Specifies whether your server allows PHP scripts to receive files via HTTP.
include_path
Specifies a list of directories in which

the require, include, fopen(), file(), readfile(),
and file_get_contents() functions look for files.
The number of seconds that your web server allows a PHP script to run before
max_execution_time it terminates the script. This limit ensures that poorly written scripts will not
slow down your server.
max_input_time
The number of seconds that your web server allows a PHP script to process
information input to it, such as file uploads. This limit ensures that overloaded
scripts will not slow down your server.
memory_limit
The maximum number of bytes of memory that a PHP script can use. This limit
ensures that poorly written scripts will not occupy your server's memory.
When this value is set to -1, there is no memory limit.
Page 190
Directive
Description
If a PHP script requires that you set this value to On, your site could
become insecure.
Warnings:
register_globals
Icon
Set this directive to Off.

This feature has been DEPRECATED as of PHP 5.3.0 and REMOVED as
of PHP 5.4.0.
This feature ensures that the user who runs the PHP script has
permission to perform all of the tasks for which the script is written. For
example, if the script is designed to change a file, the user will need the
correct permissions to modify the file.
safe_mode
Warning:
Icon
This feature has been DEPRECATED as of PHP 5.3.0 and REMOVED

as of PHP 5.4.0.
upload_max_filesize The maximum number of bytes that an uploaded file can contain.
When a visitor accesses your website, the web server issues a unique
user ID. The web server uses the user ID to store information about the
user's session, or time spent on your website. The
session.save_path directive describes where that information is
stored. PHP allows you to make web content specific to a given visitor
and session.
Notes:
session.save_path
Icon
If the Value column contains a number, it refers to the number of

directories in which the web server will store the information. If your
site has a lot of traffic, it is easier for the server to save and retrieve
the information if the web server distributes the session data among
several folders.
The Value column also includes the name of the directory that
contains subdirectories of session information.
Page 191
Select a PHP version

If your web host allows you to select the version of PHP that your website will use, select it in
this interface.
To select a PHP version, perform the following steps:
1. From the menu, select the version of PHP you wish to use. You may select System Default to use
the version that your web host has chosen.
2. Click Update to apply the selected version.
Optimize Website The Optimize Website interface automatically compresses content

on your website when visitors request that content.
Optimize Website

(Home >> Software/Services >> Optimize Website)
Overview
How to manage compression
Overview
This feature allows you to automatically compress specified types of content when visitors
access that content.
Note:
Icon
Your system administrator must enable mod_deflate for the Optimize Website interface to
appear in cPanel.
Page 192
How to manage compression

To disable compression of your website's content, perform the following steps:
1. Select Disabled.
2. Click Update Settings.
To compress all of your website's content, perform the following steps:

1. Select Compress all content.
To specify a list of types of content to compress, perform the following steps:

1. Select the Compress the specified MIME types option.
2. In the MIME types text box, enter the types of content that you wish to compress.
o For more information, view Wikipedia's list of Internet media types.
Note:
Icon
Image file formats are already compressed. Do not include any image file formats in the list.
For more information about the software module that handles website content compression, you
will need to know the version of the Apache web server software that your server runs. You can
find this information on the main cPanel Home interface in the Stats sidebar.
Apache 2.0 web server documentation for mod_deflate.

Note
Icon
cPanel saves your settings to a .htaccess file in your home directory. You can customize these
settings with the Apache FileMatch directive.
Important:
Page 193
Icon
Your system administrator must enable Apache's mod_deflate module for the Optimize
Website interface to appear in the cPanel interface.
Ruby on Rails The Ruby on Rails interface allows you to create and deploy a Ruby on
Rails application.
Ruby on Rails

(Home >> Software/Services >> Ruby on Rails)
Overview
How to create a Ruby on Rails application
How to create a Rewrite
o Additional applications and Rewrites
Note for resellers and web hosts
Overview
You can create and deploy a Ruby on Rails application through the cPanel interface.
Notes:
Icon
Ask your hosting provider whether they allow Ruby on Rails applications on the server.
Read the Ruby on Rails documentation before you deploy a Ruby on Rails application.
How to create a Ruby on Rails application

After you confirm that your server has a functional and accessible version of Ruby, you can
create and deploy a Ruby on Rails environment.
Because Ruby on Rails runs on its own server, it requires the following steps to set up the
environment:
Page 194
1. Enter your application's name in the App Name text box.

2. If you want the application to load when the server boots, select the Load on Boot?
checkbox.
3. Enter the application path in the Application Path text box.
Note:
Icon
If you set an application path in your public_html/ directory, anyone on the web can
view your source code and configuration files.
4. In the Environment menu, select the type of Ruby on Rails environment that you wish to run.
5. Click Create.
You can perform the following actions on applications in the Ruby on Rails Applications table:
To redirect to an application's Rails server, click URL to the right of the appropriate application
name.
To run an application, click Run to the right of the appropriate application name.
To stop an application, click Stop to the right of the appropriate application name.
To load an application when the server boots, select the Load on Boot? checkbox to the right of
the appropriate application name.
To toggle an application between a production or development environment, select or deselect
the Production checkbox to the right of the appropriate application name.
To delete an application, click X to the right of the appropriate application name.
How to create a Rewrite

Because Ruby on Rails uses its own server and does not respond on the standard HTTP port
number 80, you must specify the port where site visitors can access your Ruby on Rails
application (for example, example.com:12001).
Warnings:
Icon
Ruby application port numbers increment automatically with every new application. If you are
on a shared server, the system will assign the next available port number to your application.
Your first application will not necessarily run on port 12001.
To configure Ruby to respond without the need for visitors to specify a port number, create a
rewrite.
To configure a rewrite, perform the following steps:
Page 195
1. In the Create A Rewrite table, click Create Rewrite for the appropriate application
2. From the menu, select the domain, subdomain, or addon domain on which you wish to run your
Ruby application.
o If you wish to run the application from a new page within your domain, enter the page
name that you wish to use in the available text box.
3. Click Save.
You can perform the following actions in the Current Rewrites table:
To change an application path name, enter the path name in the text box to the right of the
appropriate application name.
To save an application rewrite, click Save to the right of the appropriate application name.
To delete an application rewrite, click Delete to the right of the appropriate application name.
Click Yes to confirm.
Additional applications and Rewrites
If you wish to run multiple Ruby applications, you must configure additional ports to respond
with Ruby on Rails and, if necessary, additional rewrites to disguise the port change. To do so,
add an application as described in the How to create a Ruby on Rails application section above.
The new application will respond on the next available port number (for example, if your first
application runs on port 12001, the second may run on port 12002 or higher).
Warning:
Icon
Ruby application port numbers increment automatically with every new application. If you are
on a shared server, the system will assign the next available port number to your application.
Also, your applications' port numbers may not be consecutive.
To configure an additional rewrite, follow the steps outlined in the How to create a Rewrite
section above. You will need to use a new domain, addon domain, subdomain, or page (for
example, example.com/RubyApplication) for the rewrite.
Note
Icon
You cannot configure two Ruby applications to respond on the same domain, subdomain, addon
domain, or page.
Note for resellers and web hosts

You can limit the number of Rails applications that your customers can install in WHM's Modify
an Account interface (Home >> Account Functions >> Modify An Account).
Page 196
1. Click the domain name that you wish to limit.

2. In the Max Mongrel instances (Ruby on Rails) text box, enter the maximum number of Rails
applications that you wish to allow your customers to install.
3. Click Save.
Important:
Icon
You mus t install Ruby on Rails on your server for the Ruby on Rails interface to appear
in the cPanel interface
RubyGems The RubyGems interface allows you to find, install, or distribute Ruby
programs and libraries that are in the self-contained "gem" format.
RubyGems

(Home >> Software/Services >> RubyGems)
Overview
How to find an available RubyGem
How to install a RubyGem
Overview
RubyGems is a package manager for the Ruby programming language. It provides a selfcontained format to distribute Ruby programs and libraries.
For more information on RubyGems, read the RubyGems documentation.
How to find an available RubyGem

To find an available RubyGem, perform one of the following actions:
In the Search text box, enter name of the RubyGem that you wish to install and click Go.
Page 197
Click Show Available Modules.
A new window that appears, click Install to install a RubyGem or click Show Docs to view
documentation before you install it.
To find a system RubyGem, click Show System Modules.
How to install a RubyGem

To install a RubyGem, perform the following steps:
1. Enter the RubyGem name in the Install a Module text box.
The system will add the RubyGem to the Installed Modules table.
To use a RubyGem, copy and and paste the code under the Use Your Modules heading into your
script. This will add the correct directory to the include path.
Advanced
(Home >> Advanced)
The following documents describe the features in the cPanel interface's Advanced section.
Apache Handlers This interface allows you to add and manage Apache handlers. Apache
handlers control how your sites Apache web server software manages certain file types and file
extensions.
Apache Handlers
Page 198
(Home >> Advanced >> Apache Handlers)
Overview
Add an Apache Handler
Remove a Handler
Overview
Apache handlers control how your sites Apache web server software manages certain file types and
file extensions. Apache can handle CGI scripts and server-parsed files. The file extensions for these
files include .cgi, .pl, .plx, .ppl, .perl, and .shtml.
You can configure Apache to use an existing handler to handle a new file type. To do this, manually
add the handler and extension to the Apache Handlers interface. For example, to instruct the server
to treat files with the extension .example as CGI files, enter cgiscript under Handler and .example under Extension(s).
Add an Apache Handler

To add an Apache handler, perform the following steps:
1. Enter the handler name in the Handler text box. cPanel includes the following built-in handlers:
default-handler Sends the file and uses Apaches default handler for static content.
send-as-is Sends the file with HTTP headers intact.
cgi-script Handles the file as a CGI script.
imap-file Parses the file as an imagemap rule file.
For more information, see Apaches documentation.
server-info Retrieves the servers configuration information.
server-parsed Parses the file for server-side includes.
server-status Retrieves the servers status report.
type-map Parses the file as a type map file.
For more information, see Apaches documentation.
2. Enter the file extension in the Extension(s) text box.
You may enter more than one extension at a time.
Separate each entry with a space.
A file extension consists of the letters after the dot (.) in a file name. For
example, filename.fileextension.
3. Click Add.
Note:
Icon
This interface does not allow you to create custom Apache handlers.
Page 199
Remove a Handler
To remove an existing user-defined handler, perform the following steps:
1. Click the X button under the Remove heading for the appropriate handler in the User Defined
Apache Handlers table.
2. Click Yes to confirm that you wish to remove the handler.
Note
Icon
You cannot remove the file extensions that Apache automatically handles from the System Apache
Handlers table.
API Shell This feature allows you to run cPanel API function calls interactively within the interface.
API Shell for cPanel

(cPanel >> Advanced >> API Shell)
Overview
Enable the cPanel API Shell
Run a cPanel API function
API call results
Overview
This feature allows you to run cPanel API function calls interactively within the interface.
Warning:
Icon
This feature uses live data from your server. API function calls may change or delete data on your
server, which can cause your server to fail.
Read the documentation for a function call thoroughly before you use it in the API Shell, a script, or
through any other method.
Page 200
If you wish to see an example of the output from a specific function call that uses test data, read
the Example section for that function call in our cPanel API documentation.
Enable the cPanel API Shell

If you wish to use this feature and your system administrators have not enabled it for you, ask them
to perform the following steps in WHM:
1. Select On for the cPanel & WHM API Shell (for developers) setting in the System tab of
WHM's Tweak Settings interface (Home >> Server Configuration >> Tweak Settings).
2. Grant the API Shell feature to the desired users in WHM's Feature Manager interface (Home >>
Packages >> Feature Manager).
Run a cPanel API function

To run a cPanel API function, perform the following steps:
1. Select the API that you wish to use.
Note
Icon
2.
3.
4.
a.
b.
c.
d.
To learn more about each function, read our UAPI Functions or API Version 2
Functions documentation.
Only cPanel API version 2 and UAPI are available.
Select the API call that you wish to test from the menu.
Enter the keys and values that you wish to test.
If you need to enter more keys and values, click Add.
If you wish to filter, sort, or paginate the results, click Show Sort/Filter/Paginate Options.
To select the first record to show from the results, select the number from the Index (0-based) of first
result to show menu.
To limit the number of results to display, select the maximum number of results that you wish to
display in the Maximum # of results to show menu.
To filter the results, click Add in the Filters section of the interface.
You can specify the field by which you wish to filter the results, the conditions, and the Term to apply
to the conditions.
To use more than one filter, click Add for each additional filter that you wish to specify.
To sort the results, click Add in the Sorts section of the interface.
You can specify the field by which you wish to sort the results, the conditions, and whether you wish
to reverse the sort order.
To use more than one sort method, click Add for each additional sort method that you wish to
specify.
Page 201
5. Click Submit
API call results

The results will appear in the API call response section of the interface.
You can view the results in Table view, Tree view, or the Raw response.
Note:
Icon
The Raw response separates the API call's response from the HTTP headers.
Cron Jobs cPanel provides two interfaces that allow you to edit cron jobs. Cron jobs are
scheduled tasks that take place at predefined times or intervals on the server.
Cron Jobs
(Home >> Advanced >> Cron Jobs)
o
o
Overview
Add a cron email
Add a cron job
View existing cron jobs
Edit a cron job
Delete a cron job
Overview
Cron jobs are scheduled tasks that take place at predefined times or intervals on the server. Often, a
cron job is a series of simple tasks that the server executes from a script file.
Note:
Icon
Be careful when you schedule cron jobs. If you set them to run too often, they may slow down your
server.
Page 202
Add a cron email

The Cron Email section of this interface allows you to specify an email address at which you wish to
receive notifications whenever your cron jobs run. To specify an email address, perform the following
steps:
1. In the email text box, enter the email address at which you wish to receive the notifications.
2. Click Update Email.
Add a cron job

To set up a cron job, perform the following steps:
1. Configure the interval at which you wish to run the cron job.
Common Settings This menu allows you to select a commonly used interval. You will not need to
specify settings for the minute, hour, day, and month.
Minute Use this menu to select the number of minutes between each time the cron job runs, or
the minute of each hour on which you wish to run the cron job.
Hour Use this menu to select the number of hours between each time the cron job runs, or the
hour of each day on which you wish to run the cron job.
Day Use this menu to select the number of days between each time the cron job runs, or the day
of the month on which you wish to run the cron job.
Month Use this menu to select the number of months between each time the cron job runs, or the
month of the year in which you wish to run the cron job.
Weekday Use this menu to select the days of the week on which you wish to run the cron job.
2. In the Command text box, enter the command that you wish the system to run.
Note
Icon
If you do not wish to receive an email to notify you of a specific cron job, add the following line to the
command:
>/dev/null 2>&1
3. Click Add New Cron Job.
View existing cron jobs

The Current Cron Jobs table displays the cron jobs that you have already set up on the server.
You can use this table to edit or delete a cron job.
Page 203
Edit a cron job

To edit a cron job, perform the following steps:
1.
2.
3.
4.
Locate the cron job that you wish to edit.

Click Edit.
Edit the settings that you wish to change.
Click Edit Line.
Delete a cron job

To delete a cron job, perform the following steps:
1. Locate the cron job that you wish to delete.
2. Click Delete.
3. To confirm that you wish to delete the cron job, click Delete again.
Error Pages This interface allows you to customize the appearance of your error pages. An error
page informs a visitor who tries to access your site whether there is a problem.
Error Pages
(Home >> Advanced >> Error pages)
Overview
Edit an error page
Overview
Error pages inform visitors if there is a problem when they access your site. Each problem has its
own code (for example, 404) and error page.
The web server automatically provides basic error pages. In addition to this, cPanel allows you to
define custom error pages for any HTTP code.
Page 204
Edit an error page

To customize an error page, perform the following steps:
1. Click the error code for the page you wish to edit.
If you do not see the error code for the page you wish to edit, click the Show All HTTP Error Status
Codes tab.
2. Enter a message in the text box.
You can select certain HTML tags to add to a custom error page. These tags will display information
about the visitor who accessed your site on the error page.
You can key in the HTML code to further customize your error pages.
3. Click Save.
FrontPage Extensions This feature allows you to enable or disable FrontPage extensions.
FrontPage extensions allow you to publish web pages directly from the Microsoft FrontPage
application, which eliminates the need to use FTP.
FrontPage Extensions
Created by Sync User, last modified on May 23, 2014
(Home >> Advanced >> FrontPage Extensions)
Overview
.htaccess files
Overview
FrontPage extensions allow web pages to publish directly from the Microsoft FrontPage
application, which eliminates the need to use FTP.
Warning:
Icon
The installation of Frontpage extensions will delete any .htaccess files that your web area
contains. This means that you will need to reconfigure any directory or web page that requires
authentication (a username and password) after you install the extensions.
Note:
If your hosting provider has removed FrontPage support, you will not see this feature in the cPanel
interface.
Page 205
.htaccess files
.htaccess files are an integral part of any basic authentication process. The file lives within a
directory on the server and is used to enact the authentication process when the directory is
accessed. The .htaccess file is then checked against a file that contains an encrypted instance of
the valid password for the directory.
.htaccess files also contain information about how the contents of the directory will display, as well
as information about how long visitors browsers will cache your site (save it in memory).
Note:
Icon
If your hosting provider has removed FrontPage support, you will not see this feature in the cPanel
interface.
Image Manager cPanel's Image Manager feature includes three tools to help you manage the
images you use on your website.
Image Manager
(Home >> Advanced >> Image Manager)
Overview
Thumbnailer
Image Scaler
Convert Image Format
Overview
The Image Manager allows you to modify and manage images saved to your account. This feature
includes the following tools:
Thumbnailer Create thumbnails from images in a directory and store them in a folder
called thumbnails.
Image ScalerResize individual images.
Page 206
Convert Image FormatConvert one type of image file to another. Change the file type of all images
in a directory. For example, change .jpg files to .png files.
Thumbnailer
The Thumbnailer creates smaller versions of images called "thumbnails." Create thumbnails to save
bandwidth on a photo page, where you can view smaller previews of your images before you access
the larger ones. To convert a directory of images to thumbnails, perform the following steps:
1. Click Thumbnailer.
2. Select the directory you wish to thumbnail. Click
name to select it.
Note:
to navigate the file system. Click the folder
Icon
You must select an entire folder to thumbnail. The Thumbnailer cannot convert individual images.
3. In the Scale Percent text boxes, enter the percentage you wish to shrink your images.
4. Select the Keep Aspect Ratio checkbox to prevent the distortion of the image because the height
and width will remain proportional.
Click Reset Dimensions to return the Scale Percent values to the default.
5. Click Thumbnail Images.
Thumbnailer will create a new subdirectory, within the selected folder, named thumbnails. The
thumbnail images are prefixed tn_, for example, tn_example.png
Click the Your images have been thumbnailed into link to open the thumbnails directory in the File
Manager.
Image Scaler
Resize individual images with the Image Scaler. The Image Scaler allows you to enter percentages
to scale the image bigger or smaller. To resize an image, perform the following steps:
1. Click Image Scaler.
2. Select the image you wish to resize. Click
to navigate the file system. Click the file name to
select it.
3. To set the new image size, do one of the following two steps:
Use the New Dimensions text boxes to define, in pixels, how the image should be resized.
Use the Percent text boxes to define the percentage you wish to resize your images.
4. Select the Keep Aspect Ratio checkbox to prevent the distortion of the image because the height
and width will remain proportional.
Page 207
Click Reset Dimensions to return the Scale Percent values to the default.
5. Select the Retain a copy of the old image as checkbox to store a copy of the original image. Specify
the file path where you wish to save the copy in the text box.
6. Click Scale Image.
7. Click the Your image link to view the rescaled image.
Convert Image Format

Convert any of the supported file types from one type to another with this tool. To change an image's
file type, perform the following steps:
1. Click Image Scaler.
2. Select the directory or file you to convert. Click
to navigate the file system. Click the folder name
to select it. Click the file name to select it.
3. From the menu, select the file format to which you want to convert your image or images. You may
select any of the following file formats:
a.
.PNG
.JPG
.GIF
.BMP
4. Click Convert.
After you complete the conversion, the new file will reside in the same directory as the original by
default.
Index Manager This interface allows you to configure how a directory index will appear to users
who access it.
Index Manager
(Home >> Advanced >> Index Manager)
Overview
Modify indexing
Page 208
Overview
When you access a directory (rather than a page) on your site, a visitor will typically see the index
page for that directory. If no index page exists, the browser will display a list (or index) of the files in
that directory.
Modify indexing
You can use the Index Manager to define how a specific directory index will appear to those who
access it. You can also turn off indexing, if you do not want a directorys contents to be visible.
1.
2.
3.
4.
Select the directory in which you wish to navigate your website's contents.
To navigate the Index Manager, click the folder icon next to the directory name.
Click the name of the directory for which you want to change the indexing style.
Select one of the following options:
Standard Indexing: Contents appear only as filenames.
Fancy Indexing: Information about the files, such as the size and time last modified, appear.
Default System Setting: The default defined by your web host will be used.
No Indexing: The contents of the directory are not listed. Visitors will see a message that states that
the contents are forbidden.
5. Click Save.
MIME Types This feature allows you to create and manage MIME types. MIME types relay
information to the browser about how to handle file extensions.
MIME Types
(Home >> Advanced >> MIME Types)
Overview
Add a MIME type
Delete a user-defined MIME type
More about MIME types
Page 209
Overview
MIME types relay information to the browser about how to handle file extensions. You can add MIME
types to enable visitors browsers to handle new technologies as they come out. To add new MIME
types to your web server, define a name, directory, and file extension that correspond to the MIME
type..
Add a MIME type

To add a MIME type, perform the following steps:
1. Enter the name of the file types handler in the Mime Type text box.
For example, application/cgi would be the handler for the .cgi extension.
2. Enter the file extension in the Extension(s) text box.
A file extension is made of the letters after the dot (.) in a file name. For
example, filename.fileextension.
3. Click Add.
Delete a user-defined MIME type

To delete a MIME type, perform the following steps:
1. Click the X icon under the Remove heading.
2. Click Yes to confirm that you wish to remove the MIME type.
Note:
Icon
You cannot delete system MIME types.
More about MIME types

A list of MIME types can be found at http://www.webmaster-toolkit.com/mime-types.shtml. You may
also want to use your preferred search engine to research the MIME type you would like to add.
Network Tools This area of cPanels interface contains tools to help you retrieve network
information.
Page 210
Network Tools
Created by Sync User, last modified on May 30, 2014
(Home >> Advanced >> Network Tools)
Overview
Domain Lookup
Trace Route
Overview
The Network Tools interface contains tools to help you retrieve network information. For example,
you can look up an IP address or trace the route from your computer to the computer that hosts your
website (your web server).
Domain Lookup
The Domain Lookup tool executes a basic command to resolve an IP address from a specified
domain name. This query will also return general DNS information about the server.
To look up a domain, perform the following steps:
1. Enter the domain that you wish to look up in the Enter a domain to lookup text box. For
example, cpanel.net.
2. Click Lookup.
The domains mail servers and the IP address for that domain will display. You can also view the
domains DNS information under the Zone Information heading.
Trace Route
The Trace Route function traces the route that your computer takes to access your website. This
function displays how many servers through which your data passes before it reaches your website.
This information also includes the amount of time that your computer requires to reach the server.
To trace the route to your server, click Trace.
The pathways that your computer took to reach your server will display. You can use this information
to find problem servers within your path.
Note:
Page 211
Icon
You may not have access to this function. Contact your system administrator for more information
about how to use the Trace Route function.
The Password Generator

(Home >> Change Password >> The Password Generator)
Overview
Change Password
Overview
The Password Generator is a helpful tool in cPanel that generates secure passwords which are
difficult for malicious users to guess. You can use the Password Generator anywhere that the button
is available.
The Password Generator
When you click the Password Generator button, a new window will appear that contains a generated
password in a text box. Click Generate Password as many times as you wish until you are satisfied
with the password.
Page 212
Change Password
To set the security requirements of the new password, perform the following steps:
1.
2.
3.
4.
5.
Click Advanced Options.

Enter the desired length of the password in the Length text box.
Select whether to include uppercase letters, lowercase letters, numbers, or symbols.
Copy the password in a safe place and select the checkbox at the bottom of the window.
Click Use Password to use the password you have just generated.
To reject the password and close the Password Generator window, click Cancel.
The Password Generator with advanced options
Page 213

CPanel User Documentation

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

CPanel User Documentation

Caricato da

Copyright:

Formati disponibili

cPanel User Documentation

This documentation describes the features of the cPanel interface.