Page tree

Versions Compared

Key

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

...

Note
titleNotes:
  • You must log in as the root user in order to use this interface.
  • To create a plugin installation file for the cPanel interface's x3 theme, use WHM's x3 cPanel Plugin File Generator interface (Home >> Development >> x3 Plugin File Generator).
  • For more information, read our Guide to cPanel PluginsPlugin File Generator documentation. 

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).

Image RemovedImage Added

Generate a plugin file

...

  1. Enter the plugin's identifier in the Unique Identifier text box.
    • If the Unique Identifier that you enter already exists, a warning message 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. If you want to add this feature to the list in WHM's Feature ManagercPanel Plugin File Generator (Home >> Packages >> Feature Manager) interface, select the Feature Manager Support option.
  4. Select the group in which the plugin icon will appear from the Group menu. 
    • To create a new group, click the add icon (Image RemovedImage Added). 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. Enter the plugin target in the URI Target text box. 
  8. Click Browse to select an icon file for the plugin.

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


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

  11. 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.


  12. You can download the new plugin installation file from the banner that appears at the top of the interface. This banner will disappear when you start to create a new plugin or navigate away from the interface.

    Note
    titleNote:

    The system saves generated plugin installation files in the /var/cpanel/cpanel_plugin_generator/ directory.


Warning
titleImportant:

After you download the plugin installation file, use the /scripts/install_plugin script to install the plugin to the Paper Lantern theme. For more information, read our Guide to cPanel PluginsPlugin File Generator documentation.