Manual Docker Installation

Guide to installing PteroCA using Docker Compose for fast and isolated deployment.

Please note, this project is currently in an early version (0.x.x) and may contain bugs. Use it at your own risk.

Overview

PteroCA can be quickly deployed using Docker Compose, which automates the setup of all required services (web server, database, and optional tools) in isolated containers. This method is ideal for both development and production environments, ensuring consistent configuration and easy management.

---

1. Prerequisites

Before you begin, ensure you have the following installed on your server:

• Docker (with Docker Compose plugin) - Install Docker

• Git - Install Git

---

2. Quick Start

Clone the PteroCA repository and run the initialization script:

git clone https://github.com/PteroCA-Org/panel.git
cd panel
bash docker-init.sh

The script will:

• Check for Docker and Docker Compose installation

• Verify that the Docker daemon is running

• Guide you through environment selection (development or production)

• Configure database credentials and environment variables

• Build and start all required containers

---

3. Environment Selection

During initialization, you will be prompted to choose:

• Development (dev)

  • Runs on port 8000

  • Includes PHPMyAdmin for database management (port 8080)

  • Uses default credentials for easier local testing

• Production (prod)

  • Runs on port 80

  • Generates secure, random database passwords

  • Disables PHPMyAdmin for security

---

4. Configuration Steps

The script will automatically:

• Detect existing database volumes and environment files

• Generate or update the .env configuration file

• Set up database credentials and application secrets

• Build Docker containers for the selected environment

• Start the database and web server, running migrations automatically

• Set proper file permissions for uploads and cache

If your PteroCA instance is running behind Cloudflare, you need to adjust your configuration to avoid CSRF and host validation issues. Please follow the instructions here: Trusted Proxies & Cloudflare Configuration.

---

5. Accessing PteroCA

After installation, you can access the panel at:

• Development: http://localhost:8080

• Production: http://localhost

Database credentials and other important information will be displayed at the end of the installation.

---

6. Managing Containers

Common Docker Compose commands:

# Stop all containers
docker-compose -f docker-compose.yml down

# View logs
docker-compose -f docker-compose.yml logs -f

# Restart containers
docker-compose -f docker-compose.yml restart

Replace docker-compose.yml with docker-compose.prod.yml for production.

---

7. First-Time Configuration

After containers are running, complete the setup using one of two methods:

• Web Wizard: Visit /first-configuration in your browser for a guided setup.

• CLI Wizard: Run the following command inside the web container: docker-compose -f exec web php bin/console pteroca:system:configure (Old command app:configure-system is deprecated but still works until v1.0.0)

---

8. Post-Installation Steps

After completing the Docker installation, configure the following to ensure full functionality:

8.1 Install PteroCA Plugin for Pterodactyl

Required for full integration

The PteroCA Plugin must be installed in your Pterodactyl panel to enable features like:

• Server console access

• Real-time statistics

• Server variable management

• SSO authentication

👉 Install PteroCA Plugin for Pterodactyl

Read more about Pterodactyl Configuration and PteroCA Plugin here.

8.2 Configure Allowed Origins (Console Access)

For the server console to work properly, you need to configure allowed_origins in your Pterodactyl Wings configuration.

This allows PteroCA to communicate with Pterodactyl Wings for console access and real-time server management.

👉 Configure Allowed Origins

You can configure allowed origins at any time - it doesn't need to be done immediately during installation.

8.3 Complete System Configuration

Configure your panel settings through the CLI wizard or Admin Panel:

• General Settings - Site title, logo, locale

• Email Settings - SMTP configuration for notifications

• Payment Settings - Stripe integration for payments

• Pterodactyl Settings - API connection and SSO setup

👉 View all configuration options

---

9. Troubleshooting

If you encounter issues:

• Ensure Docker and Docker Compose are installed and running

• Check that ports 80 or 8000 are not blocked by other services

• Review logs using docker-compose logs -f