Guide 3

Install an addon

An addon is a folder. Copy it in, hand it to the web server, clear the cache. There is no core file to edit, no route to register, no frontend build and no licence key.

Install it

The example below is PlayerManager. Every addon works the same way, only the folder name changes.

  1. Copy the folder into app/Addons

    Unpack the download on the server, then move it into the panel. The folder keeps the name the archive gives it.

    shell
    cd /var/www/pterodactyl
mkdir -p app/Addons
cp -r ~/PlayerManager app/Addons/PlayerManager

    Check the result before you go on. This path has to exist, with the addon folder named exactly as it was unpacked:

    shell
    ls app/Addons/PlayerManager/Addon.php

  2. Give it to the web server user

    The panel reads the addon as the user nginx runs PHP under. On a stock install that is www-data.

    shell
    chown -R www-data:www-data app/Addons

  3. Clear the cache

    The panel caches its routes, config and views. Clear them and the addon is picked up.

    shell
    php artisan optimize:clear

  4. Check the theme manager

    Go to /admin/settings/theme in the admin area and open Addons. The addon is listed under Installed and it is already switched on. The toggle is there so you can switch it off, not so you can switch it on.

What you get afterwards

The addon adds its own pages to the client area for every server it applies to. Its settings sit under its own name in Addons, and they are stored in the panel database, not in the files you just copied. An addon that falls behind is flagged in the same admin overview box that tracks the theme.

The Addons section of the NectraUI theme manager, listing installed addons with a switch and a version beside each one
Addons in the theme manager. Everything the panel found is listed, each already switched on.

Folder names

Each archive unpacks to one of these. Keep the name.

  • FileManagerFile Manager
  • MinecraftVersionsMinecraft Version Manager
  • EggChangerEgg Changer
  • MinecraftPluginsPlugin Installer
  • MinecraftModsMod Installer
  • MinecraftModpacksModpack Installer
  • BedrockAddonsBedrock Addon Installer
  • BedrockConfigBedrock Config Editor
  • PlayerManagerPlayer Manager
  • SubdomainManagerSubdomain Manager
  • ServerImporterServer Importer
  • AdminRolesPermission Management
  • AdminLogsAdmin Logs
  • CommandHistoryCommand History
NextMake it look like the demo