PteroCA Pterodactyl Addon

PteroCA Pterodactyl Addon is a plugin designed to integrate Pterodactyl with the PteroCA panel.

1. Overview

The PteroCA Pterodactyl Addon is the official plugin for the PteroCA project, providing direct and seamless integration between the Pterodactyl game server management panel and the PteroCA client & billing panel.

This addon is required for PteroCA to function properly. Without it, the panel will not be able to communicate with your Pterodactyl installation, and core features such as server synchronization, Single Sign-On (SSO), and automated resource management will not work.

---

2. Key Features

Installing the addon unlocks full integration between PteroCA and Pterodactyl, including:

• Full Server Management from PteroCA Access server consoles, start/stop/restart servers, monitor live CPU, RAM, and disk usage, and manage startup variables without leaving PteroCA.

• Automatic Account & Server Synchronization When a user or server is created in PteroCA, it is automatically created and linked in Pterodactyl — and vice versa.

• Single Sign-On (SSO) Users can open their Pterodactyl panel directly from PteroCA without re-entering credentials (if SSO is enabled in settings).

• Extended API Capabilities Adds API endpoints that PteroCA needs for package assignments, resource updates, server variable management, and automated deployments.

• Unified User Experience Eliminates the need for users to manually switch between separate panels to manage their services.

---

3. Requirements

Before installing the addon, make sure your environment meets the following requirements:

• Pterodactyl Panel: v1.11.0 or later

• PteroCA Panel: Matching the addon version

• Server Requirements:

  • PHP 8.1+

  • Composer installed

• Access: File system access to your Pterodactyl panel installation and ability to run artisan commands

---

4. Installation

1. Navigate to Pterodactyl’s root directory

   cd /var/www/pterodactyl

2. Install the addon via Composer

   composer require pteroca-com/pterodactyl-addon

   This plugin is essential as it enables the creation of Client API Keys through the API interface — something not possible in a standard Pterodactyl installation. These keys are required for proper server management in PteroCA.

3. Clear and rebuild cache

   php artisan optimize:clear

   (Optional but recommended after installation or update)

---

5. Updating the Addon

1. Navigate to your Pterodactyl root directory:

   cd /var/www/pterodactyl

2. Update the package:

   composer update pteroca-com/pterodactyl-addon

3. Clear cache:

   php artisan optimize:clear

---

6. Troubleshooting

Problem	Possible Cause	Solution
Cannot log in to PteroCA	Addon not installed	Install the addon and recreate the user using the create:new-user CLI command
SSO not working	SSO not enabled in PteroCA	Enable it in Settings → Pterodactyl Integration in PteroCA, and make sure the API token is configured in your Pterodactyl .env file.
Servers not visible in PteroCA	Wrong API URL or key	Double-check settings in PteroCA
Addon errors after update	Version mismatch	Verify installed version

---

7. Source Code

The addon is fully open-source and available at: https://github.com/pteroca-com/pterodactyl-addon

---

8. Need help?

If you experience any issues or need assistance with installation, join our Discord community — we’re happy to help: Join to Discord!