Skip to main content
Version: 2.0.2

Modules

Modules extend the OpenPanel UI by adding new features and pages. To make a feature available to a user or plan, it must first be activated as a module.

openadmin_modules_settings

  • Modules are core features that are already available on installation and are developed by OpenPanel.
  • Plugins are custom features that need to be installed and are developed by third-party developers.

Available Modules:

Notifications

The notifications module is required to send email notifications to users.

When enabled:

  • Emails are sent according to each user’s notification preferences.
  • Users can manage their preferences through the OpenPanel UI at: Accounts > Email Notifications.

When disabled:

  • No emails will be sent, regardless of user preferences.

Customize email notifications:

Account

The account module is required for users to change their email, password or username.

When enabled:

  • Users can change their email, password and username through the OpenPanel UI at: Accounts > Settings.

When disabled:

  • Users can not change their passwords from OpenPanel UI, only from 'Password Reset' on login form, if this option is enabled.

Customize password and username changes:

Sessions

The sessions module allows users to view and manage their active sessions.

When enabled:

  • Users can view all their active sessions, logs and terminate any session through the OpenPanel UI at: Accounts > Active Sessions.

When disabled:

  • Users can not access the Accounts > Active Sessions page.

Customize sessions duration:

Locale

The locale (Languages) module allows users to change panel language.

When enabled:

When disabled:

  • Users can not access the Accounts > Change Language page to change their locale.
  • Users are forced to the Admin defined default locale.

Customize locales:

Favorites

The favorites module allows users to pin items in their sidebar menu for quick navigation.

When enabled:

  • Users can add pages to favorites with left-click on ⭐ icon in top-right corner of the page.
  • Users can remove pages from favorites with right-click on ⭐ icon in top-right corner of the page.
  • Users can access favorites from sidebar menu.
  • Users can access the Accounts > Favorites page.

When disabled:

  • Users can not access the Accounts > Favorites page to manage favorites.
  • Users are not see favorites in the sidebar nor the ⭐ icon in top-right corner of pages.

Customize favorites:

  • To control the total number of favorites for user (default is 10) use favorites-items config.
  • To edit user's favorites from terminal edit their: /etc/openpanel/openpanel/core/users/{current_username}/favorites.json file.

Varnish

The varnish module allows users to control varnish caching for their domains.

When enabled:

  • Varnish server starts for user and proxies traffic back to their webserver.
  • Users can access the Caching > Varnish page.
  • Users can enable/disable Varnish service.
  • Users can enable/disable Varnish caching per domain.
  • Users can view logs for the Varnish service.

When disabled:

  • Users do not have access to the Caching > Varnish page.
  • Varnish is used only if Administrator enabled it for user when creating the account.

Customize options:

Docker

The docker module allows users to manage and add new docker containers.

When enabled:

When disabled:

  • Users can not access any of the Docker pages.

The web terminal, changing a service's image tag, and switching the webserver/MySQL type each live behind their own module below rather than docker - see Web Terminal, Change Container Image Tag, Switch WebServer, and Switch MySQL Type.

Web Terminal

The terminal module allows users to run docker exec commands from an interactive shell inside their containers.

When enabled:

When disabled:

  • Users do not have access to the Terminal page.

Customize options:

Change Container Image Tag

The change_image module allows users to change the image tag used by a container.

When enabled:

When disabled:

  • Users do not have access to the Change Image Tag page.

Switch WebServer

The change_ws module allows users to switch the webserver used for their account.

When enabled:

When disabled:

  • Users do not have access to the Switch Web Server page.

Switch MySQL Type

The change_db module allows users to switch between MySQL and MariaDB for their account.

When enabled:

When disabled:

  • Users do not have access to the Switch MySQL Type page.

Fix Permissions

The fix_permissions module allows users to reset file/folder permissions.

When enabled:

When disabled:

  • Users can not access the Files > Fix Permissions page.

FTP

The ftp module allows users to create and manage FTP sub-accounts.

When enabled:

When disabled:

  • Users can not create and manage FTP accounts.

Customize options:

Emails

The emails module allows users to create and manage Email accounts.

When enabled:

  • Users can access the Emails pages to manage Email accounts.

When disabled:

  • Users can not create and manage Email accounts.

Customize options:

Webmail

The webmail module allows users to auto-login to Roundcube webmail for their Email accounts.

When enabled:

  • Users can access the Webmail button.

When disabled:

  • Users can not auto-login to webmail.

Customize options:

Email Filters

The email_filters module allows users to configure filters and forwarders for their emails.

When enabled:

When disabled:

  • Users can not access the Email Filters page.

Email Aliases

The email_aliases module allows users to forwards mail from a non-existing address to one or more destinations.

When enabled:

When disabled:

  • Users can not access the Email Aliases page.

Address Importer

The email_import module allows users to import email addresses from a CSV file.

When enabled:

When disabled:

  • Users can not access the Address Importer page.

Address Exporter

The email_export module allows users to export to CSV file all their email addresses.

When enabled:

  • Users can export email addresses by visiting: /emails/export

When disabled:

  • Users can not access the Address Exporter page.

Default Address

The email_default module allows users to create default (catch-all) email addresses.

When enabled:

When disabled:

  • Users can not access the Default Email Address page.

Email Deliverability

The email_deliverability module allows users to check and validate SPF, DKIM and DMARC records for their domains.

When enabled:

When disabled:

  • Users can not access the Email Deliverability page.

MySQL

The mysql module allows users to create and manage mysql databases.

When enabled:

When disabled:

  • Users do not have access to the MySQL section.

Customize options:

How-to guides:

MySQL Root Password

The mysql_root_password module allows users to change password for their MySQL root user from the user panel.

When enabled:

When disabled:

  • Users do not have access to the MySQL Root Password page.

MySQL Show Processes

The mysql_processlist module allows users to view the MySQL process list.

When enabled:

When disabled:

  • Users do not have access to the MySQL Process List page.

Remote MySQL

The remote_mysql module allows users to enable/disable remote access to mysql.

When enabled:

  • Remote access is disabled by default.
  • Random port is allocated per user for their mysql instances.
  • Users can access the MySQL > Remote Access page to enable/disable remote access.
  • Users can connect to any database from remote location once the option is enabled.

When disabled:

  • Remote access is disabled.

Customize options:

  • None

phpMyAdmin

The phpmyadmin module allows users to manage phpMyAdmin service.

When enabled:

  • phpMyAdmin can be accessed by the user.
  • phpMyAdmin is available on a https://DOMAIN:2053 when domain is set, or http://IP:8888 when IP is set for panel access.

When disabled:

  • Users do not have access to the phpMyAdmin service.

Customize options:

How-to guides:

MySQL Import

The mysql_import module allows users to import files into their databases.

When enabled:

When disabled:

  • Users can not access the MySQL > Import Database page.

Customize options:

How-to guides:

MySQL Conf

The mysql_conf module allows users to edit mysql server configuration.

When enabled:

When disabled:

  • Users can not access the MySQL > Edit Configuration page.

Customize options:

PostgreSQL

The postgresql module allows users to create and manage PostgreSQL databases and users.

When enabled:

  • Users can access the PostgreSQL section.

When disabled:

  • Users do not have access to the PostgreSQL section.

Remote PostgreSQL

The remote_postgresql module allows users to enable/disable remote access to PostgreSQL.

When enabled:

  • Remote access is disabled by default.
  • Random port is allocated per user for their PostgreSQL instances.
  • Users can access the PostgreSQL > Remote Access page to enable/disable remote access.
  • Users can connect to any database from remote location once the option is enabled.

When disabled:

  • Remote access is disabled.

Customize options:

  • None

pgAdmin

The pgadmin module allows users to manage pgAdmin service.

When enabled:

  • pgAdmin can be managed by the user.
  • Users have access to the pgAdmin section.
  • pgAdmin is available on a custom per-user port.

When disabled:

  • Users do not have access to the pgAdmin section.

Customize options:

  • To change default CPU/RAM for pgAdmin use the 'manage' button in top-rgiht corner.

PostgreSQL Import

The postgresql_import module allows users to import files into their databases.

When enabled:

When disabled:

  • Users can not access the PostgreSQL > Import Database page.

Customize options:

  • None

PostgreSQL Conf

The postgresql_conf module allows users to edit PostgreSQL server configuration.

When enabled:

When disabled:

  • Users can not access the PostgreSQL > Edit Configuration page.

Crons

The crons module allows users to schedule Ofelia cron jobs.

When enabled:

When disabled:

  • Users can not access the Advanced > Cron Jobs page nor modify crons.

Customize options:

  • To pre-set cronjobs for new users edit the /etc/openpanel/ofelia/users.ini file.
  • To set max file size for the cron file to be editable via OpenPanel UI set the cron_max_file_size_kb value.

Process Manager

The process_manager module allows users to view and terminate processes from all running services.

When enabled:

When disabled:

  • Users can not access the Advanced > Process Manager page.

Customize options:

  • None

Server Info

The info module allows users to view server information, hosting plan information and OpenPanel information.

When enabled:

When disabled:

  • Users can not access the Advanced > Server Information page.

Customize options:

  • None

The temporary_links module allows users to test their websites using temporary subdomains (links are valid for 15 minutes).

When enabled:

When disabled:

  • Users can not access the Live Preview button on the Site Manager page.

Customize options:

Login History

The login_history module allows users to view login history for their account.

When enabled:

When disabled:

  • Users can not access the Account > Login History page.

Customize options:

2FA

The twofa module allows users to enable 2 factor authentication for their account.

When enabled:

When disabled:

  • Users can not access the Advanced > Two-Factor Authentication page nor manage 2FA.

Customize options:

Passkeys

The passkeys module allows users to seup Passkeys for their account.

NOTE: Passkeys require that a domain name is used for panel access.

When enabled:

When disabled:

  • Users can not login using Passkeys.

Activity

The activity module allows users to view their activity logs.

When enabled:

When disabled:

  • Users can not access the Account > Activity Log page.

Customize options:

  • To edit activity log from terminal open file: /etc/openpanel/openpanel/core/users/{username}/activity.log.
  • To set total number of lines per user edit activity_lines_retention setting.
  • To set total size of log per user edit activity_max_size_bytes setting.
  • To log actions from 3rd-party plugin refer to: How to log actions from Custom Plugins in user Activity Log

Backups

The backups module allows users to configure their own backups: what to backup, destination, retention, schedule, etc.

When enabled:

  • Users can access the Files > Backups page.
  • Users can configure backup schedule, encryption, retention and destination.

When disabled:

Backup Wizard

The backup_wizard module allows users to generate and download a full account backup.

When enabled:

  • Users can access the Backup Wizard to generate and download a full backup of their account.

When disabled:

  • Users can not access the Backup Wizard.

Services

The services module allows users to enable/disable services without the Docker module.

When enabled:

  • Users can access the Advanced > Services page.
  • Users can enable/disable services.
  • User view current service status, resource usage (CPU%, Memory%, Disk I/O, PIDs..), container name (to be used to connect to service from other containers).
  • Users can view logs for services.

When disabled:

  • Users do not have access to the Advanced > Services page.

Memcached

The memcached module allows users to enable/disable Memcached service.

When enabled:

  • Users can access the Caching > Memcached page.
  • Users can enable/disable Memcached service.
  • User can connect to the instance from other containers using: elasticsearch:11211
  • Users can view logs for the Memcached service.

When disabled:

  • Users do not have access to the Caching > Memcached page.

Redis

The redis module allows users to enable/disable Redis service.

When enabled:

  • Users can access the Caching > Redis page.
  • Users can enable/disable Redis service.
  • User can connect to the instance from other containers using: redis:6379
  • Users can view logs for the Redis service.

When disabled:

  • Users do not have access to the Caching > Redis page.

Valkey

The valkey module allows users to enable/disable Valkey service.

When enabled:

  • Users can access the Caching > Valkey page.
  • Users can enable/disable Valkey service.
  • User can connect to the instance from other containers using: valkey:6379
  • Users can view logs for the Valkey service.

When disabled:

  • Users do not have access to the Caching > Valkey page.

ElasticSearch

The elasticsearch module allows users to enable/disable ElasticSearch service.

When enabled:

  • Users can access the Caching > ElasticSearch page.
  • Users can enable/disable ElasticSearch service.
  • User can connect to the instance from other containers using: elasticsearch:9200
  • Users can view logs for the ElasticSearch service.

When disabled:

  • Users do not have access to the Caching > ElasticSearch page.

OpenSearch

The opensearch module allows users to enable/disable OpenSearch service.

When enabled:

  • Users can access the Caching > OpenSearch page.
  • Users can enable/disable OpenSearch service.
  • User can connect to the instance from other containers using: opensearch:9200
  • Users can view logs for the OpenSearch service.

When disabled:

  • Users do not have access to the Caching > OpenSearch page.

Disk Usage Explorer

The disk_usage module allows users to view disk usage per-directory.

When enabled:

When disabled:

  • Users do not have access to the Files > Disk Usage page.

Inodes Explorer

The inodes module allows users to view inode usage per-directory.

When enabled:

When disabled:

  • Users do not have access to the Files > Inodes Explorer page.

AutoInstaller

The autoinstaller module allows users to autoinstall WordPress, website Builder, Mautic, Python/NodeJS applications, etc.

When enabled:

When disabled:

  • Users do not have access to the Websites > Auto Installer page.

PHP.INI Editor

The php_ini module allows users to edit the PNP.INI files using a text editor.

When enabled:

When disabled:

  • Users do not have access to the PHP > PHP.INI Editor page.

WordPress

The wordpress module allows users to install and manage WordPress websites.

When enabled:

When disabled:

  • Users can not access the Websites > WP Manager page.
  • WordPress is not available in Autoinstaller.
  • WordPress websites can not be managed via Openpanel.

Customize options:

  • To auto install themes or plugins on new installations refer to: WordPress Themes and Plugins Sets
  • To add a custom Google PageSpeed Insights API Key refer to: How-to Guides > Google PageSpeed Insights API Key
  • To setup a mu-plugin on all new websites edit /etc/openpanel/wordpress/mu-plugin.php file.
  • To set a custom WP-CLI for all websites replace the /etc/openpanel/wordpress/wp-cli.phar file.
  • To customize .htaccess files used for new websites edit files in /etc/openpanel/wordpress/htaccess/ folder.

Website Builder

The website_builder module allows users to create simple websites using the HTML Drag & Drop Website Builder.

When enabled:

When disabled:

  • Users can not access the Websites > Website Builder page.
  • Website Builder is not available in Autoinstaller.
  • Static websites can not be managed via Openpanel.

ClamAV

The malware_scan module starts a ClamAV service and allows users to scan files.

NOTE: This module is tagged BETA.

When enabled:

When disabled:

  • Users can not access the Files > Malware Scanner page.
  • ClamAV service is not started on the server.

Customize options:

Files

The filemanager module allows users to manage files and folders using the File Manager.

When enabled:

When disabled:

  • Users can not access the Files > File Manager page.
  • No links to manage files are shown on other pages.

Trash

The trash module allows users to manage their Trash folder.

When enabled:

  • Users can access the Files > Trash page.
  • User can delete to trash instead of permanently deleting files.

When disabled:

  • Users can not access the Files > Trash page.

Domains

The domains module allows users to add and manage domains.

When enabled:

  • Users can access the Domains page.
  • Users can manage domains.
  • Users can access the 'Domains' sub-pages in the menu.

When disabled:

  • Users can not access the Domains page.
  • Users can not manage domains.

Customize options:

SSL

The ssl module allows users to view SSL configuration for their domains and add custom certificates.

When enabled:

When disabled:

  • Users can not access the Domains > SSL page.

Suspend Domains

The domain_suspend module allows users to suspend/unsuspend website access.

When enabled:

When disabled:

  • Users can not suspend/unsuspend domains.

Customize options:

Raw Access Logs

The domain_logs module allows users to view the raw access log for their domains.

When enabled:

When disabled:

  • Users can not access the Domains > Raw Access Logs page.

GoAccess

The goaccess module runs the GoAccess service on a scheduled basis to process raw domain logs and produce HTML reports accessible through the OpenPanel UI.

When enabled:

When disabled:

  • Users can not access the Domains > GoAccess page.

Customize options:

Docroot

The docroot module allows users to set a custom docroot (folder) when adding domains, and later change the path.

When enabled:

When disabled:

  • Users can not set a custom docroot when adding a domaina, and can not later change the docroot.

Redirects

The redirects module allows users to create redirects for domains.

When enabled:

When disabled:

  • Users can not access the Domains > Redirects page.

Capitalize Domains

The capitalize_domains module allows users to set a capitalized version fo the domain for dispaly in the OpenPanel.

When enabled:

When disabled:

  • Users can not access the Domains > Capitalize Domains page.

Edit VirtualHosts

The edit_vhost module allows users to edit the VirtualHosts files for their domains.

When enabled:

When disabled:

  • Users can not access the Domains > Edit VHosts File page.

Customize options:

Webserver

The webserver_conf module allows users to edit the main configuration files for their webservers.

When enabled:

  • Users can access the Advanced > WebServer Settings page.
  • Users can edit the httpd.conf file for Apache.
  • Users can edit the nginx.conf file for Nginx/OpenResty.
  • Users can edit the openlitespeed.conf file for OpenLiteSpeed.

When disabled:

  • Users can not access the Advanced > WebServer Settings page.

Customize options:

  • To customize the default httpd.conf file for Apache edit /etc/openpanel/apache/httpd.conf file.
  • To customize the default nginx.conf file for Nginx edit /etc/openpanel/nginx/nginx.conf file.
  • To customize the default openlitespeed.conf file for OpenLiteSpeed edit /etc/openpanel/openlitespeed/httpd_config.conf file.
  • To customize the default nginx.conf file for OpenResty edit /etc/openpanel/openresty/nginx.conf file.

DNS

The dns module runs a local BIND9 service, creates zone files for domains and allows users to manage DNS records.

When enabled:

When disabled:

  • Users can not access the Domains > DNS Zone Editor page.
  • Administrators can not access the DNS Zone Editor, Edit Zone Templates, and DNS Cluster pages in OpenAdmin.

Customize options:

Dynamic DNS

The dynamic_dns module allows users to create subdomains that will be updated via webhooks.

When enabled:

When disabled:

  • Users can not access the Domains > Dynamic DNS page.

IP Blocker

The ip_blocker module allows users to block IP addresses from accessing their websites.

When enabled:

When disabled:

  • Users can not access the Advanced > IP Blocker page.

WAF

The waf module runs a custom Caddy image with CorazaWAF and allows users to manage WAF rules and on/off protection per domain.

When enabled:

When disabled:

  • SecRuleEngine Off is set for new domains.
  • SecRuleEngine On is replaced with SecRuleEngine Off for all existing domains.
  • Users can not access the Advanced > WAF page.
  • 'Firewall' widget is not displayed in Site Manager.

Customize options:

PHP

The php module allows users to manage PHP versions and settings.

When enabled:

When disabled:

  • Users can not access the Select PHP Version, Default Version, Options, Extensions pages.
  • Users can not set PHP version per domain, set default version for new domains, edit options and view installed extensions.

Customize options:

PHP Options

The php_options module allows users to manage options (limits) for their PHP versions.

When enabled:

When disabled:

  • Users can not access the PHP Options page.

Customize options:

  • To customize PHP options available to users refer to: OpenAdmin > Settings > PHP Settings > Available Options or edit /etc/openpanel/php/options.txt file.

PHP Extensions

NOTE: This module is tagged BETA.

The php_extensions module allows users to manage extensions for their PHP versions.

When enabled:

When disabled:

  • Users can not access the PHP > Extensions page.

NodeJS

The nodejs module allows users to setup and manage containerized NodeJS applications. It is toggled independently from the Python module below.

When enabled:

When disabled:

  • NodeJS is not available on the Autoinstaller page.
  • NodeJS applications can not be managed via Openpanel.

Customize options:

  • To customize docker service template for new Node.JS applications edit /etc/openpanel/docker/compose/nodejs.yml file.
  • To customize headers for Nginx proxy of new NodeJS applications edit /etc/openpanel/nginx/vhosts/1.1/nginx_proxy_headers.txt file.
  • To add a custom Google PageSpeed Insights API Key refer to: How-to Guides > Google PageSpeed Insights API Key

Python

The python module allows users to setup and manage containerized Python applications. It is toggled independently from the NodeJS module above.

When enabled:

When disabled:

  • Python is not available on the Autoinstaller page.
  • Python applications can not be managed via Openpanel.

Customize options:

  • To customize docker service template for new Python applications edit /etc/openpanel/docker/compose/python.yml file.
  • To customize headers for Nginx proxy of new Python applications edit /etc/openpanel/nginx/vhosts/1.1/nginx_proxy_headers.txt file.
  • To add a custom Google PageSpeed Insights API Key refer to: How-to Guides > Google PageSpeed Insights API Key

Resources Usage

The usage module allows users to view resource usage for their services.

When enabled:

When disabled:

  • Users can not access the Advanced > Resource Usage page.

Customize options:

API

The api module allows users to access the OpenPanel API using JWT tokens.

When enabled:

When disabled:

  • Users can not use the OpenPanel API.

MCP

The mcp module allows users to use the Model Context Protocol (MCP) to perform panel actions.

When enabled:

When disabled:

  • Users can not access the Account > MCP page.