Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
litespeed_wiki:cpanel:cpanel-plugin-custom-template [2018/07/09 18:41]
Michael Alegre [cPanel Plugin - Using A Custom Template]
litespeed_wiki:cpanel:cpanel-plugin-custom-template [2018/07/09 19:12] (current)
Lisa Clarke Proofreading
Line 4: Line 4:
  
 ===== Preparing A Custom Template ===== ===== Preparing A Custom Template =====
-Preparing and using a custom template for the LiteSpeed Web Cache Manager plugin for cPanel is an easy process ​if you choose to do so. Simply navigate to ''/​usr/​local/​cpanel/​base/​frontend/​paper_lantern/​ls_web_cache_manager/​landing''​ and create a directory named for your custom template, such as ''​myCustomTemplate''​.+Preparing and using a custom template for the LiteSpeed Web Cache Manager plugin for cPanel is an easy process. Simply navigate to ''/​usr/​local/​cpanel/​base/​frontend/​paper_lantern/​ls_web_cache_manager/​landing''​ and create a directory named for your custom template, such as ''​myCustomTemplate''​.
  
-Now that you have created the template directory, you can either copy the existing index.php file under ''/​usr/​local/​cpanel/​base/​frontend/​paper_lantern/​ls_web_cache_manager/​landing/​default''​ into this directory to get started or copy over your own version from elsewhere. This file will handle calling any custom code or files you need to mange and display the new landing page while still having relative access to all the existing classes, functions, and pages already built into the plugin.+Once you have created the template directory, you can either copy the existing ​''​index.php'' ​file under ''/​usr/​local/​cpanel/​base/​frontend/​paper_lantern/​ls_web_cache_manager/​landing/​default''​ into this directory to get startedor copy over your own version from elsewhere. This file will handle calling any custom code or files you need to manage. It will display the new landing page while still having relative access to all the existing classes, functions, and pages already built into the plugin.
  
-**Note:** It is strongly recommended that all custom template code is backed up at different location to prevent possible ​lose during uninstall or upgrade ​of the LiteSpeed Web Cache Manager plugin. As such, we also recommend using a symlink in place of these files in the actual plugin location.+**Note:** It is strongly recommended that all custom template code be backed up at different location to prevent possible ​loss of the LiteSpeed Web Cache Manager plugin ​during uninstall or upgrade. As such, we also recommend using a symlink in place of these files in the actual plugin location.
  
 ===== Setting A Custom Template ===== ===== Setting A Custom Template =====
Line 16: Line 16:
 {{ :​litespeed_wiki:​cpanel:​whm-v3.1.0-main-cpanel-plugin-settings.png?​nolink |}} {{ :​litespeed_wiki:​cpanel:​whm-v3.1.0-main-cpanel-plugin-settings.png?​nolink |}}
  
-You should now be on the **cPanel Plugin Settings** page which will display ​an **Use Custom Template** setting field.+You should now be on the **cPanel Plugin Settings** page which will display ​**Use Custom Template** setting field.
  
 {{ :​litespeed_wiki:​cpanel:​whm-v3.1.0-cpanel-plugin-settings.png?​nolink |}} {{ :​litespeed_wiki:​cpanel:​whm-v3.1.0-cpanel-plugin-settings.png?​nolink |}}
  
-Here you can set a custom template to be used if it has already been created. Using the example from the previous section, we would enter ''​myCustomTemplate''​ here and save.  If the template folder exists and contains the required index.php file, the save operation should succeed ​and all cPanel users should ​now see your custom landing page when accessing the LiteSpeed Web Cache Manager plugin through the cPanel dashboard.+Here you can set a custom template to be used if it has already been created. Using the example from the previous section, we would enter ''​myCustomTemplate''​ here and save.  If the template folder exists and contains the required ​''​index.php'' ​file, the save operation should succeed. From now on, all cPanel users should see your custom landing page when accessing the LiteSpeed Web Cache Manager plugin through the cPanel dashboard.
    
 
litespeed_wiki/cpanel/cpanel-plugin-custom-template.txt · Last modified: 2018/07/09 19:12 by Lisa Clarke