add or change email icon to go to a dedicated email server

Dylan McKinstry

• May 28, 2025 00:49

how to create a thrid party icon for mailcow/email server branded speedy turtle online in the whm/cpanel web server before the migrations for email over to the new system?

Issue:
We created a valid AppConfig plugin to display a custom icon in cPanel (Jupiter theme) linking to our external Mailcow server — but the icon does not appear anywhere in the UI.

---

✅ What We've Done:

1. Created config file:

   swift

   CopyEdit

   /var/cpanel/apps/speedyturtle_email.conf
   ini

   CopyEdit

   displayname=Speedy Turtle Online Email service=cpanel url=/cgi/speedyturtle/index.live.php icon=https://speedyturtleonline.com/images/icon.png category=tools group=tools target=_blank

2. Created redirect file:

   swift

   CopyEdit

   /usr/local/cpanel/base/frontend/jupiter/speedyturtle/index.live.php
   php

   CopyEdit

   <?php header("Location: https://mail.speedyturtleonline.net"); exit; ?>

3. Set correct ownership/permissions:

   • .conf file: root:root 644

   • .php file: root:root 755

4. Ran:

   bash

   CopyEdit

   /usr/local/cpanel/bin/rebuild_sprites /scripts/update_featurelists /scripts/restartsrv_cpsrvd

5. Assigned plugin to all feature lists using:

   bash

   CopyEdit

   whmapi1 featurelist_add_feature featurelist='default' feature=speedyturtle_email

6. Tried multiple categories: email, files, and tools.

7. Confirmed plugin loads manually via:

   bash

   CopyEdit

   https://hostname:2083/cpsess.../cgi/speedyturtle/index.live.php

---

❌ Problem:

Despite all of the above, the plugin does not show up under Email, Applications, Tools, or any section in the Jupiter cPanel theme.

---

🔧 Environment Notes:

• Using Jupiter theme

• Imunify360 is installed

• No CloudLinux LVE restrictions confirmed

• File paths and configs follow cPanel plugin standards

---

Please advise what might be blocking the plugin display, or whether Jupiter requires additional registration for custom /var/cpanel/apps/*.conf entries.

• 

  cPRex Jurassic Moderator

  • May 28, 2025 16:25

  Hey there!  For a custom plugin I'd recommend working through the guide here:

  https://api.docs.cpanel.net/guides/guide-to-cpanel-plugins/

  specifically this area since you want to change the UI

  https://api.docs.cpanel.net/guides/guide-to-cpanel-plugins/guide-to-cpanel-plugins-the-dynamicui-files/

  I'm not able to debug a plugin issue like this through the Forum so it would be best to create a ticket if that isn't working as expected, as we'd likely need to see this on your machine.

  0
• 

  cPRex Jurassic Moderator

  • May 28, 2025 16:32
  • Edited

  It's also worth noting that "icon" has to point to a file on the server, but you're using a full HREF link, so that also isn't going to work as intended. 

  One of our developers provided this example in case that would be helpful, as you'll find the working icon, meta.json, and install.json files there:

  https://github.com/Troglodyne-Internet-Widgets/cpanel-liveapi-example-plugin

  0

Please sign in to leave a comment.