Guide to Site Publisher Templates

Introduction

You can create your own custom templates for cPanel's Site Publisher feature.

Create a template

To create an Site Publisher template, perform the following steps:

  1. Create your template's meta.json file.
  2. Create your template files.
  3. Create a preview image for your template. You must save this image as the preview.png file.
  4. Store the template in the appropriate directory on your cPanel & WHM server:
    • Store templates that the root user owns within a template-specific directory in the /var/cpanel/customizations/site_templates/ directory.
    • Store templates that a reseller owns within a template-specific directory in the/home/username/var/cpanel/reseller/site_templates/ directory, where username represents the reseller's username.

      Note:

      cPanel-provided templates exist in the /usr/local/cpanel/etc/site_templates/ directory. However, we do not recommend that you store additional templates in this directory.

Site Publisher websites

When users publish Site Publisher websites via cPanel's  Site Publisher interface (Home >> Domains >> Site Publisher), the system generates the appropriate website files, and stores them in the target domain's home directory.

Note:

When users publish a Site Publisher website, the system logs template information and the target directory to the/usr/local/cpanel/logs/error_log file.

Each Site Publisher website uses the following assets:

  • The configuration file.
  • Template-specific license files, if the template includes a license.
  • Template-specific generated website files, which may include HTML files, images, fonts, JavaScript files, CGI files, and related subdirectories for these assets.

The system does not publish the template's README files or Template Toolkit files.

  • 15 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....