How to Utilise the “cPanel Plugin File Generator” in WHM

February 21, 2024 / cPanel & WHM

This tutorial explains how to utilise the cPanel Plugin File Generator in WHM. Plugins allow you to integrate your applications or third-party sites with the cPanel interface by adding links. The cPanel interface’s theme generates a plugin installation file for this purpose. This file automates the plugin installation process and stores the necessary plugin settings as an a.tar.gz file in the /var/cpanel/cpanel_plugin_generator/ directory.

Let us follow the simple steps:

  1. Log in to WHM.
  2. Click on the “cPanel Plugin File Generator” under “Development” section.
  3. You will head towards a new page consisting of a form. Fill out the details as mentioned below-
    1. Unique Identifier- Enter the “Unique Identifier”. You may utilise letters, numbers, hyphens (-), and underscores (_).
    2. Name- Enter the name.
    3. Feature Manager Support- Tick the check box.
      cPanel plugin file generator
    4. Group- Choose the group using the drop-down menu.
    5. Priority- Enter the priority. It must be between 1-99. Use a positive integer.
    6. URI- Input the plugin’s location into the URI text box.
    7. URI Target- Input the URI target.
    8. Icon- Add the icon file using the “Browse” button. It must be in SVG or PNG format and the required size must be 48px by 48px.
    9. Lastly, click on the “Add item” button.
  4. If you need to add another item to the plugin installation file, repeat the steps. This will apply to all items.
  5. In the “New Plugin Information” text box, enter the plugin’s name and click “Generate” to create the new plugin installation file.
  6. Click the link in the banner at the top of the screen to obtain the updated plugin installation file. The file will be saved in the /var/cpanel/cpanel_plugin_generator/ directory in .tar.gz format.
  7. Afterward, download the plugin installation file and use the following script to install the plugin to the Paper Lantern theme-
    # /usr/local/cpanel/scripts/install_plugin

This concludes our article. If still encounter any query, contact our support staff at any difficult moment.

Spread the love