Installation

Set up PteroCA, the open-source client area for managing Pterodactyl servers. You can install it automatically, via Docker, or manually - depending on your preferred workflow and environment.

🧭 Overview

PteroCA can be installed using three main methods, depending on your use case and level of control required:

Method
Description
Recommended For

Automatic Installation

Installs and configures everything automatically using a Bash script β€” including dependencies, web server, PHP, and database.

Most users and VPS setups

Docker Installation

Deploys PteroCA inside Docker containers for a clean, isolated environment. Offers both Automatic and Manual setup modes.

Developers and production servers

Manual Installation

A fully manual setup where you install dependencies, web server, and PHP environment yourself.

Advanced users who want full control


βš™οΈ Installation Options

Quick and easy - just one command. The installer automatically detects your OS, installs dependencies, configures your environment, and deploys the PteroCA panel.

Optionally, it can also install Pterodactyl Panel in the same run - including default node setup, API key generation, and full integration with PteroCA.

πŸ‘‰ Read the guide β†’


2. 🐳 Docker Installation

Run PteroCA inside Docker containers for a consistent, portable, and secure environment. This is the preferred choice for modern deployments and includes two available paths:

Type
Description

Automatic Docker Installation

Installs Docker, clones the PteroCA repository, builds containers, and starts the environment automatically β€” ideal for quick VPS or production setups.

Manual Docker Installation

Gives you full control using provided Docker Compose files. Recommended for advanced users or CI/CD pipelines.

πŸ‘‰ Explore Docker Installation β†’


3. Manual Installation

Perform the installation step-by-step without automation. This method is ideal for advanced users who prefer to configure the web server, PHP, and database manually, or integrate PteroCA into an existing infrastructure.

πŸ‘‰ View Manual Installation β†’


πŸ“˜ Choosing the Right Method

Your Goal
Recommended Method

Quick setup on a new VPS

Automatic Installation

Isolated environment using containers

Automatic Docker Installation

Custom or multi-container CI/CD deployment

Manual Docker Installation

Full manual control over configuration

Manual Installation


πŸš€ Next Steps

circle-info

Important: Required Post-Installation Steps

After installation, two steps are required for PteroCA to work fully (console, statistics, user/server creation):

  1. Install PteroCA Plugin for Pterodactyl β€” extends Pterodactyl with PteroCA API endpoints

  2. Configure Allowed Origins β€” enables WebSocket/console access from PteroCA

Once installed, continue with:


Getting Help with Installation

If you encounter issues during installation:

  1. Check installation-specific guides:

  2. Get real-time support:

  3. Helpful information to provide:

    • Your installation method (automatic/docker/manual)

    • Operating system and version

    • Error messages from installation logs

Last updated