Valid for versions 108 through the latest version
Last modified: October 28, 2022
Overview
This interface allows you to configure many cPanel & WHM settings. Tabs at the top of the interface categorize the settings, and the All tab displays all of the settings.
-
These settings exist in the
/var/cpanel/cpanel.config
file. However, we recommend that system administrators use this interface to make changes. -
Some settings may not appear if your server does not use the Standard server profile. For more information, read our How to Use Server Profiles documentation.
-
Click the question mark next to each settings description to learn more about the setting.
-
The interface displays a warning icon () next to any setting for which you have not specified a value. This includes settings that are new, settings that WHM has set to a default value, and settings that your server selected dynamically.
Compression
The Compression section includes the following settings:
Setting | Description | Values | Default |
---|---|---|---|
gzip compression level | This setting allows you to set the gzip compression level for pigz, which is a gzip-compatible program that uses multiple CPU cores simultaneously. Higher settings provide greater compression, but compress more slowly. |
|
6 |
Number of pigz processes | This setting allows you to set how many independent pigz processes the system uses to perform gzip compression. For the best performance, we recommend that you set this value to match the number of processor cores that are available on your server. |
|
This setting defaults to the number of processor cores on your server. |
Number of kilobyte chunks per compression work unit | This setting allows you to control the size, in 1024 -byte chunks, of compression work units that the system distributes to each pigz process. |
|
4096 |
cPAddons Site Software
The cPAddons Site Software section includes the following settings:
Setting | Description | Values | Default |
---|---|---|---|
cPAddons Site Software admin email | This setting specifies a contact email address that receives cPAddon moderation requests. The system also notifies resellers if they choose to configure their contact email address in the cPanel interface.
Note:
We have deprecated the moderation feature and will remove it in the future. You cannot enable moderation for any cPAddons. Any cPAddons that currently use moderation will continue to function, but if you disable this setting you cannot reactivate moderation.
|
To specify the cPAddon administrators email address, enter the email address that you wish to use in the text box. | None |
cPAddons Site Software source automatic updates | This setting specifies whether you wish for cPanel & WHM to automatically update all of the cPAddons source files. |
|
On |
Max cPAddons Site Software installation requests | This setting specifies the maximum number of moderation requests that a single user can make at one time. | To specify a new value, enter the number of requests that you wish to allow in the text box.
|
99 |
Max cPAddons Site Software installation requests per addon | This setting specifies the maximum number of moderation requests per cPAddon that a single user can make at one time. | To specify a new value, enter the number of requests that you wish to allow per cPAddon in the text box.
|
99 |
cPAddons Site Software moderation notification | This setting allows you to select whether the cPAddons administrator receives notifications about pending moderation requests. |
|
Off |
Allow cPAddons Site Software installations from non-cPanel sources | This setting allows you to install third-party scripts on your server. |
|
On |
Allow cPAddons Site Software installations from modified sources | This setting allows users to install previously-altered cPAddons. You may wish to enable this item when you test custom cPaddons. |
|
Off |
Notify reseller of cPAddons Site Software installations | This setting notifies resellers whenever their users must update their cPAddons. |
|
On |
Notify root of cPAddons Site Software installations | This setting notifies the cPAddons Site Software administrator whenever their users must update their cPAddons. |
|
On |
Notify cPanel users when they need to update their cPAddons Site Software installations | This setting notifies cPanel users whenever they must update their cPAddons. |
|
Allow users to choose (default) |
Development
The Development section includes the following settings:
Setting | Description | Values | Default |
---|---|---|---|
Standardized Hooks - Debug Mode | The Standardized Hooks systems debug mode helps to troubleshoot hook issues. For more information, read our Guide to Standardized Hooks - Debug Mode documentation.
Important:
If you enable this setting, it also enables debug mode in the cPanel interface. This severely impacts the loading and performance of the cPanel interface. We recommend that you disable this setting when you do not need it.
|
|
Debug mode is off. |
User Interface - Debug Mode | This setting changes the way the system generates user interfaces. For example, it disables optimizations such as minifications and cache-busting. |
|
Debug mode is off. |
Display
The Display section includes the following settings:
Setting | Description | Values | Default |
---|---|---|---|
Default login theme | This setting allows you to select the default login theme for cPanel users. | Select a login theme. | cpanel |
Display File Usage information in the cPanel stats bar (inode count) | This setting allows you to display the number of files and directories (inodes) that a cPanel account uses. The Statistics section of cPanels Home interface displays this information in the File Usage section. |
|
Off |
Number of accounts per page to display in List Accounts. | This setting allows you to specify the number of accounts to display per page in WHMs List Accounts interface (WHM » Home » Account Information » List Accounts). |
|
30 (default) |
Display Upgrade Opportunities column in List Accounts. | This setting allows you to display the Upgrade Opportunities column in WHMs List Accounts interface (WHM » Home » Account Information » List Accounts). |
|
Off |
Domains
The Domains section includes the following settings:
Setting | Description | Values | Default |
---|---|---|---|
Allow users to park subdomains of the servers hostname. | This setting allows users to park subdomains on your servers main domain. For example, for a user creating the subdomain.server.example.com alias on the server.example.com FQDN, On would cause the action to succeed. |
|
Off |
Allow cPanel users to create subdomains across accounts | This setting allows a cPanel user to create an addon domain or subdomain on a domain that another user owns. For example, if a user owns the example.com domain, another user could create the store.example.com subdomain. |
|
Off |
Allow WHM users to create subdomains across accounts | This setting allows WHM users to create an addon domain or subdomain for a domain that another user owns. For example, if a cPanel user owns the example.com domain, a WHM user could add a DNS zone for the store.example.com subdomain. |
|
Off |
Allow Remote Domains | This setting allows the creation of parked domains (aliases) and addon domains that resolve to other servers. |
|
Off |
Allow resellers to create accounts with subdomains of the servers hostname. | This setting allows resellers to create accounts with subdomains on your servers main domain. For example, if your hostname is server.example.com , enable this setting to redirect user.server.example.com visitors to the resellers website. |
|
Off |
Allow unregistered domains | This setting lets users add domains they didnt register with a domain name registrar. |
|
Off |
Automatically add A entries for registered nameservers when creating a new zone | This setting controls whether to add A entries automatically for a domains nameservers when a user creates a domain. |
|
On |
Replace service SSL certificates that do not match the local hostname | This setting changes how the /usr/local/cpanel/scripts/checkallsslcerts script functions. If you enable this, the system replaces SSL certificates that dont match the servers hostname. The system replaces them with a cPanel-signed certificate. This also applies to wildcard certificates. |
|
On |
Prevent cPanel users from creating specific domains | This setting prevents creating domains whose names appear in the /var/cpanel/commondomains file. If you enable this, cPanel users cant create any domains (addon or parked) that exist in the /var/cpanel/commondomains and /usr/local/cpanel/etc/commondomains files.Note:
Do not edit the
/usr/local/cpanel/etc/commondomains file directly. If you do, the system will overwrite your changes whenever cPanel & WHM updates. |
|
On |
Check zone syntax | This setting allows the system to check zone file syntax each time it saves or syncs DNS zone files. |
|
On |
Check zone owner | This setting allows the system to check a DNS zones owner whenever it saves or syncs DNS zone files. |
|
On |
Enable DKIM on domains for newly created accounts | DKIM (DomainKeys Identified Mail) verifies a messages sender and integrity. It allows an email system to prove that a message is valid, not forged, and came from the specified domain. This setting allows you to specify whether to enable DKIM for new accounts by default.
|
|
On |
Enable SPF on domains for newly created accounts | SPF (Sender Policy Framework) keeps spammers from sending email that shows your domain as the sender (spoofing). This adds addresses to a list of computers that you authorize to send mail from your domain. It verifies that your domains sent messages come from the listed sender. This reduces the amount of backscatter that you receive. This setting allows you to specify whether to enable SPF for new accounts by default.
|
|
On |
DNS request management application | This setting determines which application handles DNS management requests. |
|
dnsadmin, auto-detect SSL |
Service subdomains | This setting gives users access to cPanel & WHM through standard HTTP ports (80 and 443 ).
example.com is the domain:
|
|
On |
Thunderbird and Outlook autodiscover and autoconfig support (enables service subdomain and SRV record creation) | This setting creates the autodiscover and autoconfig service subdomains when you create a domain. It also creates autodiscover and autoconfig SRV records.
|
|
Off |
Preferred mail service to configure to use for Thunderbird and Outlook autodiscover and autoconfig support | This setting lets you choose the email transfer method to use with Thunderbird and Outlook for Autodiscover and AutoConfig support.
Note: You must enable the Thunderbird and Outlook autodiscover and autoconfig support (enables service subdomain and SRV record creation) setting to configure this setting.
|
|
imap |
Host to publish in the SRV records for Outlook autodiscover support. | The Microsoft Outlook® Autodiscover service searches DNS records. It searches for the SRV record for a domain that points to a particular Autodiscover server. This setting lets you take these actions:
Note:
|
|
cpanelemaildiscovery.cpanel.net |
Overwrite custom A records used for service subdomains | This setting removes A records that match your service subdomains.
|
|
Off |
Overwrite custom SRV records used by Outlook AutoDiscover support | This setting removes SRV records when adding or removing Outlook Autodiscover support.
Note: You must set the Thunderbird and Outlook autodiscover and autoconfig support (enables service subdomain and SRV record creation) setting to On to toggle this setting.
|
|
Off |
Service subdomain override | This setting creates cPanel, Webmail, Web Disk, and WHM subdomains that override the default service subdomains. For example, a user could direct cpanel.example.com visitors to mycontrolpanel.example.com . For more information about service subdomains, read our Service and Proxy Subdomains documentation. |
|
On |
Restrict document roots to public_html | This setting keeps users from creating addon domains and subdomains outside of their public_html directory. For example, if you enable this option and create the example.com addon domain, the system creates the /home/username/public_html/example.com directory and not the /home/username/example.com directory. |
|
On |
Always use authoritative (registered) nameservers when creating a new DNS zone. | This setting lets a new domain use authoritative nameservers. If you enable this setting, the server wont use the nameservers you set when creating the domain. |
|
Off |
Logging
The Logging section includes the following settings:
Setting | Description | Values | Default |
---|---|---|---|
dnsadmin logging level | This setting allows you to set the log level for dnsadmin requests in the /usr/local/cpanel/logs/dnsadmin_log file. A value of 0 indicates no logging. |
|
0 |
Enable verbose logging of DNS zone syncing | This setting causes your server to print DNS information to the command line interface whenever the system synchronizes a DNS zone.
Note: This setting is for testing purposes only. Do not enable this option on a production server.
|
|
Off |
Log successful logins | This setting causes your server to record successful login events for cPanel, Webmail, WHM, and DAV to their respective log files in the /usr/local/cpanel/logs/ directory. |
|
Off |
Enable cPanel API Log | This setting allows you to log successful or failed cPanel API 1, successful cPanel API 2, and successful UAPI 2 function calls. We store this log in the /usr/local/cpanel/logs/api_log file. |
|
Off |
The Mail section includes the following settings:
Setting | Description | Values | Default |
---|---|---|---|
Max hourly emails per domain | This setting specifies the maximum number of emails that each domain can send per hour. The system only enforces email send limits on remote email deliveries.
Note:
|
|
Unlimited |
Number of emails a domain may send per day before the system sends a notification. | This setting specifies the number of emails per day that a domain can send before the system sends a notification.
|
|
Unlimited |
The mailbox storage format for new accounts | This setting specifies the storage format for new accounts mailboxes. Accounts that you restore or transfer to your server will retain their original mailbox format. For more information about storage formats, read Dovecots dbox and maildir documentation. |
|
maildir |
Initial default/catch-all forwarder destination | This setting specifies the initial forwarding destination for new accounts default (catch-all) email addresses. The default address handles email that nonexistent users on your servers domains receive. Because a domain may receive a large number of spam messages for nonexistent users, if you choose to process this mail your server may use more resources. cPanel users can modify this forwarding destination in cPanels Default Address interface (cPanel » Home » Email » Default Address). |
|
System account (default) |
Mail authentication via domain owner password | This setting specifies whether to allow the use of the website owners password to access any email address that the owner created within the account. The Single Sign On system generates a temporary user to access a cPanel account and its email accounts as the account owner. This means that if you log in to any email account through the cPanel interface, you do not have to enter a password. |
|
Off |
Include mailman in disk usage calculations | This setting specifies whether cPanels disk usage calculations include Mailman mailing lists. |
|
On |
Email delivery retry time | This setting specifies the number of minutes that your mail server waits before it attempts to redeliver a message after delivery failure.
Note:
This setting does not appear if you disable the Exim service in WHMs Service Manager interface (WHM » Home » Service Configuration » Service Manager).
|
|
15 m |
Track email origin via X-Source email headers | This setting specifies whether to track the origin of messages that users send through your mail server.
Note:
This setting does not appear if you disable the Exim service in WHMs Service Manager interface (WHM » Home » Service Configuration » Service Manager).
|
|
On |
The percentage of email messages (above the accounts hourly maximum) to queue and retry for delivery. | This setting specifies whether to queue outgoing messages for later delivery after a domain reaches its limit for outgoing messages per hour. For example, with the default value of 125% , after the domain reaches its hourly limit Exim queues any additional messages, up to 125% of the Max hourly emails per domain value. After the account reaches 125% of the Max hourly emails per domain value, any additional outgoing messages will fail.
Note:
|
|
125% |
Monitor the number of unique recipients per hour to detect potential spammers. | This setting configures the system to monitor the number of emails to unique recipients that each individual email user sends. If this number exceeds the value of the Number of unique recipients per hour to trigger potential spammer notification setting, the system will send a notification.
Note: This setting does not function if you disable the Eximstats driver in WHMs Service Manager interface (WHM » Home » Service Configuration » Service Manager).
|
|
On |
Select the action for the system to take on an email account when it detects a potential spammer. | The system automatically takes this action on every email account that it detects as a potential spammer. To release or delete outgoing mail held in the queue, perform the following actions in cPanels Email Accounts interface (cPanel » Home » Email » Email Accounts):
Note:
This setting does not function if you disable the Eximstats driver in WHMs Service Manager interface (WHM » Home » Service Configuration » Service Manager).
|
|
Take no action |
Number of unique recipients per hour to trigger potential spammer notification. | This setting specifies the number of emails sent by any email account in one hour that will cause the system to send an alert notification. This setting does not count emails sent by Mailman toward the limit. It affects the Select the action for the system to take on an email account when it detects a potential spammer option.
Note:
This setting does not function if you disable the Eximstats driver in WHMs Service Manager interface (WHM » Home » Service Configuration » Service Manager).
|
|
500 |
Count mailman deliveries towards a domains Max hourly emails. | This setting allows you to specify whether to count messages to Mailman mailing lists against an accounts Max hourly emails per domain limit.
Note:
|
|
Off |
Maximum percentage of failed or deferred messages a domain may send per hour | This setting allows you to specify a maximum percentage of failed or deferred messages that your domain may send per hour. The system uses this setting in conjunction with the Number of failed or deferred messages a domain may send before protections can be triggered setting. Your server does not temporarily block outgoing mail from a domain until the domain meets both settings requirements. For more information, read our How to Prevent Spam with Mail Limiting Features documentation.
Note:
|
|
Unlimited |
Number of failed or deferred messages a domain may send before protections can be triggered | This setting specifies a number of failed or deferred messages that a domain can send before the system blocks outgoing mail. Your server temporarily blocks outgoing mail from a domain if both of the following conditions are true:
Note:
|
|
5 |
Restrict outgoing SMTP to root, exim, and mailman (FKA SMTP Tweak) | This setting redirects outgoing SMTP connections to the local mail server and allows only the root , exim , and mailman users to make direction connections. If you enable this setting, scripts and email users must use the sendmail binary to send mail and cannot use direct socket access. |
|
On |
Prevent nobody from sending mail | This setting denies the nobody user the ability to send mail to a remote address. PHP and CGI scripts generally run as the nobody user. To use a PHP or CGI script to send mail, enable the suEXEC or mod_php modules in your Apache configuration. |
|
On |
Allow users to relay mail if they use an IP address through which someone has validated an IMAP or POP3 login within the last hour (Pop-before-SMTP) | This setting allows users who authenticated against the POP3 or IMAP service in the last 30 minutes to send emails through SMTP again without the need to reauthenticate.
Note:
|
|
Off |
Add X-PopBeforeSMTP header for mail sent via POP-before-SMTP | This setting requires the mail server to append a list to the X-PopBeforeSMTP headers of all of that users outgoing messages. This list contains all of the email addresses that a user checks with POP before SMTP.
Note:
|
|
Off |
Enable BoxTrapper spam trap | This setting allows you to enable BoxTrapper, a spam prevention system that uses blacklists, whitelists, and ignore lists, and an automated response-verification system.
Note: This setting does not appear if you disable the Exim service in WHMs Service Manager interface (WHM » Home » Service Configuration » Service Manager).
|
|
On |
Enable Email Archiving support | This setting enables email archiving support. Email archiving maintains a copy of each email that your server sends or receives. The server immediately archives an email when it receives the message.
|
|
Off |
Enable Mailman mailing lists | This setting enables Mailman on your server. Mailman is third-party software that manages mailing lists.
Note: The system does not start the Mailman service until the server hosts at least one mailing list. |
|
On |
Enable Roundcube webmail | This setting enables the Roundcube webmail client. Webmail allows cPanel users to access their email accounts with an internet connection and a web browser. |
|
On |
Enable Apache SpamAssassin spam filter | This setting enables Apache SpamAssassin, a spam filtration program that scores incoming email and checks that score against a predefined limit. If the spam score exceeds this limit, the server takes the action that the domain owner specified in cPanels Spam Filters interface (cPanel » Home » Mail » Spam Filters). You can discard mail or place it in a spam folder.
Note:
|
|
On |
Enable Apache SpamAssassin Spam Box delivery for messages marked as spam (user configurable) | This setting enables Apache SpamAssassins spam box feature. The spam box receives incoming mail that Apache SpamAssassin marks as spam. This is useful for users who receive a message that the system falsely flags as spam. |
|
On |
Prefix mail. onto Mailman URLs | This setting specifies whether the system should prefix Mailman URLs with mail (for example, http://mail.domain.com/mailman ).
Note:
If you set this value to On, this setting overrides any custom URL in your Mailman configuration. |
|