Custom Themes

The plugin works out of the box with x3 and Paper Lantern-based themes. However, if you need to use custom themes, these can be supported too.


First, navigate to your theme directory. This will usually be located in /usr/local/cpanel/base/frontend/, e.g.

cd /usr/local/cpanel/base/frontend/mycoolskin

and symlink the plugin directory:

ln -s /usr/local/cpanel/base/frontend/paper_lantern/letsencrypt


You should be able to access the plugin while using the theme now, but it will be fairly unstyled.

In the /usr/local/cpanel/base/frontend/paper_lantern/letsencrypt directory, you will find a number of ‘vendor’ HTML files, e.g.:

vendor_error.html  vendor_reinstall.html  vendor_settings.html                    vendor_theme_x3_header.html
vendor_home.html   vendor_remove.html     vendor_theme_paper_lantern_header.html  vendor_view.html
vendor_issue.html  vendor_result.html     vendor_theme_x3_footer.html

To modify the header, for example, you will need to copy vendor_theme_paper_lantern_header.html to custom_theme_{name}_header.html, e.g. custom_theme_mycoolskin_header.html.

The custom_theme_ files will be used if they exist, instead of the vendor_ files.

In most cases you will only need to apply customisation to the header and optionally the footer templates.

Please Note

Do not modify the ‘vendor’ files! Changes will be reverted in plugin upgrades.