The cpanel.config File
Valid for versions 124 through the latest version
Last modified: September 10, 2024
Overview
The /var/cpanel/cpanel.config
file stores settings for WHM’s Tweak Settings interface (WHM » Home » Server Configuration » Tweak Settings).
You can preconfigure settings before you install cPanel & WHM. For more information, read our Customize Your Installation documentation.
Cached values
To improve performance, the system caches the /var/cpanel/cpanel.config
file’s settings in the /var/cpanel/cpanel.config.cache
file. This file updates each time that the /var/cpanel/cpanel.config
file updates, to keep the cached settings up-to-date.
Configuration setting validation
The settings in the /var/cpanel/cpanel.config
file use the key=value
format. The system validates each key=value
pair whenever you edit these settings. If the system encounters problems during validation, it takes other actions.
Absent cpanel.config file
If the entire /var/cpanel/cpanel.config
file does not exist:
- The server copies the default
/usr/local/cpanel/etc/cpanel.config
file and saves it as the/var/cpanel/cpanel.config
file. - The server copies the
/var/cpanel/cpanel.config.cache
file. If the system cannot find the/var/cpanel/cpanel.config.cache
file, it will regenerate both the/var/cpanel/cpanel.config.cache
and/var/cpanel/cpanel.config
files. - For any unset dynamic values, the server attempts to guess the correct value. For example, to set the
mailserver
value, the server checks whether your system uses thedovecot
package. - The server logs the changes to the
/usr/local/cpanel/logs/error_log
file.
Absent values
If a key doesn’t exist in the /var/cpanel/cpanel.config
file, the server attempts to generate a value from the following sources in the following order:
- The server copies the
key=value
pair from the/var/cpanel/cpanel.config.cache
file, if it exists. - If the key’s value is static and it doesn’t exist in the
/var/cpanel/cpanel.config.cache
file, the system copies thekey=value
pair from the/usr/local/cpanel/etc/cpanel.config
file. - If the key’s value is dynamic and it doesn’t exist in the
/var/cpanel/cpanel.config.cache
file, the server calculates a value. - The server logs the changes to the
/usr/local/cpanel/logs/error_log
file.
Invalid values
If one or more of the following values are invalid, the server tries to replace them with valid values:
local_nameserver_type
mailserver
ftpserver
Keys and default settings
You can find the default values for these keys in the /usr/local/cpanel/etc/cpanel.config
file.
Key | Tweak Settings section | Setting or description | Default and validation requirements |
---|---|---|---|
access_log |
No Tweak Settings equivalent. | This sets the location of cPanel’s Raw Access logs. These logs store general information about cPanel access requests. | /usr/local/cpanel/logs/access_log |
account_login_access |
System | Accounts that can access a cPanel user account: | owner_root
Warning:
Only set this value to
owner , owner_root , or user .
|
allow_deprecated_accesshash |
Security | Allow deprecated WHM accesshash authentication | 0
Warning:
We deprecated WHM’s Remote Access Key feature in cPanel & WHM version 64. We strongly recommend that you use API tokens instead.
|
allow_login_autocomplete |
System | Allow autocomplete for login screens. | 1 |
allow_server_info_status_from |
System | Allow server-info and server-status | (an empty string) |
allowcpsslinstall |
System | Allow cPanel users to install SSL Hosts. | 1
Warning:
If you set this value to
0 , cPanel users can’t enable the Force HTTPS Redirects option for any domain in cPanel’s Domains interface (cPanel » Home » Domains » Domains).
|
allowparkhostnamedomainsubdomains |
Domains | Allow users to park subdomains of the server’s hostname. | 0 |
allowparkonothers |
Domains | Allow cPanel users to create subdomains across accounts | 0 |
allowremotedomains |
Domains | Allow Remote Domains | 0 |
allowresellershostnamedomainsubdomains |
Domains | Allow resellers to create accounts with subdomains of the server’s hostname. | 0 |
allowunregistereddomains |
Domains | Allow unregistered domains | 0 |
allowwhmparkonothers |
Domains | Allow WHM users to create subdomains across accounts | 0 |
alwaysredirecttossl |
Redirection | Choose the closest matched domain for which that the system has a valid certificate when redirecting from non-SSL to SSL URLs. Formerly known as “Always redirect to SSL/TLS” | 1 |
apache_port |
System | Apache non-SSL IP/port | 0.0.0.0:80 |
apache_ssl_port |
System | Apache SSL port | 0.0.0.0:443 |
api_shell |
System | cPanel & WHM API shell (for developers) | 0 |
autocreateaentries |
Domains | Automatically add A entries for registered nameservers when creating a new zone | 1 |
autodiscover_host |
Domains | Host to publish in the SRV records for Outlook autodiscover support. | cpanelemaildiscovery.cpanel.net |
autodiscover_mail_service |
Domains | Preferred mail service to configure to use for Thunderbird and Outlook autodiscover and autoconfig support | imap |
autodiscover_proxy_subdomains |
Domains | Thunderbird and Outlook autodiscover and autoconfig support (enables service subdomain and SRV record creation) | 1
Warning:
|
autoupdate_certificate_on_hostname_mismatch |
Domains | Replace service SSL certificates that do not match the local hostname | 1 |
awstatsbrowserupdate |
Stats and Logs | Allow users to update Awstats from cPanel | 0 |
awstatsreversedns |
Stats Programs | Awstats reverse DNS resolution | 0 |
bind_deferred_restart_time |
System | DNS server reload deferral time | 2 |
blockcommondomains |
Domains | Prevent cPanel users from creating specific domains | 1 |
bwcycle |
No Tweak Settings equivalent. | This configures the bandwidth cycle for statistics. You can change this value in WHM’s Statistics Software Configuration interface (WHM » Home » Server Configuration » Statistics Software Configuration). | 2
Note:
When your server validates the
cpanel.config file, it rounds this value to the nearest quarter hour.
|
cgihidepass |
Security | Hide login password from cgi scripts | 0 |
check_zone_owner |
Domains | Check zone owner | 1 |
check_zone_syntax |
Domains | Check zone syntax | 1 |
chkservd_check_interval |
System | The number of seconds between ChkServd service checks. | 300 |
chkservd_hang_allowed_intervals |
System | The number of times ChkServd allows a previous check to complete before termination. | 2 |
chkservd_plaintext_notify |
System | The option to enable or disable ChkServd HTML notifications. | 0 |
cluster_autodisable_threshold |
No Tweak Settings equivalent. | This sets a number of failed dnsadmin commands. After reaching this number, the system disables that DNS cluster member. You can change this value via the Failure threshold for cluster members setting in WHM’s DNS Cluster interface (WHM » Home » Clusters » DNS Cluster). |
10 |
cluster_failure_notifications |
No Tweak Settings equivalent. | This sets whether to send an email if the system disables a DNS cluster member. You can change this value via the Receive a notification when WHM disables an unresponsive cluster member setting in WHM’s DNS Cluster interface (WHM » Home » Clusters » DNS Cluster). | 1 |
conserve_memory |
System | Conserve memory | 0
Warning:
This value is dynamic. You must perform additional steps to update it manually. We recommend only modifying this value in the interface.
|
cookieipvalidation |
Security | Cookie IP validation | strict |
copy_default_error_documents |
System | Copy default error documents to docroot for new accounts, addon domains, and subdomains | 0 |
coredump |
Security | Generate core dumps | 0 |
cpaddons_adminemail |
cPAddons Site Software | cPAddons Site Software admin email | (an empty string) |
cpaddons_autoupdate |
cPAddons Site Software | cPAddons Site Software source automatic updates | 1 |
cpaddons_max_moderation_req_all_mod |
cPAddons Site Software | Max cPAddons Site Software installation requests | 99 |
cpaddons_max_moderation_req_per_mod |
cPAddons Site Software | Max cPAddons Site Software installation requests per addon | 99 |
cpaddons_moderation_request |
cPAddons Site Software | cPAddons Site Software moderation notification | 0 |
cpaddons_no_3rd_party |
cPAddons Site Software | Allow cPAddons Site Software installations from non-cPanel sources | 0 |
cpaddons_no_modified_cpanel |
cPAddons Site Software | Allow cPAddons Site Software installations from modified sources | 1 |
cpaddons_notify_owner |
cPAddons Site Software | Notify reseller of cPAddons Site Software installations | 1 |
cpaddons_notify_root |
cPAddons Site Software | Notify root of cPAddons Site Software installations | 1 |
cpaddons_notify_users |
cPAddons Site Software | Notify cPanel users when they need to update their cPAddons Site Software installations | Allow users to choose |
cpanel_locale |
No Tweak Settings equivalent. | (an empty string) | |
cpdavd_caldav_upload_limit |
System | Max upload size for CalDAV/CardDAV server | 10 |
cpredirect |
Redirection | Non-SSL redirect destination | Origin Domain Name |
cpredirectssl |
Redirection | SSL redirect destination | SSL Certificate Name |
cpsrvd-domainlookup |
System | cpsrvd username domain lookup | 0 |
create_account_dkim |
Domains | Enable DKIM on domains for newly created accounts | 1 |
create_account_dmarc |
Domains | Enable DMARC on domains for newly created accounts | 1
Important:
DMARC requires valid SPF and DKIM records. To enable DMARC, you must also set the |
create_account_spf |
Domains | Enable SPF on domains for newly created accounts
Note:
The
/scripts/enable_spf_dkim_globally script allows you to enable SPF and DKIM for accounts that exist on the server, and to create the appropriate DNS records for their domains. For more information, read our The enable_spf_dkim_globally Script documentation.
|
1 |
csp |
Security | Enable Content-Security-Policy on some interfaces | 0 |
cycle_hours |
No Tweak Settings equivalent. | This setting adjusts log processing frequency. You can change this value in WHM’s Statistics Software Configuration interface (WHM » Home » Server Configuration » Statistics Software Configuration). | 24
Note:
When your server validates the
cpanel.config file, the system rounds this value to the nearest quarter hour.
|
database_prefix |
SQL | Require a username prefix on names of new databases and database users | 1 |
debughooks |
No Tweak Settings equivalent. | This setting acts as a fallback setting for the values in the /var/cpanel/debughooks file.
|
0 |
debugui |
Development | User Interface - Debug Mode | 0 |
default_archive-logs |
Stats and Logs | Archive logs in the user’s home directory at the end of each stats run unless configured by the user. | 1 |
default_login_theme |
Display | Default login theme | cpanel |
default_pkg_bwlimit |
Packages | Default bandwidth limit for new packages | 1048576 |
default_pkg_max_emailacct_quota |
Packages | Default maximum email quota for new packages
Important:
This setting applies to each email account and not each cPanel account.
|
1024 |
default_pkg_quota |
Packages | Default disk usage quota for new packages | 10240 |
default_remove-old-archived-logs |
Stats and Logs | Remove the previous month’s archived logs from the user’s home directory at the end of each month unless configured by the user. | 1 |
defaultmailaction |
Initial default/catch-all forwarder destination | localuser |
|
disable_cphttpd |
System | Prevent cpsrvd from serving standard HTTP ports | 0 |
disable-php-as-reseller-security |
Security | Allow PHP to be run when logged in as a reseller to WHM | 0 |
disablequotacache |
System | Cache disk quota information | 0 |
disk_usage_include_mailman |
Include mailman in disk usage calculations | 1 |
|
disk_usage_include_sqldbs |
SQL | Include databases in disk usage calculations | 1 |
display_cpanel_doclinks |
Support | Display documentation links in cPanel interface | 0 |
display_cpanel_promotions |
Display | Display announcement banner. | 1 |
display_upgrade_opportunities |
Display | Display the Upgrade Opportunities column in WHM’s List Accounts interface (WHM » Home » Account Information » List Accounts). | 0 |
dns_recursive_query_pool_size |
Display | This setting restricts the maximum number of currently-active recursive DNS queries. Use this setting if your firewall imposes rate limits on DNS queries. These rate limits can degrade recursive DNS queries in applications such as AutoSSL. | 10 |
dnsadmin_log |
Logging | dnsadmin logging level | 0 |
dnsadmin_verbose_sync |
Logging | Enable verbose logging of DNS zone syncing | 0 |
dnsadminapp |
Domains | DNS request management application | undef
Note:
If this value is an empty string when your server validates the
cpanel.config file, the system converts it to undef .
|
dnslookuponconnect |
System | Reverse DNS lookup upon connect | 0 |
docroot |
No Tweak Settings equivalent. | This setting specifies the document root for WHM. | /usr/local/cpanel/base |
domainowner_mail_pass |
Mail authentication via domain owner password | 0
Warning:
This value is dynamic. You must perform additional steps to update it manually. We recommend only modifying this value through the interface.
|
|
dormant_services |
Software | Dormant services | cpdavd,cphulkd,cpsrvd,dnsadmin,spamd
Warning:
This value is dynamic. You must perform additional steps to update it manually. We recommend only modifying this value through the interface.
|
dumplogs |
Stats and Logs | Delete each domain’s access logs after statistics are gathered | 1 |
email_account_quota_default_selected |
Default quota option for new email accounts | userdefined |
|
email_account_quota_userdefined_default_value |
Default user-defined quota value for new email accounts | 1024 |
|
email_outbound_spam_detect_action |
Select the action for the system to take on an email account when it detects a potential spammer. | noaction |
|
email_outbound_spam_detect_enable |
Monitor the number of unique recipients per hour to detect potential spammers. | 1 |
|
email_outbound_spam_detect_threshold |
Number of unique recipients per hour to trigger potential spammer notification. | 500 |
|
email_send_limits_count_mailman |
Count mailman deliveries towards a domain’s Max hourly emails. | 0 |
|
email_send_limits_defer_cutoff |
The percentage of email messages (above the account’s hourly maximum) to queue and retry for delivery. | 125 |
|
email_send_limits_max_defer_fail_percentage |
Maximum percentage of failed or deferred messages a domain may send per hour | undef |
|
email_send_limits_min_defer_fail_to_trigger_protection |
Number of failed or deferred messages a domain may send before protections can be triggered | 5 |
|
emailarchive |
Enable Email Archiving support | 0 |
|
emailpasswords |
Security | Send passwords when creating a new account | 0 |
emailsperdaynotify |
Number of emails a domain may send per day before the system sends a notification | No default value. | |
emailusers_diskusage_critical_contact_admin |
Notifications | Notify admin or reseller when disk quota reaches “critical” state | 1 |
emailusers_diskusage_critical_percent |
Notifications | Account disk quota “critical” percentage | 90
Note:
If this value is
0 when your server validates the cpanel.config file, the system converts it to undef .
|
emailusers_diskusage_full_contact_admin |
Notifications | Notify admin or reseller when disk quota reaches “full” state | 1 |
emailusers_diskusage_full_percent |
Notifications | Account disk quota “full” percentage | 98
Note:
If this value is
0 when your server validates the cpanel.config file, the system converts it to undef .
|
emailusers_diskusage_warn_contact_admin |
Notifications | Notify admin or reseller when disk quota reaches “warn” state | 0 |
emailusers_diskusage_warn_percent |
Notifications | Account disk quota “warn” percentage | 80
Note:
If this value is
0 when your server validates the cpanel.config file, the system converts it to undef .
|
emailusers_mailbox_critical_percent |
Notifications | Mailbox disk quota “critical” percentage | 90
Note:
If this value is
0 when your server validates the cpanel.config file, the system converts it to undef .
|
emailusers_mailbox_full_percent |
Notifications | Mailbox disk quota “full” percentage | 98
Note:
If this value is
0 when your server validates the cpanel.config file, the system converts it to undef .
|
emailusers_mailbox_warn_percent |
Notifications | Mailbox disk quota “warn” percentage | 80
Note:
If this value is
0 when your server validates the cpanel.config file, the system converts it to undef .
|
emailusersbandwidthexceed |
Notifications | Send bandwidth limit notification emails | 1 |
emailusersbandwidthexceed70 |
Notifications | Bandwidth usage warning: 70% | 0 |
emailusersbandwidthexceed75 |
Notifications | Bandwidth usage warning: 75% | 0 |
emailusersbandwidthexceed80 |
Notifications | Bandwidth usage warning: 80% | 1 |
emailusersbandwidthexceed85 |
Notifications | Bandwidth usage warning: 85% | 0 |
emailusersbandwidthexceed90 |
Notifications | Bandwidth usage warning: 90% | 0 |
emailusersbandwidthexceed95 |
Notifications | Bandwidth usage warning: 95% | 0 |
emailusersbandwidthexceed97 |
Notifications | Bandwidth usage warning: 97% | 0 |
emailusersbandwidthexceed98 |
Notifications | Bandwidth usage warning: 98% | 0 |
emailusersbandwidthexceed99 |
Notifications | Bandwidth usage warning: 99% | 0 |
empty_trash_days |
System | Age, in days, of content to purge from users’ File Manager Trash | disabled |
enable_api_log |
Logging | This setting allows you to log successful or failed cPanel API 1, successful cPanel API 2, and successful UAPI function calls. We store this log in the /usr/local/cpanel/logs/api_log file. |
0 |
enablecompileroptimizations |
System | Enable optimizations for the C compiler | 0 |
enable_piped_logs |
No Tweak Settings equivalent. | This sets whether to use piped logging with Apache. You can change this value in WHM’s Apache Configuration interface (WHM » Home » Service Configuration » Apache Configuration). | 1 |
enablefileprotect |
Security | Enable File Protect | 1 |
enforce_user_account_limits |
System | Enforce user account limits for resellers with the “Account Modification” ACL. | 0 |
engine |
No Tweak Settings equivalent. | This sets the name of the cPanel binary. | cpanel
Warning:
Do not modify this value.
|
enginepl |
No Tweak Settings equivalent. | This sets the name of the cpanel.pl file. |
cpanel.pl
Warning:
Do not modify this value.
|
engineroot |
No Tweak Settings equivalent. | This sets the location of the cPanel binary. | /usr/local/cpanel
Warning:
Do not modify this value.
|
exim_retention_days |
Stats and Logs | The interval, in days, to retain Exim stats in the database | 10 |
exim-retrytime |
Email delivery retry time | 15 |
|
eximmailtrap |
Track email origin via X-Source email headers | 1
Warning:
This value is dynamic. You must perform additional steps to update it manually. We recommend only modifying this value in the interface.
|
|
extracpus |
Stats and Logs | Extra CPUs for server load | 0 |
file_upload_max_bytes |
System | Max HTTP submission size | undef
Note:
If this value is
unlimited when your server validates the cpanel.config file, the system converts it to undef .
|
file_upload_must_leave_bytes |
System | File upload required free space | 5 |
file_usage |
Display | Display File Usage information in the cPanel stats bar (inode count) | 0 |
force_short_prefix |
SQL | Force short prefix for MySQL and MariaDB databases | 0 |
ftpquotacheck_expire_time |
System | Interval, in days, between rebuilds of the FTP quota and disk usage data (applies to Pure-FTPd only) | 30 |
ftpserver |
No Tweak Settings equivalent. | This sets the FTP server. You can select an FTP server in WHM’s FTP Server Selection interface (WHM » Home » Service Configuration » FTP Server Selection). | disabled
Warning:
This value is dynamic. You must perform additional steps to update it manually. We recommend only modifying this value in the interface.
|
gzip_compression_level |
Compression | gzip compression level
Note:
This setting does not affect the NGINX gzip package’s settings.
|
6 |
gzip_pigz_block_size |
Compression | Number of kilobyte chunks per compression work unit
Note:
This setting does not affect the NGINX gzip package’s settings.
|
4096 |
gzip_pigz_processes |
Compression | Number of pigz processes
Note:
This setting does not affect the NGINX gzip package’s settings.
|
1
Warning:
This value is dynamic. You must perform additional steps to update it manually. We recommend only modifying this value in the interface.
|
htaccess_check_recurse |
System | Depth to recurse for .htaccess checks | 2 |
httpd_deferred_restart_time |
System | HTTPD deferred reload time | 0 |
invite_sub |
System | Account Invites for Subaccounts | 1 |
ionice_bandwidth_processing |
System | I/O priority level at which bandwidth usage is processed | 6 |
ionice_cpbackup |
System | I/O priority level at which nightly backups are run | 6 |
ionice_dovecot_maintenance |
System | I/O priority level at which dovecot_maintenance is run | 7 |
ionice_email_archive_maintenance |
System | I/O priority level at which email_archive_maintenance is run | 7 |
ionice_ftpquotacheck |
System | I/O priority level at which FTP quota checks are run (when Pure-FTPd is enabled) | 6 |
ionice_log_processing |
System | I/O priority level at which stats logs are processed | 7 |
ionice_quotacheck |
System | I/O priority level at which quota checks are run | 6 |
ionice_userbackup |
System | I/O priority level at which cPanel-generated backups are run | 7 |
ionice_userproc |
System | I/O priority level for user-initiated processes | 6 |
ipv6_control |
No Tweak Settings equivalent. | 0 |
|
ipv6_listen |
System | Listen on IPv6 Addresses | 0 |
jailapache |
Security | EXPERIMENTAL: Jail Apache Virtual Hosts using mod_ruid2 and cPanel® jailshell. | 0 |
jaildefaultshell |
System | Use cPanel® jailshell by default | 0 |
jailmountbinsuid |
System | Jailed /bin mounted suid
Note:
This setting has no effect on servers that run the CloudLinux™ 8, AlmaLinux OS 8, Rocky Linux 8, or Ubuntu operating systems.
|
0 |
jailmountusrbinsuid |
System | Jailed /usr/bin mounted suid | 0 |
jailprocmode |
System | Jailed /proc mount method | mount_proc_jailed_fallback_full |
keepftplogs |
Stats and Logs | Keep master FTP log file | 0 |
keeplogs |
Stats and Logs | Keep log files at the end of the month | 0 |
keepstatslog |
Stats and Logs | Keep stats logs | 0 |
loadthreshold |
Status | Critical load threshold | undef
Warning:
This value is dynamic. You must perform additional steps to update it manually. We recommend only modifying this value in the interface.
|
local_nameserver_type |
No Tweak Settings equivalent. | This sets your nameserver’s type. You can select a nameserver type in WHM’s Nameserver Selection interface (WHM » Home » Service Configuration » Nameserver Selection). | powerdns
Warning:
This value is dynamic. You must perform additional steps to update it manually. We recommend only modifying this value in the interface.
|
logchmod |
Stats and Logs | Apache log file chmod value | 0640 |
log_successful_logins |
Logging | Log successful logins | 0 |
logout_redirect_url |
Redirection | Logout redirection URL | (an empty string) |
mailbox_storage_format |
The mailbox storage format for new accounts | maildir |
|
mailserver |
No Tweak Settings equivalent. | This sets the mailserver type. | dovecot
Warning:
This value is dynamic. You must perform additional steps to update it manually. We recommend only modifying this value in the interface.
|
maintenance_rpm_version_check |
Software | Maintenance cPanel RPM Check | 1 |
maintenance_rpm_version_digest_check |
Software | Maintenance cPanel RPM Digest Check | 1 |
maxcpsrvdconnections |
System | Max cPanel/WHM/Webmail service handlers | 200
Note:
If this value is less than
200 when your server validates the cpanel.config file, it will convert it to the default value.
|
maxemailsperhour |
Max hourly emails per domain | undef
Note:
If this value evaluates to zero when your server validates the
cpanel.config file, it will convert it to undef .
|
|
maxmem |
System | Max cPanel process memory | 4096
Note:
This value is dynamic.
|
min_time_between_apache_graceful_restarts |
System | Minimum time between Apache graceful restarts. | 10 |
minpwstrength |
No Tweak Settings equivalent. | This sets the minimum strength for cPanel account passwords. You can set the minimum strength for cPanel users’ passwords in WHM’s Password Strength Configuration interface (WHM » Home » Security Center » Password Strength Configuration). | 65
Note:
When your server validates the
cpanel.config file, it rounds this value to the nearest multiple of five.
|
modsec_keep_hits |
Stats and Logs | The number of days to keep records of ModSecurity® rule hits. (Use zero to keep forever). | 7 |
mycnf_auto_adjust_maxallowedpacket |
SQL | Allow cPanel & WHM to determine the best value for your MySQL max_allowed_packet configuration? | 1 |
mycnf_auto_adjust_openfiles_limit |
SQL | Allow cPanel & WHM to determine the best value for your MySQL open_files_limit configuration? | 1 |
mycnf_auto_adjust_innodb_buffer_pool_size |
SQL | Allow cPanel & WHM to determine the best value for your MySQL innodb_buffer_pool_size configuration? | 0 |
mysql-version |
No Tweak Settings equivalent. | This sets the MySQL® version. You can upgrade to a new MySQL version in WHM’s Upgrade Database Version interface (WHM » Home » Database Services » Upgrade Database Version). | undef
Warning:
This value is dynamic. You must perform additional steps to update it manually. We recommend only modifying this value in the interface.
|
mysql-host |
No Tweak Settings equivalent. | This sets the MySQL host. You can specify a remote MySQL host in cPanel’s Remote Database Access interface (cPanel » Home » Databases » Remote Database Access). | localhost
Warning:
This value is dynamic. You must perform additional steps to update it manually. We recommend only modifying this value in the interface.
|
nobodyspam |
Prevent “nobody” from sending mail | 1 |
|
nocpbackuplogs |
No Tweak Settings equivalent. | This sets whether backups and log analysis run at the same time. You can modify this setting in WHM’s Statistics Software Configuration interface (WHM » Home » Server Configuration » Statistics Software Configuration). | 0 |
nosendlangupdates |
System | Send language file changes to cPanel | 0 |
notify_expiring_certificates |
Notifications | Send notifications when certificates approach expiry. | 1 |
numacctlist |
Display | Number of accounts per page to display in “List Accounts”. | 30
Note:
If this value contains
all (case-insensitive) when your server validates the cpanel.config file, it will convert it to undef .
|
overwritecustomproxysubdomains |
Domains | Overwrite custom A records used for service subdomains | 0 |
overwritecustomsrvrecords |
Domains | Overwrite custom SRV records used by Outlook AutoDiscover support | 0 |
permit_appconfig_entries_without_acls |
Security | This setting allows WHM applications and addons to execute even if an ACL list has not been defined. | 0 |
permit_appconfig_entries_without_features |
Security | This setting allows cPanel and Webmail applications and addons to execute even if a feature list has not been defined. | 0 |
permit_unregistered_apps_as_reseller |
Security | Allow apps that have not registered with AppConfig to be run when logged in as a reseller to WHM. | 0 |
permit_unregistered_apps_as_root |
Security | Allow apps that have not registered with AppConfig to be run when logged in as root or a reseller with the “all” ACL in WHM. | 0 |
php_max_execution_time |
PHP | cPanel PHP max execution time | 90
Note:
This key updates cPanel & WHM’s internal
php.ini files. If you edit these files directly, the system will overwrite your changes. Use the PHP section of the Tweak Settings interface to edit cPanel & WHM’s internal php.ini files.
|
php_memory_limit |
PHP | cPanel PHP memory limit | 128
Note:
This key updates cPanel & WHM’s internal
php.ini files. If you edit these files directly, the system will overwrite your changes. Use the PHP section of the Tweak Settings interface to edit cPanel & WHM’s internal php.ini files.
|
php_post_max_size |
PHP | cPanel PHP max POST size | 55
Note:
This key updates cPanel & WHM’s internal
php.ini files. If you edit these files directly, the system will overwrite your changes. Use the PHP section of the Tweak Settings interface to edit cPanel & WHM’s internal php.ini files.
|
php_system_default_version |
No Tweak Settings equivalent. | This sets the system’s default version of PHP. You can change this value in WHM’s MultiPHP Manager interface (WHM » Home » Software » MultiPHP Manager).
Note:
This setting does not exist in the
/usr/local/cpanel/etc/cpanel.config file.
|
ea-php81 |
php_upload_max_filesize |
PHP | cPanel PHP max upload size | 50
Note:
This key updates cPanel & WHM’s internal
php.ini files. If you edit these files directly, the system will overwrite your changes. Use the PHP section of the Tweak Settings interface to edit cPanel & WHM’s internal php.ini files.
|
phploader |
PHP | cPanel PHP loader | (an empty string)
Note:
This key updates cPanel & WHM’s internal
php.ini files. If you edit these files directly, the system will overwrite your changes. Use the PHP section of the Tweak Settings interface to edit cPanel & WHM’s internal php.ini files.
|
phpopenbasedirhome |
No Tweak Settings equivalent. | This setting enables or disables the open_basedir tweak. You can change this value in WHM’s MultiPHP INI Editor interface (WHM » Home » Software » MultiPHP INI Editor). |
0 |
pma_disableis |
Software | Enable phpMyAdmin information schema searches | 0 |
popbeforesmtp |
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) | 0 |
|
popbeforesmtpsenders |
Add X-PopBeforeSMTP header for mail sent via POP-before-SMTP | 0 |
|
product |
No Tweak Settings equivalent. | cPanel |
|
proxysubdomains |
Domains | Service subdomains | 1
Warning:
|
proxysubdomainsoverride |
Domains | Service subdomain override | 1 |
publichtmlsubsonly |
Domains | Restrict document roots to public_html | 1 |
query_apache_for_nobody_senders |
No Tweak Settings equivalent. | This sets whether the system will try to find the real sender of messages that the nobody user sent. You can change this value via the Query Apache server status to determine the sender of email sent from processes running as nobody setting in WHM’s Exim Configuration Manager interface (WHM » Home » Service Configuration » Exim Configuration Manager). | 1 |
referrerblanksafety |
Security | Blank referrer safety check | 0 |
referrersafety |
Security | Referrer safety check | 0 |
remotewhmtimeout |
System | Remote WHM timeout | 35 |
repquota_timeout |
System | Disk usage/quota bailout time | 60 |
requiressl |
Security | Require SSL for cPanel Services | 1 |
resetpass |
System | Reset Password for cPanel accounts | 1 |
resetpass_sub |
System | Reset Password for Subaccounts | 1 |
root |
No Tweak Settings equivalent. | This sets the location of the cPanel & WHM root installation. |
/usr/local/cpanel |
rotatelogs_size_threshhold_in_megabytes |
Stats and Logs | Log rotation size threshold | 300 |
roundcube_db |
No Tweak Settings equivalent. | This sets the type of database that Roundcube uses. | sqlite |
rpmup_allow_kernel |
System | Enable Linux kernel update during nightly maintenance. | 0 |
RS |
No Tweak Settings equivalent. | This sets the cPanel interface theme. | jupiter |
SecurityPolicy::PasswordAge |
No Tweak Settings equivalent. | This enables password aging on the server. You can change this value via the Password Age setting in WHM’s Configure Security Policies interface (WHM » Home » Security Center » Configure Security Policies).
Note:
This setting may not appear in the
/var/cpanel/cpanel.config file until you enable it in the interface. This setting also does not appear in the /usr/local/cpanel/etc/cpanel.config file.
|
1 |
SecurityPolicy::PasswordAge::maxage |
No Tweak Settings equivalent. | This sets the maximum age, in days, of passwords on the server. You can change this value via the Password Age setting in WHM’s Configure Security Policies interface (WHM » Home » Security Center » Configure Security Policies).
Note:
This setting may not appear in the
/var/cpanel/cpanel.config file until you enable it in the interface. This setting also does not appear in the /usr/local/cpanel/etc/cpanel.config file.
|
90 |
SecurityPolicy::PasswordStrength |
No Tweak Settings equivalent. | This sets the required password strength for passwords on the server. You can change this value via the Password Strength setting in WHM’s Configure Security Policies interface (WHM » Home » Security Center » Configure Security Policies).
Note:
This setting may not appear in the
/var/cpanel/cpanel.config file until you enable it in the interface. This setting also does not appear in the /usr/local/cpanel/etc/cpanel.config file.
|
1 |
SecurityPolicy::SourceIPCheck |
No Tweak Settings equivalent. | This sets whether to allow unverified IP addresses to log in. You can change this value via the Limit logins to verified IP addresses. setting in WHM’s Configure Security Policies interface (WHM » Home » Security Center » Configure Security Policies).
Note:
This setting may not appear in the
/var/cpanel/cpanel.config file until you enable it in the interface. This setting also does not appear in the /usr/local/cpanel/etc/cpanel.config file.
|
1 |
SecurityPolicy::TwoFactorAuth |
No Tweak Settings equivalent. | This sets whether the system requires Two-Factor Authentication. You can change this value via the Two-Factor Authentication setting in WHM’s Configure Security Policies interface (WHM » Home » Security Center » Configure Security Policies).
Note:
This setting may not appear in the
/var/cpanel/cpanel.config file until you enable it in the interface. This setting also does not appear in the /usr/local/cpanel/etc/cpanel.config file.
|
1 |
SecurityPolicy::dnsclustering |
No Tweak Settings equivalent. | This sets whether to use your security settings for DNS clusters. You can change this value via the DNS Cluster Requests setting in WHM’s Configure Security Policies interface (WHM » Home » Security Center » Configure Security Policies).
Note:
This setting may not appear in the
/var/cpanel/cpanel.config file until you enable it in the interface. This setting also does not appear in the /usr/local/cpanel/etc/cpanel.config file.
|
1 |
SecurityPolicy::xml-api |
No Tweak Settings equivalent. | This sets whether to use your security settings for API requests. You can change this value via the API requests setting in WHM’s Configure Security Policies interface (WHM » Home » Security Center » Configure Security Policies).
Note:
This setting may not appear in the
/var/cpanel/cpanel.config file until you enable it in the interface. This setting also does not appear in the /usr/local/cpanel/etc/cpanel.config file.
|
1 |
selfsigned_generation_for_bestavailable_ssl_install |
Security | Generate a self signed SSL certificate if a CA signed certificate is not available when setting up new domains. | 1 |
send_error_reports |
Support | Send error reports to cPanel for analysis | 0 |
server_locale |
System | Server Locale | en |
share_docroot_default |
Domains | Share the document root by default when creating a domain | 1 |
show_reboot_banner |
Security | Display a message to reboot the server after essential software updates. | 1 |
showwhmbwusageinmegs |
Stats and Logs | Show bandwidth usage in megabytes by default in WHM | 0 |
signature_validation |
Security | Signature validation on assets downloaded from cPanel & WHM mirrors. | Release Keyring Only |
skip_chkservd_recovery_notify |
System | The option to enable or disable ChkServd recovery notifications. | 0 |
skipanalog |
Stats Programs | Enable Analog stats | 0 |
skipapacheclientsoptimizer |
No Tweak Settings equivalent. | 0 |
|
skipawstats |
Stats Programs | Enable Awstats stats | 0 |
skipboxcheck |
Notifications | Enable mailbox usage warnings | 1 |
skipboxtrapper |
Enable BoxTrapper spam trap | 0 |
|
skipbwlimitcheck |
Notifications | Bandwidth limit check | 0 |
skipchkservd |
No Tweak Settings equivalent. | This sets whether to monitor the chkservd service. You can change this value via the ChkServd setting in WHM’s Service Manager interface (WHM » Home » Service Configuration » Service Manager). |
0 |
skipcpbandwd |
No Tweak Settings equivalent. | This sets whether to monitor bandwidth. You can change this value via the cPBandwd setting in WHM’s Service Manager interface (WHM » Home » Service Configuration » Service Manager). | 0 |
skipdiskcheck |
Notifications | Disk quota usage warnings | 0 |
skipdiskusage |
Notifications | System disk space usage warnings | 0 |
skipeximstats |
No Tweak Settings equivalent. | This sets whether to monitor mail services. You can change this value via the Eximstats setting in WHM’s Service Manager interface (WHM » Home » Service Configuration » Service Manager). | 0 |
skipfirewall |
System | Do not make changes to the firewall during account modification. | 0 |
skiphttpauth |
No Tweak Settings equivalent. | 1 |
|
skipjailmanager |
No Tweak Settings equivalent. | This sets whether to monitor jailed shells. You can change this value via the JailManager setting in WHM’s Service Manager interface (WHM » Home » Service Configuration » Service Manager). | 0 |
skipmailauthoptimizer |
No Tweak Settings equivalent. | You can change this value via the MailAuthOptimizer setting in WHM’s Service Manager interface (WHM » Home » Service Configuration » Service Manager). | 0 |
skipmailman |
Enable Mailman mailing lists | 0 |
|
skipmodseclog |
No Tweak Settings equivalent. | This sets whether to monitor IP addresses for IMAP and POP3 sessions. You can change this value via the RecentAuthedMailIp setting in WHM’s Service Manager interface (WHM » Home » Service Configuration » Service Manager). | 0 |
skipoomcheck |
Notifications | Out of memory warnings | 0 |
skipnotifyacctbackupfailure |
System | Send a notification when a user’s backup has errors | 0 |
skipparentcheck |
System | Allow other applications to run the cPanel and admin binaries | 0 |
skiprecentauthedmailiptracker |
No Tweak Settings equivalent. | This sets whether to monitor ModSecurity logs. You can change this value via the ModSecLog setting in WHM’s Service Manager interface (WHM » Home » Service Configuration » Service Manager). | 0 |
skiproundcube |
Enable Roundcube webmail | 0 |
|
skip_rules_added_by_configure_firewall_for_cpanel |
System | Do not make changes to the firewall via scripts/configure_firewall_for_cpanel. | 0 |
skipspamassassin |
Enable Apache SpamAssassin™ spam filter | 0 |
|
skipspambox |
Enable Apache SpamAssassin™ Spam Box delivery for messages marked as spam (user configurable) | 0 |
|
skiptailwatchd |
No Tweak Settings equivalent. | This sets whether to monitor the tailwatchd service. You can change this value via the tailwatchd setting in WHM’s Service Manager interface (WHM » Home » Service Configuration » Service Manager). | 0 |
skipwebalizer |
Stats Programs | Enable Webalizer stats | 0 |
smtpmailgidonly |
Restrict outgoing SMTP to root, exim, and mailman (FKA SMTP Tweak) | 1 |
|
ssh_host_key_checking |
Security | Enable strict SSH host key checking | 0 |
ssl_default_key_type |
Security | The type of key that the system will create by default for SSL/TLS certificates and signing requests.
|
rsa-2048 |
statsloglevel |
Stats and Logs | Stats log level | 1 |
stats_log |
No Tweak Settings equivalent. | This setting specifies the location of the stats_log file. |
/usr/local/cpanel/logs/stats_log |
statthreshhold |
No Tweak Settings equivalent. | This sets the minimum amount of disk space to process statistics.
Note:
If an account doesn’t meet this minimum, the system doesn’t process statistics for it.
|
256 |
system_diskusage_critical_percent |
Notifications | Account system disk usage “critical” percentage | 92.55 |
system_diskusage_warn_percent |
Notifications | Account system disk usage “warn” percentage | 82.55 |
tcp_check_failure_threshold |
System | ChkServd TCP check failure threshold | 3
Note:
If this value is
0 when your server validates the cpanel.config file, the system converts it to undef .
|
transfers_timeout |
System | Number of seconds an SSH connection related to an account transfer may be inactive before timing out | 1800 |
tweak_unset_vars |
No Tweak Settings equivalent. | This sets which items display warning icons in WHM’s Tweak Settings interface (WHM » Home » Server Configuration » Tweak Settings). | No default value.
Note:
The system only uses this value internally.
|
upcp_log_retention_days |
Stats and Logs | Number of days to retain upcp logs before purging them | 45 |
update_log_analysis_retention_length |
Support | Update analysis retention interval | 90 |
use_apache_md5_for_htaccess |
Security | Use MD5 passwords with Apache | 1 |
use_information_schema |
SQL | Use INFORMATION_SCHEMA to acquire MySQL disk usage | 1 |
useauthnameservers |
Domains | Always use authoritative (registered) nameservers when creating a new DNS zone. | 0 |
usemailformailmanurl |
Prefix “mail.” onto Mailman URLs | 0 |
|
usemysqloldpass |
SQL | Use pre-4.1-style MySQL® passwords | 0 |
userdirprotect |
No Tweak Settings equivalent. | This setting enables or disables the mod_userdir tweak. You can change this setting in WHM’s Apache mod_userdir Tweak interface (WHM » Home » Security Center » Apache mod_userdir Tweak). |
1 |
verify_3rdparty_cpaddons |
Security | Verify signatures of 3rdparty cPaddons. | 0 |
version |
No Tweak Settings equivalent. | 3.4 |
|
VFILTERDIR |
No Tweak Settings equivalent. | This sets the location of the Exim email filter storage directory. | /etc/vfilters |
xframecpsrvd |
Security | Use X-Frame-Options and X-Content-Type-Options headers with cpsrvd | 1 |