OpenPanel Documentation

website·Indexed 33 days ago

https://openpanel.com/

Documentation for OpenPanel and its administrator interface, OpenAdmin. Covers server management tasks including user and reseller administration, DNS zone editing, email account management, backup systems, and security features such as Coraza WAF, Sentinel Firewall, 2FA, and Passkeys. Includes guides on resource usage monitoring, process management, and importing accounts from cPanel and CyberPanel.

Tokens
235.6K
Snippets
1.6K
Records
2.4K
Agent score
69%

What's inside OpenPanel

  1. Overview of available caching options in OpenPanel

    OpenPanel provides several caching and performance tools:

    • Redis/Valkey: Persistent object cache backends storing data in RAM to accelerate database and website queries. Valkey is a drop-in replacement for Redis.
    • Memcached: In-memory object cache specifically for reducing database load; recommended for use with PHP OPcache rather than Redis.
    • Elasticsearch/OpenSearch: Powerful search and analytics engines for efficient information retrieval and log analytics.
    • Varnish: A reverse caching proxy and HTTP accelerator for dynamic websites and APIs.
    • OPcache: Caches precompiled PHP script code in shared memory to reduce CPU load. This is enabled by default for PHP.
  2. Enable and use the Login History module

    The login_history module allows users to track and view the login history for their account. When this module is enabled, users can access their history via the Security > Login History page. If the module is disabled, access to the login history page is restricted.
  3. Manage PHP versions and settings with the PHP module

    The php module in OpenPanel enables users to manage PHP configurations. When enabled, users can set the PHP version per domain, define the default version for new domains, edit PHP options, and view installed extensions via the PHP Version per Domain, Default Version, and Extensions pages. If the module is disabled, these management pages and capabilities are inaccessible.
  4. Manage system services using the services module

    The services module enables users to manage system services without requiring the Docker module. When this module is enabled, users gain access to the Processes & Services > Services page, allowing them to enable or disable services, view real-time service status (including CPU%, Memory%, Disk I/O, and PIDs), identify container names for inter-container connectivity, and view service logs. If the module is disabled, access to the Advanced > Services page is revoked.
  5. Manage user favorites with the Favorites module

    The favorites module enables users to pin pages to their sidebar menu for quick navigation.

    User Interactions:

    • Add to favorites: Left-click the ⭐ icon in the top-right corner of a page.
    • Remove from favorites: Right-click the ⭐ icon in the top-right corner of a page.
    • Access: Favorites are available in the sidebar menu and via the Account > Favorites page.

    When Disabled:

    • The ⭐ icon is hidden from pages.
    • Favorites are removed from the sidebar.
    • The Account > Favorites management page becomes inaccessible.
  6. Manage website access with the domain_suspend module

    The domain_suspend module controls whether users have the ability to suspend or unsuspend website access. When this module is enabled, users gain access to the 'Suspend a Domain' and 'Unsuspend a Domain' pages within the panel. If disabled, these actions are unavailable to users.
  7. Manage PrestaShop websites with the PrestaShop module

    The prestashop module enables the installation and management of PrestaShop websites within Openpanel.

    When the module is enabled, users gain the following capabilities:

    • Installation: PrestaShop appears on the Autoinstaller page for automated deployment.
    • Site Management: Through the Site Manager, users can clone PrestaShop sites and perform backup runs or restorations.
    • Updates: The Update tab monitors for newer PrestaShop versions and provides direct links to the site's admin panel to execute updates.

    If the module is disabled, PrestaShop is removed from the Autoinstaller, and existing PrestaShop websites cannot be managed via Openpanel.

  8. Manage a PHP application and Composer dependencies

    PHP applications are managed via the Site Manager (/sites). Management is split into four tabs:

    • Overview: Displays docroot, current PHP version, and the initial project source.
    • Composer: Allows running composer install or composer update (both with --no-interaction), toggling the --optimize-autoloader flag, and editing the composer.json file via the File Manager.
    • Logs: Provides a timestamped history of all Composer runs.
    • Remove: Deletes the application from Site Manager and clears .env settings, but preserves docroot files and databases.
  9. Enable and use the MySQL Import module

    The mysql_import module provides users with the ability to import files into their databases. When this module is enabled, users can access the MySQL > Import page to perform database imports. If the module is disabled, access to the MySQL > Import Database page is restricted.
  10. Monitor and manage system services and containers

    The Service Status section provides a centralized table to view and control the status of system processes and Docker containers on the server. The table includes the following details:

    • Service: Display name.
    • Status: Indicates if the service is active (running) or inactive.
    • Real Name: Internal service or container name (e.g., admin for OpenAdmin).
    • Type: Identifies the service as either a system process or a docker container.
    • Monitoring: Indicates if the service is actively being monitored and logged.
    • Action: Provides controls to start, stop, or restart the service individually.
  11. Manage Joomla websites using the OpenPanel Joomla module

    The joomla module enables the installation and management of Joomla websites within OpenPanel.

    When the module is enabled:

    • Joomla appears as an option on the Autoinstaller page for new installations.
    • The Site Manager allows users to clone Joomla sites and perform backup/restore operations.
    • The Update tab notifies users of available Joomla version updates and provides a direct link to the Joomla Admin panel to perform the update (since Joomla does not support a safe unattended CLI updater).

    When the module is disabled, Joomla is removed from the Autoinstaller and existing Joomla websites cannot be managed via OpenPanel.

  12. Manage domain redirects with the Redirects module

    The redirects module enables the ability to create and manage redirects for domains. When this module is enabled, users gain access to the Domains > Redirects management page. If the module is disabled, access to the Redirects page is restricted.