Vultr Bare Metal for Blesta — Installation
Version 1.2.1 · WHMCSModule Networks
This package has two parts that are installed separately: a module (provisions and manages the servers) and a plugin (admin console, server list, license page and the daily bandwidth check). Install the module first, then the plugin.
Requirements
| Requirement | Detail |
|---|---|
| Blesta | 6.0 or later |
| PHP | 8.2 or later with the curl extension |
| Vultr | An account and an API key |
| License | A license key for this product (entered after installation) |
| Cron | Blesta's cron must be running if you use bandwidth auto-suspend |
What is in the package
| File | Unpacks to |
|---|---|
modules.zip |
components/modules/vultr_baremetal/ |
plugins.zip |
plugins/vultr_baremetal/ |
Both archives already contain the correct folder paths, so extract each one into the Blesta root folder (the folder that contains components/ and plugins/). Do not create an extra vultr_baremetal folder around them.
After extracting you should have exactly these two folders and no others:
<blesta root>/components/modules/vultr_baremetal/vultr_baremetal.php
<blesta root>/plugins/vultr_baremetal/vultr_baremetal_plugin.php
The folder names must stay in lowercase with the underscore. Blesta finds the module by its folder name, and a different name makes it disappear from the Available list.
1. Create a Vultr API key
- In the Vultr customer portal open Account → API.
- Enable the API and create a key.
- Under Access Control, add the public IP address of the server that runs Blesta. Calls from any other address are refused.
Keep the key private. It can create and delete servers on your account.
2. Install the module
- Log in to the Blesta admin area.
- Go to Settings → Company → Modules → Available.
- Find Vultr Bare Metal and press Install.
Blesta opens the module's manage page. If the module is not listed, check the folder name and location from the section above.
3. Install the plugin
- Go to Settings → Company → Plugins → Available.
- Find Vultr Bare Metal and press Install.
- Blesta may say the plugin registered permissions. If a staff member cannot see the menu or gets "access denied", open that staff member's group in Blesta's staff settings and allow the Vultr Bare Metal permissions.
A Vultr Bare Metal group with Dashboard, Servers and License now appears in the admin menu.
4. Enter the license key
- Open Vultr Bare Metal → License.
- Paste the license key and press Save key.
- The status should read Active, with your domain and install path listed. If it does not, press Recheck now.
The license is informational. If it is missing or the license server is unreachable the module shows a notice and keeps working.
5. Add your Vultr account
- Go to Settings → Company → Modules → Installed → Vultr Bare Metal → Manage.
- Press Add Account, enter a name and the API key, and save.
Blesta checks the key with Vultr before saving. An error here usually means a wrong key or that the Blesta server's IP address is not allowed in the key's Access Control.
Confirm the connection at any time under Vultr Bare Metal → Dashboard → Test connection.
6. Create a package
- Go to Packages → Packages → Add Package.
- On the Basic tab set the name, status, price and a package group.
- On the Module tab choose Vultr Bare Metal and the Vultr account.
- Pick the Region and the Plan. Both lists come live from Vultr, and Blesta refuses a plan that is not in stock in the chosen region.
- Optionally set the hostname prefix, IPv6 default, Windows hiding, bandwidth auto-suspend and the cloud-init template.
- Save the package.
The package is now orderable from the admin area (Clients → client → Add Service) and from any Blesta order form.
7. Check the first order
- Add a service for a test client using the new package, choosing an operating system. Leave Provision using the Vultr Bare Metal module when activated ticked.
- After a few seconds the service shows a Vultr server ID, and Vultr Bare Metal → Servers lists the server.
- Open the service's Server tab. It shows Installing until Vultr finishes, then Running.
Remember that creating a server starts Vultr billing. Cancel test services with Use module ticked so the Vultr server is deleted too.
Bandwidth auto-suspend (optional)
Tick Suspend on bandwidth overage on a package. The plugin registers a daily job named Vultr Bare Metal bandwidth meter under Settings → Company → Automation; it needs Blesta's normal cron to be running.
Upgrading
- Back up the two folders.
- Extract the new
modules.zipandplugins.zipover the existing folders, allowing files to be overwritten. - Go to Settings → Company → Modules → Installed and press Upgrade next to Vultr Bare Metal.
- Go to Settings → Company → Plugins → Installed and press Upgrade next to Vultr Bare Metal.
Blesta only offers Upgrade when the version number has increased. Upgrade both the module and the plugin, even if only one seems to have changed. Your Vultr accounts, packages, services and license key are kept.
Uninstalling
- Cancel or move any services that use the package. Uninstalling the module does not delete servers at Vultr.
- Uninstall the plugin: Settings → Company → Plugins → Installed → Uninstall.
- Uninstall the module: Settings → Company → Modules → Installed → Uninstall.
- Delete the two folders from the Blesta root.
Troubleshooting
| Symptom | Cause and fix |
|---|---|
| Module is not in the Available list | The folder is not named vultr_baremetal or is nested one level too deep. |
| "The Vultr API did not accept this key" | Wrong key, or the Blesta server's IP is not allowed in the key's Access Control. |
| Region and plan lists are empty on the package form | No account added yet, or Vultr cannot be reached. Add and test the account first. |
| Plugin page says access denied | Allow the Vultr Bare Metal permissions for that staff member's group in Blesta's staff settings. |
| A page shows a Blesta exception after replacing files | Press Upgrade for both the module and the plugin. |
| Server tab says the server is not available yet | The service is not active, or no Vultr server ID is linked to it. |
| License says Invalid, domain mismatch | The key was issued for another domain. Contact support to move it. |
Support
WHMCSModule Networks · https://www.whmcsmodule.net