Development Guides Home >> Guide to cPanel Interface Customization and Branding in the Paper Lantern Theme
Guide to cPanel Interface Customization - Appkeys
Note:
- This document only applies to customization in the Paper Lantern theme. The Paper Lantern theme is now deprecated and will be removed. For more information, read our cPanel Deprecation Plan documentation.
- We strongly recommend you make Jupiter the default theme for all cPanel Accounts. To use appkeys in the Jupiter theme, read our Guide to cPanel Interface Customization in the Jupiter Theme documentation.
Introduction
cPanel & WHM uses app_key
values to identify cPanel or Webmail interfaces and their associated assets. To add custom icons to an interface, save your icons with the same app_key
value as the icons that you wish to replace.
-
Save these files in the
/var/cpanel/customizations/styled/mystyle
directory, wheremystyle
represents the name of your custom style. - For more information, read our Custom Icons and Logos documentation.
To use an interface's app_key
value to determine the filenames for UI includes, combine the interface's app_key
value, an underscore (_
), the string page, an underscore (_
), the UI include position (header
or footer
), and the .html.tt
extension.
-
For example, to create a UI include header file for cPanel's
Site Publisher
interface (
cPanel >> Home >> Domains >> Site Publisher
), create the
site_publisher_page_header.html.tt
file in the appropriate directory. -
Use
home
as theapp_key
value for cPanel's Home interface (Home). - For more information, read our UI Includes documentation.
Appkey values
In cPanel & WHM (Glass style only) version 96 and higher
Note: We removed the icons in the Glass style.
Interface | Appkey name |
---|---|
Home | home |
cPanel >> Home >> Files >> File Manager | file_manager |
cPanel >> Home >> Files >> Images | images |
cPanel >> Home >> Files >> Directory Privacy | directory_privacy |
cPanel >> Home >> Files >> Disk Usage | disk_usage |
cPanel >> Home >> Files >> Web Disk | web_disk |
cPanel >> Home >> Files >> FTP Accounts | ftp_accounts |
cPanel >> Home >> Files >> FTP Connections | ftp_connections |
cPanel >> Home >> Files >> Anonymous FTP | anonymous_ftp |
cPanel >> Home >> Files >> Backup | backup |
cPanel >> Home >> Files >> Backup Wizard | backup_wizard |
cPanel >> Home >> Files >> Git™ Version Control | version_control |
cPanel >> Home >> Files >> File and Directory Restoration | file_and_directory_restoration |
cPanel >> Home >> Databases >> phpMyAdmin | php_my_admin |
cPanel >> Home >> Databases >> MySQL® Manager
|
mysql_manager |
cPanel >> Home >> Databases >> MySQL® Databases | mysql_databases |
cPanel >> Home >> Databases >> MySQL® Database Wizard | mysql_database_wizard |
cPanel >> Home >> Databases >> Remote MySQL® | remote_mysql |
cPanel >> Home >> Databases >> PostgreSQL Databases | postgresql_databases |
cPanel >> Home >> Databases >> PostgreSQL Database Wizard | postgresql_database_wizard |
cPanel >> Home >> Databases >> phpPgAdmin | php_pg_admin |
cPanel >> Home >> Domains >> Site Publisher | site_publisher |
cPanel >> Home >> Domains >> Domains | domains |
cPanel >> Home >> Domains >> Addon Domains
|
addon_domains |
cPanel >> Home >> Domains >> Subdomains
|
subdomains |
cPanel >> Home >> Domains >> Aliases
|
aliases |
cPanel >> Home >> Domains >> Redirects | redirects |
cPanel >> Home >> Domains >> Zone Editor | zone_editor |
cPanel >> Home >> Domains >> Dynamic DNS
|
dynamic_dns |
cPanel >> Home >> Email >> Email Accounts | email_accounts |
cPanel >> Home >> Email >> Email Disk Usage | email_disk_usage |
cPanel >> Home >> Email >> Forwarders | forwarders |
cPanel >> Home >> Email >> Email Routing | email_routing |
cPanel >> Home >> Email >> Autoresponders | autoresponders |
cPanel >> Home >> Email >> Default Address | default_address |
cPanel >> Home >> Email >> Mailing Lists | mailing_lists |
cPanel >> Home >> Email >> Track Delivery | track_delivery |
cPanel >> Home >> Email >> Global Email Filters | global_email_filters |
cPanel >> Home >> Email >> Email Filters | email_filters |
cPanel >> Home >> Email >> Email Deliverability | email_deliverability |
cPanel >> Home >> Email >> Address Importer | address_importer |
cPanel >> Home >> Email >> Spam Filters | apache_spam_assassin |
cPanel >> Home >> Email >> Archive | archive |
cPanel >> Home >> Email >> Encryption | encryption |
cPanel >> Home >> Email >> BoxTrapper | boxtrapper |
cPanel >> Home >> Email >> Configure Greylisting | greylisting |
cPanel >> Home >> Email >> Calendars and Contacts | calendar_and_contacts |
cPanel >> Home >> Email >> Calendar Delegation
|
manage_calendar_access |
cPanel >> Home >> Metrics >> Visitors | visitors |
cPanel >> Home >> Metrics >> Errors | errors |
cPanel >> Home >> Metrics >> Bandwidth | bandwidth |
cPanel >> Home >> Metrics >> Raw Access | raw_access |
cPanel >> Home >> Metrics >> Awstats | awstats |
cPanel >> Home >> Metrics >> Analog Stats | analog_stats |
cPanel >> Home >> Metrics >> Webalizer | webalizer |
cPanel >> Home >> Metrics >> Webalizer FTP | webalizer_ftp |
cPanel >> Home >> Metrics >> Metrics Editor | metrics_editor |
cPanel >> Home >> Metrics >> CPU and Concurrent Connection Usage
|
cpu_and_concurrent_connection_usage |
cPanel >> Home >> Security >> SSH Access | ssh_access |
cPanel >> Home >> Security >> IP Blocker | ip_blocker |
cPanel >> Home >> Security >> SSL/TLS | ssl_tls |
cPanel >> Home >> Security >> Manage API Tokens | api_tokens |
cPanel >> Home >> Security >> Hotlink Protection | hotlink_protection |
cPanel >> Home >> Security >> Leech Protection | leech_protection |
cPanel >> Home >> Security >> SSL/TLS Wizard | tls_wizard |
cPanel >> Home >> Security >> Security Policy | security_policy |
cPanel >> Home >> Security >> ModSecurity | mod_security |
cPanel >> Home >> Security >> SSL/TLS Status | tls_status |
cPanel >> Home >> Security >> Two-Factor Authentication | two_factor_authentication |
cPanel >> Home >> Software >> PHP PEAR Packages | php_pear_packages |
cPanel >> Home >> Software >> Perl Modules | perl_modules |
cPanel >> Home >> Software >> RubyGems | ruby_gems |
cPanel >> Home >> Software >> Ruby on Rails | ruby_on_rails |
cPanel >> Home >> Software >> Site Software | site_software |
cPanel >> Home >> Software >> Optimize Website | optimize_website |
cPanel >> Home >> Software >> Application Manager | application_manager |
cPanel >> Home >> Software >> MultiPHP Manager | multiphp_manager |
cPanel >> Home >> Software >> MultiPHP INI Editor | multiphp_ini_editor |
cPanel >> Home >> Advanced >> Terminal | terminal |
cPanel >> Home >> Advanced >> WebHost Manager®
|
web_host_manager |
cPanel >> Home >> Advanced >> Cron Jobs | cron_jobs |
cPanel >> Home >> Advanced >> Track DNS | track_dns |
cPanel >> Home >> Advanced >> Indexes | indexes |
cPanel >> Home >> Advanced >> Error Pages | error_pages |
cPanel >> Home >> Advanced >> Apache Handlers | apache_handlers |
cPanel >> Home >> Advanced >> MIME Types | mime_types |
cPanel >> Home >> Advanced >> Virus Scanner | virus_scanner |
cPanel >> Home >> Advanced >> API Shell | api_shell |
cPanel >> Home >> Preferences >> Password & Security | change_password |
cPanel >> Home >> Preferences >> Change Language | change_language |
cPanel >> Home >> Preferences >> Change Style | change_style |
cPanel >> Home >> Preferences >> Contact Information | contact_information |
cPanel >> Home >> Preferences >> User Manager | user_manager |
cPanel >> Home >> Applications >> WordPress Manager
|
cpanel-wordpress-instance-manager |
Configure Mail Client
|
configure_mail_client |
Search Index
|
solr_search_index |
cPanel & WHM (Basic, Dark, and Light Styles) version 70 and higher
Icon | Interface | Appkey name | Image |
---|---|---|---|
Home | home |
||
file-manager-icon.png |
cPanel >> Home >> Files >> File Manager | file-manager |
![]() |
images-icon.png |
cPanel >> Home >> Files >> Images | images |
![]() |
directory-privacy-icon.png |
cPanel >> Home >> Files >> Directory Privacy | directory-privacy-icon |
![]() |
disk-usage-icon.png |
cPanel >> Home >> Files >> Disk Usage | disk_usage |
![]() |
web-disk-icon.png |
cPanel >> Home >> Files >> Web Disk | web_disk |
![]() |
ftp-accounts-icons.png |
cPanel >> Home >> Files >> FTP Accounts | ftp_accounts |
![]() |
ftp-connections-icons.png |
cPanel >> Home >> Files >> FTP Connections | ftp_connections |
![]() |
anonymous-ftp-icon.png |
cPanel >> Home >> Files >> Anonymous FTP | anonymous_ftp |
![]() |
backup-cpanel-icon.png |
cPanel >> Home >> Files >> Backup | backup |
![]() |
backup-wizard-icon.png |
cPanel >> Home >> Files >> Backup Wizard | backup_wizard |
![]() |
version-control-icon.png |
cPanel >> Home >> Files >> Git Version Control | version_control |
![]() |
file-and-directory-restoration-icon.png |
cPanel >> Home >> Files >> File and Directory Restoration | file_and_directory_restoration |
![]() |
phpmyadmin-icon.png |
cPanel >> Home >> Databases >> phpMyAdmin | php_my_admin |
![]() |
mysql_manager.png |
cPanel >> Home >> Databases >> MySQL® Manager
|
mysql_manager |
![]() |
mysql-databases-icon.png |
cPanel >> Home >> Databases >> MySQL® Databases | mysql_databases |
![]() |
mysql-database-wizard-icon.png |
cPanel >> Home >> Databases >> MySQL® Database Wizard | mysql_database_wizard |
![]() |
remote-mysql-icon.png |
cPanel >> Home >> Databases >> Remote MySQL® | remote_mysql |
![]() |
postgresql-databases-icon.png |
cPanel >> Home >> Databases >> PostgreSQL Databases | postgresql_databases |
![]() |
postgresql-database-wizard-icon.png |
cPanel >> Home >> Databases >> PostgreSQL Database Wizard | postgresql_database_wizard |
![]() |
php-pg-admin-icon.png |
cPanel >> Home >> Databases >> phpPgAdmin | php_pg_admin |
![]() |
site-publisher-icon.png |
cPanel >> Home >> Domains >> Site Publisher | site_publisher |
![]() |
domains-icon-2.png |
cPanel >> Home >> Domains >> Domains | domains |
![]() |
addon-domains-icon.png |
cPanel >> Home >> Domains >> Addon Domains
|
addon_domains |
![]() |
subdomains-icon.png |
cPanel >> Home >> Domains >> Subdomains
|
subdomains |
![]() |
aliases-icon.png |
cPanel >> Home >> Domains >> Aliases
|
aliases |
![]() |
redirects-icon.png |
cPanel >> Home >> Domains >> Redirects | redirects |
![]() |
zone-editor-icon.png |
cPanel >> Home >> Domains >> Zone Editor | zone_editor |
![]() |
dynamicdns-icon-2.png |
cPanel >> Home >> Domains >> Dynamic DNS
|
dynamic_dns |
![]() |
email-accounts-icons.png |
cPanel >> Home >> Email >> Email Accounts | email_accounts |
![]() |
email-disk-usage-icon.png |
cPanel >> Home >> Email >> Email Disk Usage | email_disk_usage |
![]() |
forwarders-icon.png |
cPanel >> Home >> Email >> Forwarders | forwarders |
![]() |
email-routing-icon.png |
cPanel >> Home >> Email >> Email Routing | email_routing |
![]() |
autoresponders-icon.png |
cPanel >> Home >> Email >> Autoresponders | autoresponders |
![]() |
default-address-icons.png |
cPanel >> Home >> Email >> Default Address | default_address |
![]() |
mailing-lists-icons.png |
cPanel >> Home >> Email >> Mailing Lists | mailing_lists |
![]() |
track-delivery-icons.png ) |
cPanel >> Home >> Email >> Track Delivery | track_delivery |
![]() |
global-email-filters.png |
cPanel >> Home >> Email >> Global Email Filters | global_email_filters |
![]() |
email-filters-icons.png |
cPanel >> Home >> Email >> Email Filters | email_filters |
![]() |
email-deliverability-icon.png |
cPanel >> Home >> Email >> Email Deliverability | email_deliverability |
![]() |
address-importer-icon.png |
cPanel >> Home >> Email >> Address Importer | address_importer |
![]() |
spam-filters-icon.png |
cPanel >> Home >> Email >> Spam Filters | apache_spam_assassin |
![]() |
archive-icon.png |
cPanel >> Home >> Email >> Archive | archive |
![]() |
encryption-icon.png |
cPanel >> Home >> Email >> Encryption | encryption |
![]() |
boxtrapper-icon.png |
cPanel >> Home >> Email >> BoxTrapper | boxtrapper |
![]() |
greylisting-icon.png |
cPanel >> Home >> Email >> Configure Greylisting | greylisting |
![]() |
manage_calendar_access.png |
cPanel >> Home >> Email >> Calendar Delegation
|
manage_calendar_access |
![]() |
visitors-icon.png |
cPanel >> Home >> Metrics >> Visitors | visitors |
![]() |
errors-icon.png |
cPanel >> Home >> Metrics >> Errors | errors |
![]() |
bandwidth-icon.png |
cPanel >> Home >> Metrics >> Bandwidth | bandwidth |
![]() |
raw-access-icon.png |
cPanel >> Home >> Metrics >> Raw Access | raw_access |
![]() |
awstats-icon.png |
cPanel >> Home >> Metrics >> Awstats | awstats |
![]() |
analog-stats-icon.png |
cPanel >> Home >> Metrics >> Analog Stats | analog_stats |
![]() |
webalizer-icon.png |
cPanel >> Home >> Metrics >> Webalizer | webalizer |
![]() |
webalizer-ftp-icon.png |
cPanel >> Home >> Metrics >> Webalizer FTP | webalizer_ftp |
![]() |
metrics-editor-icon.png |
cPanel >> Home >> Metrics >> Metrics Editor | metrics_editor |
![]() |
cpu-and-concurrent-connection-usage-icon.png |
cPanel >> Home >> Metrics >> CPU and Concurrent Connection Usage
|
cpu_and_concurrent_connection_usage |
![]() |
ssh-access-icon.png |
cPanel >> Home >> Security >> SSH Access | ssh_access |
![]() |
ip-blocker-icon.png |
cPanel >> Home >> Security >> IP Blocker | ip_blocker |
![]() |
ssl-tls-icon.png |
cPanel >> Home >> Security >> SSL/TLS | ssl_tls |
![]() |
manageapi-icon.png |
cPanel >> Home >> Security >> Manage API Tokens | api_tokens |
![]() |
hotlink-protection-icon.png |
cPanel >> Home >> Security >> Hotlink Protection | hotlink_protection |
![]() |
leech-protection-icon.png |
cPanel >> Home >> Security >> Leech Protection | leech_protection |
![]() |
ssl-tls-wizard-icon.png |
cPanel >> Home >> Security >> SSL/TLS Wizard | tls_wizard |
![]() |
security-policy-icon.png |
cPanel >> Home >> Security >> Security Policy | security_policy |
![]() |
mod-security-icon.png |
cPanel >> Home >> Security >> ModSecurity | modsecurity |
![]() |
ssl-tls-status-icon.png |
cPanel >> Home >> Security >> SSL/TLS Status | tls_status |
![]() |
two-factor-authentication-icon.png |
cPanel >> Home >> Security >> Two-Factor Authentication | two_factor_authentication |
![]() |
php-pear-packages-icon.png |
cPanel >> Home >> Software >> PHP PEAR Packages | php_pear_packages |
![]() |
perl-modules-icon.png |
cPanel >> Home >> Software >> Perl Modules | perl_modules |
![]() |
ruby-gems-icon.png |
cPanel >> Home >> Software >> RubyGems | ruby_gems |
![]() |
ruby-on-rails-icon.png |
cPanel >> Home >> Software >> Ruby on Rails | ruby_on_rails |
![]() |
site-software-icon.png |
cPanel >> Home >> Software >> Site Software | site_software |
![]() |
optimize-website-icon.png |
cPanel >> Home >> Software >> Optimize Website | optimize_website |
![]() |
application-manager-icon.png ) |
cPanel >> Home >> Software >> Application Manager | application_manager |
![]() |
multiphp-manager-icon.png |
cPanel >> Home >> Software >> MultiPHP Manager for cPanel | multiphp_manager |
![]() |
multiphp-ini-editor-icon.png |
cPanel >> Home >> Software >> MultiPHP INI Editor | multiphp_ini_editor |
![]() |
terminal-icon.png |
cPanel >> Home >> Advanced >> Terminal | terminal |
![]() |
web-host-manager-icon.png |
cPanel >> Home >> Advanced >> WebHost Manager®
|
web_host_manager |
![]() |
cron-jobs-icon.png |
cPanel >> Home >> Advanced >> Cron Jobs | cron_jobs |
![]() |
track-dns-icons.png |
cPanel >> Home >> Advanced >> Track DNS | track_dns |
![]() |
indexes-icon.png |
cPanel >> Home >> Advanced >> Indexes | indexes |
![]() |
error-pages-icon.png |
cPanel >> Home >> Advanced >> Error Pages | error_pages |
![]() |
apache-handlers-icon.png |
cPanel >> Home >> Advanced >> Apache Handlers | apache_handlers |
![]() |
mime-types-icon.png |
cPanel >> Home >> Advanced >> MIME Types | mime_types |
![]() |
virus-scanner-icon.png |
cPanel >> Home >> Advanced >> Virus Scanner | virus_scanner |
![]() |
api-shell-icon.png |
cPanel >> Home >> Advanced >> API Shell | api_shell |
![]() |
password-and-security-icon.png |
cPanel >> Home >> Preferences >> Password & Security | change_password |
![]() |
change-language-icon.png |
cPanel >> Home >> Preferences >> Change Language | change_language |
![]() |
change-style-icon.png |
cPanel >> Home >> Preferences >> Change Style | change_style |
![]() |
contact-information-icon.png |
cPanel >> Home >> Preferences >> Contact Information | contact_information |
![]() |
user-manager-icon.png |
cPanel >> Home >> Preferences >> User Manager | user_manager |
![]() |
wordpress-manager-icon.png |
cPanel >> Home >> Applications >> WordPress Manager
|
cpanel-wordpress-instance-manager |
![]() |
Configure Mail Client
|
configure_mail_client |
||
Search Index
|
solr_search_index |