Automatic Installation
Guide to installing PteroCA using an automated Bash script that downloads and configures all required components.
Please note, this project is currently in an early version (0.x.x) and may contain bugs. Use it at your own risk.
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.
Video Guide
1. Execute the installer
bash -c "$(wget -qO- https://pteroca.com/installer.sh)"1.1 Using Installer with Custom Parameters
If you prefer to run the installer manually or automate deployments (e.g. with Ansible, CI/CD, or VPS provisioning scripts), the Bash script supports advanced flags that allow full control over the installation process.
2. Automatic Installation Process
The script will guide you through the installation process, allowing you to choose between two configuration methods:
Web Wizard – A user-friendly web-based setup wizard that simplifies the configuration process.
CLI Wizard – A fully interactive command-line setup for users who prefer a terminal-based approach.
Both methods will prompt you to enter essential details, including PHP version selection, domain configuration, Pterodactyl API credentials, and admin account credentials for PteroCA.
Example installation process workflow with Web Wizard
Run the installer:
root@test:~# bash -c "$(wget -qO- https://pteroca.com/installer.sh)"
Starting PteroCA installation...
Detected OS: ubuntu 22.04 (jammy)
Available PHP versions:
1. PHP 8.2
2. PHP 8.3
3. PHP 8.4
Select PHP version [1-3]: 1
Selected PHP version: 8.2
Basic Configuration
Enter your domain (e.g., panel.example.com): test.pteroca.com
Adding PHP repository... [...]
Adding MariaDB repository... [...]
Updating package manager... [...]
Installing dependencies... [...]
Installing Composer... [...]
Configuring services... [...]
Running mysql_secure_installation... [...]
Setting up database... [...]
Setting up PteroCA application... [...]
Cloning PteroCA repository... [...]
Installing Composer dependencies... [...]
Creating environment configuration... [...]
Verifying database connection... [...]
Executing PteroCA Database Migrations... [...]
Configuring PHP-FPM... [...]
Looking for PHP-FPM configuration... [...]
Configuring NGINX... [...]
Setting up SSL certificate... [...]
Setting up CRON jobs... [...]
Configuring PteroCA application... [...]
Select the initial configuration method:
1) Web Wizard (recommended)
2) CLI
Enter your choice [1-2]: 1
Web Wizard selected. Please complete the configuration via the web interface.
Open your browser and navigate to: https://test.pteroca.com/first-configuration}
Performing final checks...
PteroCA installation completed successfully!
Installation Summary:
Domain: test.pteroca.com
PHP Version: 8.2
OS: ubuntu 22.04
Panel URL: https://test.pteroca.com
Database Credentials:
Database Name: pteroca
Database User: pteroca
Database Password: [database password]
Database Host: localhost
MySQL Root Password: [mysql root password]
Credential Files:
MySQL Root Password: /root/.pteroca_mysql
Environment File: /var/www/pteroca/.env
Next Steps: Complete the Initial Configuration
The installation is complete, but you still need to configure your PteroCA instance.
To finalize the setup, please visit the Web Wizard and follow the instructions:
Open your browser and go to: https://test.pteroca.com/first-configuration
Important:
1. Save these credentials in a secure location
2. Configure your firewall to allow ports 80 and 443 (if needed)
Thank you for installing PteroCA!Navigate to
[yourdomain]/first-configurationin your browser. Select your preferred language and click "Start" to begin the setup process.
Welcome page of web wizard Follow the guided steps to complete the configuration, providing details such as site settings, Pterodactyl API credentials, email configuration, and the credentials for the first admin account. If you encounter any issues filling in the required information, refer to the Basic Configuration guide for assistance.
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.
3. Pterodactyl Plugin Installation
Read more about Pterodactyl Configuration and PteroCA Plugin for Pterodactyl here.
Installing the Pterodactyl plugin is recommended, and 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.
Last updated