v0.6.0

Overview

Overview of PteroCA customization options including settings, plugins, and themes.

You can customize the PteroCA panel in various ways. To do so, expand the Settings menu in the left-hand navigation on your administrator account and select the appropriate tab.

Permission Requirements (v0.6+)

Access to Settings requires specific permissions. By default, only users with the admin role can access and edit all settings. However, you can create custom roles with granular permissions:

  • View-only access: access_settings_* permissions (e.g., access_settings_general)

  • Edit access: edit_settings_* permissions (e.g., edit_settings_payment)

This allows you to create specialized roles like "Support Staff" with read-only access or "Payment Manager" with editing rights only for payment settings.

For more information, see Access Control.

Configuration Settings

PteroCA provides comprehensive configuration options across multiple categories. For detailed documentation of each setting, including field types, default values, CLI configuration, and troubleshooting, see the following guides:

Appearance & Branding

Theme Settings

  • Site logo and favicon

  • Theme selection

  • Light and dark mode colors

  • Dark mode configuration

  • Message of the Day (MOTD) for customer dashboard

Core System Settings

General Settings

  • Site URL, title, and locale

  • Telemetry preferences

  • Automatic deletion of suspended servers

  • PHPMyAdmin integration

Integration Settings

Pterodactyl Settings

  • Pterodactyl Panel URL and API configuration

  • Client panel integration options

  • Single Sign-On (SSO) setup

  • Server activity log integration

Security & Privacy

Security Settings

  • Email verification requirements

  • Google reCAPTCHA configuration

  • Terms of Service content

Payment Processing

Payment Settings

  • Stripe integration and API keys

  • Supported payment methods

  • Currency configuration

  • Internal currency/credits system

Email & Notifications

Email Settings

  • SMTP server configuration

  • Email authentication

  • Server renewal notifications

Extensions

Beyond built-in customization options, PteroCA can be extended through plugins and custom themes.

Plugins

Plugins allow you to add new functionality without modifying the core codebase. Starting with v0.6, PteroCA includes a comprehensive plugin system that enables you to:

  • Add payment providers: Integrate PayPal, Coinbase, Mollie, and other payment gateways

  • Create custom features: Build unique functionality specific to your business needs

  • Add integrations: Connect with external services (Discord, Telegram, webhooks, etc.)

  • Extend the UI: Add dashboard widgets, server tabs, and custom interfaces

  • Automate tasks: Create console commands and scheduled cron jobs

Plugin Management:

  • Install plugins by placing them in the /plugins/ directory

  • Manage plugins through Admin Panel → Plugins

  • Enable/disable plugins with a single click

  • Configure plugin settings in Settings → Plugins

  • Monitor plugin health and security automatically

Security & Health:

  • Automatic security scanning before enabling

  • Health checks every 6 hours

  • Dependency management with semantic versioning

  • Granular permission control for plugin operations

Available Permissions:

  • access_plugins, view_plugin - View plugins

  • enable_plugin, disable_plugin - Enable/disable plugins

  • install_plugin, uninstall_plugin - Install/remove plugins

  • configure_plugin - Configure plugin settings

  • access_settings_plugin, edit_settings_plugin - View/edit plugin settings

For detailed information about using plugins, see Plugins.

For creating your own plugins, see Plugin Development.

Custom Themes

Themes allow you to completely customize the panel's appearance without modifying core files. Create your own theme to:

  • Brand the panel: Add your logo, colors, and style

  • Customize layouts: Change page structure and navigation

  • Override templates: Modify any page or component

  • Style the interface: Add custom CSS for unique designs

  • Enhance UX: Add JavaScript for interactive features

Creating a Theme:

Quick start with the CLI:

This creates a new theme based on the default, which you can then customize:

  • Templates in themes/your-theme/

  • Assets in public/assets/theme/your-theme/

Activating a Theme:

Go to Settings → Appearance → Current theme of the panel, select your theme, and save.

For user-facing theme management, see Themes.

For creating custom themes, see Theme Development.

PreviousLogs & MonitoringNextPlugins

Last updated