To configure cPanel and WHM prior to installation, you can use a command line text editor to create the file /root/cpanel_profile/cpanel.config. By entering a set of recognizable parameters, you will be allowed to configure cPanel and WHM before they are installed. Upon installation, this configuration file will be copied to /var/cpanel/cpanel.config.
The parameters are listed below as a set of variables. The variables are defined in basic terms as “variable name (variable type) (valid input values).” To define a variable, simply set it equal to a value. For example, to set the maximum emails per hour that any domain can send to 500, add maxemailsperhour=500 to /root/cpanel_profile/cpanel.config.
Remember: When using the Boolean variable type, a value of 1 means the feature will be enabled while a value of 0 means the feature will be disabled.
dnsadminapp (boolean) (1,0)
Application for processing DNS requests. The default setting of 1 uses the cPanel DNS cluster at /usr/local/cpanel/whostmgr /bin/dnsadmin. It is highly recommended that the default option be used.
check_zone_syntax (boolean) (1,0)
Dictates whether or not to check DNS zone file syntax when saving and synchronizing DNS zones.
useauthnameservers (boolean) (1,0)
When active, cPanel will check whether a domain name is already registered. If the domain name is registered, cPanel will ignore the configured nameservers and set the NS line to authoritative (registered) nameservers.
autocreateaentries (boolean) (1,0)
This control will automatically create A entries for registered nameservers contained in the zone when adding a new domain.
publichtmlsubsonly (boolean) (1,0)
Prevents account holders from creating subdomains outside of their own /public_html directory.
allowparkhostnamedomainsubdomains (boolean) (1,0)
Permits account holders to park (add on) subdomains on the server’s hostname domain.
allowresellershostnamedomainsubdomains (boolean) (1,0)
Allows resellers to create accounts with subdomains of the server’s hostname domain.
allowparkonothers (boolean) (1,0)
Allows account holders to park domains owned by other users. Activating this setting is not recommended.
allowremotedomains (boolean) (1,0)
Allows the creation of parked domains that resolve to other servers. This is known as domain transferring and can be a major security issue. If it must be enabled please disable users from parking common Internet domains (see blockcommondomains below).
blockcommondomains (boolean) (1,0)
Prevents account holders from parking on common Internet domains (i.e. hotmail.com, aol.com).
allowunregistereddomains (boolean) (1,0)
Allows the account holder to create unregistered parked domains.
proxysubdomains (boolean) (1,0)
Adds proxy VirtualHost to the httpd.conf file, automatically redirecting traffic from webmail and WHM subdomains to the correct ports. This option requires mod_rewrite and mod_proxy to function properly.
proxysubdomainsfornewaccounts (boolean) (1,0)
Automatically creates cPanel, webmail, and WHM proxy subdomain DNS entries for all new and existing accounts. To reconfigure the DNS entries manually, use /scripts/proxydomains.
proxysubdomainsoverride (boolean) (1,0)
Allows account holders to create cPanel webmail and WHM subdomains that override any proxy subdomains that were generated automatically.
defaultmailaction (string) (local user, blackhole, fail)
Defines default catch-all and address behaviors for new accounts. Fail is generally considered the best option for guarding against typical mail attacks.
remotedomainscheck (boolean) (1,0)
Automatic setup of the /etc/localdomains, /etc/remotedomains, and /etc/secondarymx directories based on where the mail exchanger (MX) record is pointed.
discardformmailbccsubject (boolean) (1,0)
Silently discards all FormMail and FormMail-clone requests with a bcc: header as the subject line.
exim-retrytime (integer) (≥ 0)
This option controls the number of minutes between mail server queue runs. The default value is 60 minutes.
eximmailtrap (boolean) (1,0)
Tracks the origins of messages through the mail server by adding X-Source headers. This option requires that the server have Exim 4.34 or greater.
maxemailsperhour (integer) (≥ 0)
Defines the maximum number of messages each domain can send per hour. Enter a value of 0 for unlimited sends.
nobodyspam (boolean) (1,0)
User nobody is prevented from sending mail to remote addresses. Please note that PHP and CGI scripts usually run as nobody when PHPsuEXEC and suEXEC are not being used.
popbeforesmtpsenders (boolean) (1,0)
A list of POPBeforeSMTP senders will be included in the X-PopBeforeSMTP header when relaying mail. This feature requires that the server have Exim 4.34-30 or greater installed.
popchecktimes (integer) (≥ 0)
Defines how many times per hour an account holder can check e-mail using POP3. A value of 0 is defined as unlimited.
popfloodcheck (boolean) (1,0)
Modifies options within Courier’s POP3 daemon to limit the maximum number of connections per IP in an effort to prevent POP3 connection floods.
skipboxtrapper (boolean) (1,0)
The BoxTrapper feature will not be accessible to account holders.
skiphorde (boolean) (1,0)
The Horde webmail feature will not be accessible to account holders.
skipmailman (boolean) (1,0)
Disables the Mailman feature.
skipneomail (boolean) (1,0)
The Neo webmail feature will not be accessible to account holders.
skipspamassassin (boolean) (1,0)
Disables the SpamAssassin spam filter.
skipspambox (boolean) (1,0)
Messages marked as spam by SpamAssassin spam box will be delivered to account holders, rather than to a spam box. This option is user-configurable.
skipsqmail (boolean) (1,0)
Disables the SquirrelMail webmail feature.
usemailformailmanurl (boolean) (1,0)
Adds the mail. prefix for Mailman URLs (i.e. http://mail.domain.com/mailman)
mysql-version (4, 4.1, 5)
Controls the current version of SQL running on the server. When changes are made to the server, click on Update Server Software under Software in the WHM interface. From the terminal, run /scripts/mysqlup followed by running /BuildApache/EasyApache. It may also be necessary to run /scripts/perlinstaller --force Bundle::DBD::mysql from the terminal.
Important: Updating from a previous version of MySQL is not automatically reversible; backups should be made if it might be necessary to downgrade in the future.
usemysqloldpass (boolean) (1,0)
Allows old-style MySQL 4.0 passwords with MySQL 4.1 and greater. This may be required if problems are encountered while trying to authenticate PHP applications.
skipdiskcheck (boolean) (1,0)
Disk space usage warnings will not appear to account holders.
emailusers_diskusage_full_percent (integer) (0 - 100)
This feature defines when a user’s disk usage is considered to be in the “full” state. Entering a value of 0 will disable this notification.
emailusers_diskusage_full_contact_admin (boolean) (1,0)
Notifies the admin or reseller when an account has reached the “full” state.
emailusers_diskusage_critical_percent (integer) (0 - 100)
Defines the threshold when the account holder’s disk usage is considered to be in the “critical” state. A value of 0 will disable the notification.
emailusers_diskusage_critical_contact_admin (boolean) (1,0)
Automatically notify the admin or reseller when an account has reached its defined “critical” disk usage state.
emailusers_diskusage_warn_percent (integer) (0 - 100)
Defines the threshold when an account holder’s disk usage is considered at the “warn” state. A value of 0 will disable this notification.
emailusers_diskusage_warn_contact_admin (boolean) (1,0)__
Notifies the admin or reseller when the account holder has reached the “warn” disk usage state.
skipboxcheck (boolean) (1,0)
Disables mailbox usage warnings.
emailusers_mailbox_full_percent (integer) (0 - 100)
Defines the threshold when an account holder’s mailbox disk usage is considered “full.” A value of 0 will disable this notification.
emailusers_mailbox_critical_percent (integer) (0 - 100)
This option defines the threshold when an account holder’s mailbox disk usage is considered “critical.” A value of 0 will disable this notification.
emailusers_mailbox_warn_percent (integer) (0 - 100)
Defines the threshold when an account holder’s mailbox disk usage is considered at the “warn” stage. A value of 0 will disable this notification.
skipbwlimitcheck (boolean) (1,0)
Disables the ability to suspend accounts that exceed bandwidth limits. If disabled, it will clear all suspensions and disable all bandwidth notifications.
emailusersbandwidthexceed99 (boolean) (1,0)
Notifies users through email that 99% of the allotted bandwidth has been used.
emailusersbandwidthexceed98 (boolean) (1,0)
Notifies users through email that 98% of the allotted bandwidth has been used.
emailusersbandwidthexceed97 (boolean) (1,0)
Notifies users through email that 97% of the allotted bandwidth has been used.
emailusersbandwidthexceed95 (boolean) (1,0)
Notifies users through email that 95% of the allotted bandwidth has been used.
emailusersbandwidthexceed90 (boolean) (1,0)
Notifies users through email that 90% of the allotted bandwidth has been used.
emailusersbandwidthexceed85 (boolean) (1,0)
Notifies users through email that 85% of the allotted bandwidth has been used.
emailusersbandwidthexceed80 (boolean) (1,0)
Notifies users through email that 80% of the allotted bandwidth has been used.
emailusersbandwidthexceed75 (boolean) (1,0)
Notifies users through email that 75% of the allotted bandwidth has been used.
emailusersbandwidthexceed70 (boolean) (1,0)
Notifies users through email that 70% of the allotted bandwidth has been used.
emailusersbandwidthexceed (boolean) (1,0)
Emails users when they have exceeded their bandwidth. Disabling this will prevent all bandwidth limits email from being sent.
interchangever (5.0, 4.8, 4.9, disable)
Defines which Interchange version to use. (If Interchange is disabled, turn off the service in the Service Manager.)
phploader (string) (none, oldsourceguardian, sourceguardian, ioncube)
Defines the PHP loader to use for internal cPanel PHP. Use oldsourceguardian for versions 1.x and 2.x.
skipformmail (boolean) (1,0)
Disables the FormMail-clone CGI feature.
urchinsetpath (string) (/path)
Defines the path to the Urchin installation if it is already installed. This option can be left blank for auto-detection.
awstatsreversedns (boolean) (1,0)
AWStats will reverse-DNS-lookup the hostnames of IPs that have visited the site.
skipanalog (boolean) (1,0)
Disables the Analog stats feature.
skipawstats (boolean) (1,0)
Disables the AWStats feature.
skipwebalizer (boolean) (1,0)
Disables the Webalizer stats feature.
awstatsbrowserupdate (boolean) (1,0)
Enables account holders to update AWStats from the cPanel interface.
cycle (float) (≥ 0)
Defines the number of days between processing log files and bandwidth usage. The default value is 1.
dumplogs (boolean) (1,0)
Deletes each domain’s access logs after the stats are run.
extracpus (integer) (≥ 0)
Defines the load average divided by the number of CPUs at which log file processing should be suspended. Its default value is 0.
ftppasslogs (boolean) (1,0)
Will not include the password in the raw log download link shown on the cPanel FTP Accounts screen.
keepftplogs (boolean) (1,0)
Prevents /usr/local/apache/domlogs/ftpxferlog from being reset after it has been separated into each domain name’s FTP log.
keeplogs (boolean) (1,0)
Keeps the log files at the end of the month. Disk space can be used very quickly if this feature is enabled.
keepstatslog (boolean) (1,0)
Stats log located at /user/local/cpanel/logs/stats_log will be kept between cPanel restarts. This feature is off by default.
logchmod (octal permission) (4 digit integer)
This option defines the chmod value for raw Apache log files. 0640 is the value by default.
showwhmbwusageinmegs (boolean) (1,0)
WHM always displays bandwidth usage in Megabytes first.
skipeximstats (boolean) (1,0)
Disables the Exim stats daemon. It is required for SMTP bandwidth logging and must also be modified in the Service Manager.
statsloglevel (integer) (0 - 10)
Defines the stats log level. The default value is 1. Larger numbers indicate greater debugging information in /usr/local/cpanel/logs/stats_log.
loadthreshold (integer) (≥ 0)
Defines the load average that will cause the server status to appear red. The default is 0.
alwaysredirecttossl (boolean) (1,0)
Redirects account holders to the SSL/TLS ports when visiting certain directories on the server (i.e. cPanel, Webmail, etc.).
logout_redirect_url (string) (URL)
Redirects users to the URL upon logout of the cPanel interface. A blank value specifies the default logout page.
cpredirect (string) (hostname, origin domain name)
Allows users to redirect to another location when visiting cPanel, WHM, and webmail when SSL is not being utilized.
cpredirectssl (string) (hostname, origin domain name, ssl certification name)
Allows users to redirect to another location when visiting cPanel, WHM, and webmail when SSL is being utilized.
conserve_memory (boolean) (1,0)
Allows the user to conserve memory at the expense of the CPU and disk I/O.
allowcpsslinstall (boolean) (1,0)
Allows account holders to install SSL hosts if they have a dedicated IP.
allowperlupdates (boolean) (1,0)
Allows Perl updates from RPM-based Linux vendors when enabled.
apache_port (IP address:Port #) (x.x.x.x:x)
Assigns the port on which Apache will listen for HTTP connections. Specifying an IP address will prevent Apache from listening on all other IPs. The default value for this option is 0.0.0.0:80. A value of 0 is undefined.
apache_ssl_port (IP address:Port #) (x.x.x.x:x)
Assigns the port on which Apache will listen for HTTPS connections. Specifying an IP address will prevent Apache from listening on all other IPs. The default value for this option is 80.0.0.0:443. A value of 0 is undefined.
Note: The x’s in this scenario are meant to represent positive integers of 1 or more digits.
allow_server_info_status_from (string) (URL)
Controls the list of IP addresses or hostnames, separated by spaces, that are allowed to view the /server-info and /server-status pages. Please see
http://httpd.apache.org/docs/1.3/mod/mod_access.html#allow for the proper values to configure this option.
cpsrvd-gzip (boolean) (1,0)
Compresses the interface pages using gzip compression to reduce bandwidth usage for cPanel and WHM.
cpsrvd-domainlookup (boolean) (1,0)
Allows usernames to be determined through the account hostname if no username is provided.
disableipnscheck (boolean) (1,0)
Allows the sharing of nameserver IPs when it is enabled.
disablequotacache (boolean) (1,0)
Disables disk quota display caching. WHM will then cache disk usage, which could potentially delay the displaying of disk quotas by 15 minutes. Disabling this feature can result in a serious degradation of performance.
disablexfercpanel (boolean) (1,0)
Disables the ability to login to the users’ cPanel interface with the root or reseller password. This also disables the Switch Account drop-down in themes with the “switch account” feature.
disable_compiled_dnsadmin (boolean) (1,0)
Disables the use of the compiled DNSAdmin functions.
dnslookuponconnect (boolean) (1,0)
Attempts to resolve each client’s IP address to a domain name when an account holder connects to the cPanel interface. This can cause a severe drop in performance quality.
errorstostdout (boolean) (1,0)
Errors will display in cPanel rather than putting them into the error log at /usr/local/cpanel/logs/error_log.
file_upload_max_bytes (integer) (≥ 0, unlimited)
Defines the maximum size, in Megabytes, for a file to upload through cPanel’s File Manager. To define an unlimited maximum size, use unlimited as the input value.
file_upload_must_leave_bytes (integer) (≥ 0)
Defines the minimum filesystem quota space (in Megabytes) required after a file is uploaded through the cPanel File Manager. This function is intended to prevent users from hitting their quota limit through File Manager uploads. The default value is 5 Megabytes.
ignoredepreciated (boolean) (1,0)
Warning messages about depreciating features will not be displayed. Turning this feature on may lead to a non-functioning server when some features are removed in future releases.
jaildefaultshell (boolean) (1,0)
Sets Jailshell as the default shell for all new and modified accounts.
maxmem (integer) (≥ 128)
Defines the maximum memory, in Megabytes, any cPanel process can use before it is killed off. The input value for this option cannot be less than 128.
nativessl (boolean) (1,0)
Allows native SSL support when possible, negating the need for Stunnel.
nouserbackupwarn (boolean) (1,0)
Users will not be warned about system backup being disabled in cPanel.
remotewhmtimeout (integer) (≥ 35)
Defines the timeout period (in seconds) for connections between the server and remote WHM servers.
resetpass (boolean) (1,0)
Allows cPanel account holders to reset their passwords via email.
rollback (boolean) (1,0)
Enables cPanel software rollback. This feature also turns on a build archiving and restoration package that allows an administrator to rollback a cPanel installation to a previous build. All files will be stored to the server.
skiphttpauth (boolean) (1,0)
Disables HTTP authentication for logging into cPanel, webmail, and WHM, while forcing cookie authentication.
skipparentcheck (boolean) (1,0)
Allows cPanel and admin binaries to run from applications outside the cPanel server ( cpsrvd).
skipmelange (boolean) (1,0)
Prevents the deprecated Melange 1.10 chat server from starting.
skipwhoisns (boolean) (1,0)
Disables whois lookups when accessing the WHM Nameserver IPs feature.
htaccess_check_recurse (integer) (0 - 100)
Defines the maximum number of directories deep to look for .htaccess files when doing .htaccess checks. 2 is the default setting; values higher than 2 are discouraged.
cpaddons_adminemail (boolean) (1,0)
Defines the default administrative contact for cPAddons moderation emails. Resellers will be notified if their contact email is set in cPanel.
cpaddons_max_moderation_req_all_mod (integer) (≥ 0)
Defines the maximum number of moderated requests a user can have at any given time.
cpaddons_max_moderation_req_per_mod (integer) (≥ 0)
Defines the maximum number of moderated requests per add-on a user may have at any given time.
cpaddons_moderation_request (boolean) (1,0)
Activates the pending moderation requests auto-notification system for cPAddons administrators.
cpaddons_no_3rd_party (boolean) (1,0)
Prevents the installation of add-on scripts that have not been provided by cPanel.
cpaddons_no_modified_cpanel (boolean) (1,0)
Prevents the installation of add-on scripts that have to be altered. Turning this feature off while testing custom add-ons may be very useful.
cpaddons_autoupdate (boolean) (1,0)
Keeps all cPAddon source files up to date automatically.
cpaddons_notify_owner (boolean) (1,0)
Automatically updates account holders with cPAddon installations in need of updates.
cpaddons_notify_root (boolean) (1,0)
Allows WHM to automatically notify the cPAddons administrator(s) of cPAddon installations that need to be updated.