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.

• 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:

• To set default preferences for new users edit the /etc/openpanel/skeleton/notifications.yaml file.
• To customize email templates refer to Customizing OpenPanel Email Templates.
• To configure custom SMTP use OpenAdmin > Settings > Notifications page.

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:

• To enable or disable password reset on login forms edit 'Enable password reset on login' setting from OpenAdmin > Settings > OpenPanel.
• To prevent users from changing their username edit 'Allow users to change username' setting from OpenAdmin > Settings > OpenPanel.

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:

• To control session duration edit 'Session duration' setting from OpenAdmin > Settings > OpenPanel.
• To control session lifetime edit 'Session lifetime' setting from OpenAdmin > Settings > OpenPanel.

Locale​

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

When enabled:

• Users can change their preferred language for OpenPanel UI from the login page and Accounts > Change Language page.

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:

• To set the default locale use OpenAdmin > Settings > Locales.
• To install new locales for users use the OpenAdmin > Settings > Locales.
• To create a new translation please see How to Create a New Locale

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:

• To enable/disable Varnish for all new users use OpenAdmin > Settings > User Defaults page and Enable Varnish Proxy option.
• To enable/disable Varnish for a single user when creating their account use the Enable Varnish Cache option.
• To change default CPU/RAM for service use the OpenAdmin > Settings > User Defaults page.
• To edit the default.vcl file for Varnish use the OpenAdmin > Domains > Edit Domain Templates page or edit file: /etc/openpanel/varnish/default.vcl.
• To purge Varnish cache refer to How-to Guides > Purging Varnish Cache
• To check if Varnish is enabled for domain refer to How to check if Varnish Caching is enabled for a domain in OpenPanel?

Docker​

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

When enabled:

• Users can access Docker > Containers page to view and manage services.
• Users can access Docker > Containers > New page to add new services.
• Users can access Docker > Terminal page to run docker exec commands.
• Users can access Docker > Image Updates page to check for available image updates.
• Users can access Docker > Logs page to view service logs.
• Users can access Docker > Change Image Tag page to change images tag.
• Users can access Docker > Switch Web Server page to switch webservers.
• Users can access Docker > Switch MySQL Type page to switch mysql/mariadb.

When disabled:

• Users can not access any of the Docker pages.

Customize options:

• None

FTP​

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

When enabled:

• Users can access the Files > FTP page to manage FTP accounts.

When disabled:

• Users can not create and manage FTP accounts.

Customize options:

• To configure FTP server refer to *How-to Guides > Setup FTP.
• To edit VSFTPD configuration edit the /etc/openpanel/ftp/vsftpd.conf file.
• To view all ftp accounts on a server use the OpenAdmin > Services > FTP page.
• To limit number of ftp accounts per user edit the ftp accounts limit when creating/editing hosting packages.

Emails​

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

When enabled:

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

When disabled:

• Users can not create and manage Email accounts.

Customize options:

• To configure email server refer to *How-to Guides > Configure Email Server.
• To configure email client refer to *How-to Guides > How to setup your email client.
• To view all email accounts on a server use the OpenAdmin > Emails > Email Accounts page.
• To set webmail domain or relay hosts use the OpenAdmin > Emails > Email Settings page.
• To set up fail2ban refer to *How-to Guides > Setup Fail2ban.
• To set up Rspamd refer to *How-to Guides > RSPAMD GUI.
• To set up DKIM for a domain refer to *How-to Guides > Setup DKIM.
• To limit number of email accounts per user edit the email accounts limit when creating/editing hosting packages.

MySQL​

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

When enabled:

• MySQL/MariaDB auto-starts when user accesses Databases section, opens phpMyAdmin or installs WordPress.
• Users can access the MySQL > Databases page to manage databases.
• Users can access the MySQL > New Database page to create databases.
• Users can access the MySQL > Database Wizard page to create database, user and assign privileges.
• Users can access the MySQL > Root Password page to change root user password.
• Users can access the MySQL > Process List page to view all active processes.
• Users can access the MySQL > Users page to manage users.
• Users can access the MySQL > New User page to create users.
• Users can access the MySQL > Change Password page to change password for a user.
• Users can access the MySQL > Assign User to DB page to assign all privileges to user over a database.
• Users can access the MySQL > Remove User from DB page to revoke all privileges to user over a database.

When disabled:

• Users do not have access to the MySQL section.

Customize options:

• To set mysql or mariadb for all new users use OpenAdmin > Settings > User Defaults page and MySQL type option.
• To set mysql, percona or mariadb for a single user when creating their account use the MySQL Type option.
• To change default CPU/RAM for service use the OpenAdmin > Settings > User Defaults page.

How-to guides:

• To connect to a database refer to *How-to Guides > Connecting to MySQL Server from Applications in OpenPanel.
• To troubleshoot errors refer to *How-to Guides > How to troubleshoot: Error establishing a database connection.

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

MySQL Import​

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

When enabled:

• Users can access the MySQL > Import Database page to import files into a database.

When disabled:

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

Customize options:

• None

How-to guides:

• To import into a database refer to *How-to Guides > Importing a Database.

MySQL Conf​

The mysql_conf module allows users to edit mysql server configuration.

When enabled:

• Users can access the MySQL > Edit Configuration page to edit service .cnf file.

When disabled:

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

Customize options:

• To set available options for configuration edit file: /etc/openpanel/mysql/keys.txt.
• To edit the mysql.cnf file for a single user edit file: /home/${username}/custom.cnf.
• To edit the mysql.cnf file for all new users edit file: /etc/openpanel/mysql/user.cnf.

Process Manager​

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

When enabled:

• Users can access the Advanced > Process Manager page.

When disabled:

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

Customize options:

• None

2FA​

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

When enabled:

• Users can access the Account > Two-Factor Authentication page.

When disabled:

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

Customize options:

• To enable 2FA widget use OpenAdmin > Settings > OpenPanel page and Display 2FA widget option.
• To check 2FA status for a user refer to How to check if 2FA is active for OpenPanel user account?.

Activity​

The activity module allows users to view their activity logs.

When enabled:

• Users can access the Account > Activity Log page.

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