Pterodactyl

https://pterodactyl.io/project/introduction.html
Admin
Pterodactyl is an open-source game server management panel built with PHP, React, and Go, designed...
Tokens:2,630
Snippets:20
Trust Score:9.8
Update:11 months ago
Show doc for...
Tokens:
Raw
### Install Pterodactyl Panel Dependencies and Generate Key

Source: https://pterodactyl.io/project/introduction.html/panel/1.0/getting_started

This command sequence installs core dependencies using Composer and generates a new application encryption key. The `COMPOSER_ALLOW_SUPERUSER=1` flag is used to allow Composer to run as root if necessary. The `key:generate --force` command should only be run on a fresh installation.

```bash
cp .env.example .env
COMPOSER_ALLOW_SUPERUSER=1 composer install --no-dev --optimize-autoloader

# Only run the command below if you are installing this Panel for
# the first time and do not have any Pterodactyl Panel data in the database.
php artisan key:generate --force
```

--------------------------------

### Migrate Database and Seed Pterodactyl Panel

Source: https://pterodactyl.io/project/introduction.html/panel/1.0/getting_started

This command performs the database migrations and seeds the database with initial data, including Nests and Eggs, essential for the Pterodactyl Panel's functionality. This process can take a significant amount of time and should not be interrupted.

```bash
php artisan migrate --seed --force
```

--------------------------------

### Configure Pterodactyl Panel Environment

Source: https://pterodactyl.io/project/introduction.html/panel/1.0/getting_started

These artisan commands configure the Pterodactyl Panel's core environment settings, including database credentials, mail sending (SMTP or PHP mail), and other essential configurations. Run these commands sequentially to set up your panel's environment.

```bash
php artisan p:environment:setup
php artisan p:environment:database

# To use PHP's internal mail sending (not recommended), select "mail". To use a
# custom SMTP server, select "smtp".
php artisan p:environment:mail
```

--------------------------------

### Configure Pterodactyl Queue Listener Cronjob

Source: https://pterodactyl.io/project/introduction.html/panel/1.0/getting_started

This command sets up a cron job that runs every minute to process scheduled tasks for the Pterodactyl Panel, such as session cleanup and sending tasks to daemons. Add this line to your crontab using `sudo crontab -e`.

```bash
* * * * * php /var/www/pterodactyl/artisan schedule:run >> /dev/null 2>&1
```

--------------------------------

### Create Pterodactyl Panel Administrative User

Source: https://pterodactyl.io/project/introduction.html/panel/1.0/getting_started

This command creates the first administrative user for the Pterodactyl Panel. The password must meet specific requirements: at least 8 characters, mixed case, and contain at least one number.

```bash
php artisan p:user:make
```

--------------------------------

### Create Pterodactyl Queue Worker Systemd Service

Source: https://pterodactyl.io/project/introduction.html/panel/1.0/getting_started

This is the content for a systemd service file named `pteroq.service` used to manage the Pterodactyl queue worker process. This service ensures background tasks like email sending are handled efficiently. Place this file in `/etc/systemd/system/`.

```systemd
# Pterodactyl Queue Worker File
# ----------------------------------

[Unit]
Description=Pterodactyl Queue Worker
After=redis-server.service

[Service]
# On some systems the user and group might be different.

```

--------------------------------

### Create Pterodactyl Database and User

Source: https://pterodactyl.io/project/introduction.html/panel/1.0/getting_started

This snippet shows how to create a dedicated user and database for the Pterodactyl Panel in MariaDB or MySQL. It includes granting all privileges to the user on the 'panel' database. Ensure you replace 'yourPassword' with a strong, unique password.

```sql
CREATE USER 'pterodactyl'@'127.0.0.1' IDENTIFIED BY 'yourPassword';
CREATE DATABASE panel;
GRANT ALL PRIVILEGES ON panel.* TO 'pterodactyl'@'127.0.0.1' WITH GRANT OPTION;
exit
```

--------------------------------

### Set Pterodactyl Panel File Permissions

Source: https://pterodactyl.io/project/introduction.html/panel/1.0/getting_started

These commands set the correct file ownership for the Pterodactyl Panel directory, ensuring the webserver has the necessary permissions to access and modify files. The specific command depends on your webserver (NGINX/Apache) and Linux distribution (Debian/RHEL-based).

```bash
# If using NGINX, Apache or Caddy (not on RHEL / Rocky Linux / AlmaLinux)
chown -R www-data:www-data /var/www/pterodactyl/*

# If using NGINX on RHEL / Rocky Linux / AlmaLinux
chown -R nginx:nginx /var/www/pterodactyl/*

# If using Apache on RHEL / Rocky Linux / AlmaLinux
chown -R apache:apache /var/www/pterodactyl/*
```

--------------------------------

### Retrieve Pterodactyl Panel Encryption Key

Source: https://pterodactyl.io/project/introduction.html/panel/1.0/getting_started

This command retrieves the application encryption key (APP_KEY) from the Pterodactyl Panel's .env file. This key is crucial for encrypting sensitive data like API keys and must be stored securely. Losing this key makes encrypted data irrecoverable.

```bash
grep APP_KEY /var/www/pterodactyl/.env
```
Tokens:
Raw