Modules ​
Modules is where optional functionality is installed, updated, and removed. It is a top-level area of its own, reached from Modules in the sidebar.
Overview ​
URL: /admin/modules
Each module is a card showing what it is and its current state. From the card you install it, update it when a newer version is available, or remove it.
An installed module that has a page of its own in the admin panel shows Manage, which opens that page. Since panel 1.9.2, PHPMyAdmin has no Manage: phpMyAdmin is the customers' database tool, with no settings page in the admin panel, and administrators open the server's databases in Adminer.
The modules available on a standard installation include CPGuard, Metrics, Watchdog, Terminal, Softaculous, JetBackup, Acronis Backup, Imunify360, ImunifyAV, FileManager, LocalApi, PHPMyAdmin, Adminer, and Git Version Control. Which ones you see depends on your licence and on what the server supports.
Imunify360, ImunifyAV, and CPGuard are security modules, and only one of the three can be active on a server: uninstall the one you have before you install another. Since panel 1.9.0 each installer names the module that blocks it.
Updating modules ​
Since panel 1.9.4, a panel update upgrades AdminBolt's own software only: the panel, bolt-agent, and AdminBolt's own tools such as Metrics, Watchdog, Terminal, FileManager, LocalApi, and Git Version Control. Applications someone else writes are never upgraded by a panel update, also when AdminBolt packages them. That covers Roundcube, phpMyAdmin, Adminer, Softaculous, and the CPGuard client plugin, as well as vendor software such as Imunify360, ImunifyAV, cPGuard, JetBackup, CloudLinux, LiteSpeed, and PostgreSQL. They are upgraded in one of three ways:
- from their own module page, under Updates,
- from the Updates tab of Modules,
- by the automatic updates of the modules.
The Updates tab ​
Modules has four tabs: All modules, Installed, Not installed, and Updates. The Updates tab carries the number of modules with something to install, and lists only those modules. Each card shows a badge and, when there is one, the newer version:
| Badge | Meaning |
|---|---|
| Update available | A newer version is in the repository. |
| Update required | The panel needs a newer version of this module to keep its features working. Upgrade it. |
| Upgrade steps to run | The version is current, but a change to AdminBolt's integration with the module is still to be applied. |
| Upgrade step failed | Such a step failed; the module's page shows which one. |
Upgrade on a card upgrades that module after a confirmation. It is offered only when there is something to install. When every installed module is current, the tab reads "Every installed module is up to date."
At the top of the tab, Automatic updates shows whether the modules the panel does not update are upgraded on their own, On or Off, with Turn on or Turn off. While they are on, those modules are upgraded every night at 05:30 and after each panel update that completed. Upgrade all upgrades every listed module to its newest version, one after another, in the background, after a confirmation; their services may be briefly restarted. The card shows "The modules are being upgraded." until the run is done. A panel update cannot start while the modules are being upgraded, and the modules are not upgraded while a panel update runs.
On a new server the automatic updates of the modules are on. A server updated to 1.9.4 starts with the same choice as the Automatic updates switch of the Components tab on System Updates.
When an automatic update fails to upgrade a module, the module keeps its old version and the Module update failed system notification is sent, naming the module. Open the module from the Updates tab for its log and upgrade it again.
On a module's page ​
The module's page has an Updates section. It says how the module is updated: "Updated together with the panel by System Updates." for AdminBolt's own modules, or "Updated from this page or by the automatic updates of the modules, never by a panel update." It shows the installed Version, the Newest version when there is a newer one, and whether Automatic updates are on, with Change leading to the Updates tab. Check for updates asks the repository again.
- When the panel needs a newer version, Update required says which version it needs.
- For software its vendor updates itself, the section says "Its vendor updates this software; the panel does not install versions of it."
- Upgrade steps lists the integration changes that belong to the module, each Done, Done with a warning, Failed, Running, or Pending. Apply runs the pending ones without a new version.
Installing a module changes the sidebar ​
A module that has screens of its own adds them to the Settings area once it is installed, and takes them away when it is removed: Watchdog, JetBackup, and Softaculous appear under Settings > Tools, and CloudLinux's LVE Manager under Settings > CloudLinux. LiteSpeed and OpenLiteSpeed are the exception: they are tabs of Web Server in the sidebar. Since panel 1.9.3, Acronis Backup adds Backups > Acronis; see Acronis Backup module. Since panel 1.9.2, each tab appears once its module is installed, or while that engine is the web server, and Manage on a module links to a Web Server tab only when that tab applies on this server. No module creates a top-level group of its own.
This is why the Settings area is not identical on two servers: the thirteen sidebar groups are always there, and the Settings sections grow with what is installed.
Acronis Backup module ​
Since panel 1.9.3, the Acronis Backup module backs the whole server up into Acronis Cyber Protect Cloud. Installing it installs the bolt-acronis package and adds:
- Backups > Acronis in the sidebar, where you connect the server to Acronis, enroll it, and recover from its backups,
- the Acronis Backup history field on hosting plans and resellers, and the Acronis Backup feature in feature lists.
Installing the module does not install the Acronis agent and does not connect to Acronis: both happen on the Acronis Backup page. When a newer bolt-acronis is available, the module card and the page's Updates tab offer it.
Removing the module removes its pages from the panel, but leaves the server enrolled: the Acronis agent keeps running, the protection plan keeps backing the server up, and nothing stored in Acronis is deleted. To take the server out of Acronis, use Uninstall the agent on the Settings tab of the Acronis Backup page before you remove the module.
Installation runs in the background ​
Installing or removing a module is a long-running operation on the server. It runs in the background, so you can leave the page while it works. Progress and the outcome are recorded in Logs under Executions.
When an install fails ​
Since panel 1.9.3, a module install that fails on the server says why. The cause is in the notification, in the failed step of the install's Provision Log, and in the execution in Logs, where the server's own output is kept. This covers LiteSpeed Enterprise, OpenLiteSpeed, the LSAPI Engine, and Phusion Passenger, which before 1.9.3 could fail with a generic message. The server operations behind the service installs on Health > Manage services also keep their cause in the execution log.
When the install needs a package that no enabled package repository provides, the message names it, for example: "No enabled package repository provides the package lsphp83. Enable the repository that provides it, or check that the server can reach its package repositories, then try the installation again." Enable a repository that provides it, or check the server's connection to its repositories, then install again.
Installing LiteSpeed, the LSAPI Engine, or Phusion Passenger ​
Since panel 1.9.0, installing LiteSpeed, the LSAPI Engine (mod_proxy_lsapi), or Phusion Passenger from Modules leaves PHP running on the existing Apache domains until you switch web servers. Domains that could not be prepared are listed in a warning, with a copy in the notification bell. Repair them from the server's command line, for every domain or for one:
bolt-cli rebuild-apache-vhosts
bolt-cli rebuild-apache-vhosts --domain=example.comSince panel 1.9.1, a finished Phusion Passenger install opens its page in Modules, at /admin/modules/myapache-mod-passenger. Passenger has no settings page of its own.
The administrator API ​
Since panel 1.9.4, the module list and its actions are on the administrator REST API. Authentication is the same as for the rest of the API.
| Method and path | What it does |
|---|---|
GET /api/admin/modules | The modules this page lists, in the same order, with installed, upgrade_available, and the page's Manage link. |
POST /api/admin/modules/{slug}/install | Install. Refused where this page does not offer it, for a security engine that excludes an installed one, and for a module whose required module is missing. |
POST /api/admin/modules/{slug}/upgrade | Upgrade, only where upgrade_available is true. |
DELETE /api/admin/modules/{slug} | Uninstall. |
GET /api/admin/modules/operations/{operationId} | The step log of the progress window, with the run's state: running until it ends, then completed, warning, failed, or cancelled. |
Each action answers at once with the operation to follow. Softaculous has endpoints of its own.