Installation
Set up PteroCA.com, an open-source client area for managing Pterodactyl servers. Follow the steps below to integrate it with your Pterodactyl instance quickly.
Please note, this project is currently in an early version (0.x.x) and may contain bugs. Use it at your own risk.
Automatic Installation
To facilitate a seamless installation of PteroCA, we've developed an automated Bash script that streamlines the setup process. This script is designed to detect your operating system, install necessary dependencies, configure your environment, and deploy the PteroCA panel with minimal user intervention.
1. Execute the installer
2. Automatic Installation Process
The script will guide you through the installation process with interactive prompts: PHP version selection, domain configuration, Pterodactyl API credentials, and email and password for the PteroCA admin account.
Based on your inputs, the script will:
Install Dependencies: Set up necessary repositories and install required packages, including Nginx, PHP and MariaDB.
Configure Services: Set up and secure the database, configure the web server, and ensure all services are running correctly.
Deploy PteroCA: Download the latest version of PteroCA, configure environment settings, and set appropriate file permissions.
Upon successful installation, the script will provide: Access URL, Admin Credentials and Database Credentials.
More about the PteroCA configuration process during installation can be found here.
3. Pterodactyl Plugin Installation
Installing the Pterodactyl plugin is optional, but without it, some PteroCA features will not be available. The PteroCA Plugin for Pterodactyl provides functionalities such as access to the server console, editing server variables directly from the server management panel, SSO Login, and more.
To install the PteroCA Plugin for Pterodactyl, follow these instructions.
Manual Installation
It is beneficial to have some prior knowledge of Linux and MariaDB before starting this installation, as this will help ensure a smoother setup process.
To manually install PteroCA, follow the instructions below.
Dependencies
To install and run PteroCA.com, you'll need to have the following dependencies installed on your system:
PHP and Extensions
PHP 8.2 or higher
Required PHP extensions:
cli, ctype, iconv, mysql, pdo, mbstring, tokenizer, bcmath, xml, curl, zip, intl, fpm(if using NGINX)
Database
MySQL 5.7.22 or higher (MySQL 8 recommended) OR
MariaDB 10.2 or higher
Additional Tools
Git
Composer v2 (Dependency Manager for PHP)
Curl
Tar
Unzip
Example Dependency Installation
Below is an example of how you might install the required dependencies on a Debian or Ubuntu-based system. These commands assume you're using PHP 8.2 and installing MariaDB and NGINX:
Composer
If you already have Composer installed, you can skip this step!
Composer is a powerful dependency manager for PHP. It allows us to handle and install all the necessary libraries and packages that your project needs. Before proceeding, make sure you have Composer installed on your server.
To install Composer globally, run the following command:
This will install Composer globally on your machine, making it accessible from anywhere by running the composer command.
Once installed, verify it by running:
This should print the installed Composer version.
Download Files
The first step to getting PteroCA.com running is to set up the directory where the panel will be installed. You will then clone the repository directly from our GitHub and install required composer dependencies.
Clone repository
Here’s an example of how to create a directory for the panel and navigate into it:
This command will create a new folder at /var/www/pteroca, clone the PteroCA codebase, and place all the necessary files into this directory.
Once the repository is cloned, you're ready to proceed with the setup process.
Set permissions
The final step in the installation process is to set the correct permissions on project files. This ensures that the web server can properly read and write to the necessary directories, such as logs, cache, and file uploads.
Set ownership
You should restrict web server ownership only to the directories that require write access, such as var/ and public/uploads/. This helps to avoid exposing sensitive files to unnecessary access.
This ensures that only the directories requiring write access (var/ and public/uploads/) are owned by the web server user, while the rest of the project remains protected.
Set permissions
Now, set the correct permissions for these directories, allowing the web server to write to them.
This ensures that the web server user can read, write, and execute in these directories, while other users can only read and execute.
Crontab Configuration
To ensure that critical tasks, such as billing users hourly or suspending unpaid servers, are processed correctly, you need to set up a cron job that runs every minute. This cron job will automatically execute the necessary commands for maintaining your Dashboard.
Open Crontab
Run the following command to edit your crontab configuration:
If prompted to select a text editor, choose your preferred option (typically option 1).
Add the Cron Job
Scroll to an empty line without a # at the beginning, then add the following entry:
Save the changes in your editor and close it. The cron job is now active and will run automatically every minute.
Next step
Once the installation is complete, proceed to the Basic Configuration section to set up your PteroCA environment and integrate it with your Pterodactyl panel.
Last updated