Child pages
  • cPanel Plugin File Generator

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 (WHM >> Home >> Development >> cPanel Plugin File Generator)

Table of Contents
maxLevel3
minLevel2
stylenone

Overview

This interface generates a plugin installation file for the cPanel interface's Paper Lantern theme. The installation file automates the plugin installation process and stores the desired configuration for the plugin.

In the cPanel interface, items function as links to particular interfaces (for example, Email Accounts or File Manager). Each item must reside in a group (for example, Files or Databases).

Note
titleNotes:

Generate a plugin file

Warning
titleImportant:

This interface does not validate the input in the Name and URI text boxes. Make certain that anything that you enter cannot adversely affect your server.

To generate a plugin installation file, perform the following steps:

  1. Enter the plugin's unique identifier in the Unique Identifier text box.
    • If the unique identifier that you enter already exists, a warning message and the the Overwrite existing cPanel item checkbox will appear. Only select the Overwrite existing cPanel item checkbox if you wish to overwrite the existing plugin. To keep the existing plugin, you must enter a different Unique Identifier value.
  2. Enter the display name in the Name text box.

  3. Select the Feature Manager Support checkbox if you wish to control access to the plugin via WHM's Feature Manager interface (WHM >> Home >> Features >> Feature Manager).
  4. Select the group in which the plugin icon will appear from the Group menu. To create a new group, click the add icon ( ). Enter the new group name in the  New Group Name  text box. 

  5. Enter a number between 1 and 99 in the Priority text box. A plugin icon with a priority of 1 appears higher than an icon with a priority of 99
  6. Enter the plugin location in the URI text box. 
  7. Click Browse to select an icon file for the plugin.

    Note
    titleNotes:
    • Icon files must use the SVG or PNG format.
    • Paper Lantern icons must be 48x48 pixels. This interface does not resize icon files. As a result, larger images may render incorrectly.


  8. Click Add item to add your new item to the New Plugin Information section of the interface. 
  9. Repeat steps 1 through 7 for all of the items that you wish to include in the plugin installation file.

  10. Enter the plugin's name in the New Plugin Information text box and click Generate to generate the new plugin installation file.

    Note
    titleNotes:
    • The plugin name can only contain lowercase letters, numbers, hyphens (-), and underscores (_).
    • New plugins cannot use the same name as an existing plugin on the server.


To download the new plugin installation file, click the link in the the banner that appears at the top of the interface. The system saves the file in .tar.gz format in the /var/cpanel/cpanel_plugin_generator/ directory.

Note
titleNote:

This banner will disappear when you start to create a new plugin or navigate away from the interface.

After you download the plugin installation file, use the /scripts/install_plugin script to install the plugin to the Paper Lantern theme.

Include Page
LIB:_InstallPluginRoot
LIB:_InstallPluginRoot
 

Additional documentation

Localtab Group


Localtab
activetrue
titleSuggested documentation

Content by Label
showLabelsfalse
max5
showSpacefalse
cqllabel = "cpanelplugins" and label = "whm" and space = currentSpace()


Localtab
titleFor cPanel users

Content by Label
showLabelsfalse
max5
showSpacefalse
cqllabel = "cpanelplugins" and label = "cpanel" and space = currentSpace()


Localtab
titleFor WHM users

Content by Label
showLabelsfalse
max5
showSpacefalse
cqllabel = "cpanelplugins" and label = "whm" and space in (currentSpace(),"CKB")


Localtab
titleFor developers

Content by Label
showLabelsfalse
max5
showSpacefalse
cqllabel = "cpanelplugins" and space = "DD"