We recommend and support the use of the cPanel installer to install and provision cPanel & WHM. However, we understand that this is not the most efficient way for a VPS (Virtual Private Server) hosting company to provision a VPS, because this requires extra time. This article explains how hosting companies and data centers can provision a VPS or VM (Virtual Machine) with cPanel & WHM already installed for their customer. The installation of cPanel & WHM from a templated environment reduces the customer's setup time so that they can create a VPS and work on their website rather than their server.
Create a Minimal VM for Templating
A minimal template VM uses 10 GB of space, but you can expand it later as the customer requires.
This document creates a small template that you will expand after you set it up on the customer's VPS. Create a new minimal VPS to prepare your template.
We recommend that you customize the following files:
cPanel, Inc. offers the following release tiers:
cPanel & WHM automatically defaults to the RELEASE tier. But, before you install cPanel & WHM, you can configure the
/etc/cpupdate.conf file to select which release tier cPanel & WHM will use.
For example, if you wished to configure cPanel & WHM to use the CURRENT release tier, run the following commands:
If you wished to use EDGE or STABLE tiers, replace the word
current with the desired release tier.
- Your customer can change this setting within WHM at a later time.
- You cannot downgrade major versions, and you cannot change a server's release tiers to circumvent this restriction.
For more information on the
cpanel.config file, visit our Best Practices for cPanel Virtualization Templates documentation.
If you are a cPanel Partner with your own FastUpdate server, you can edit the
HTTPDUPDATE line in the
/etc/cpsources.conf file so that all of your customers update from your FastUpdate Server.
Read the Custom update mirrors documentation for more information.
After you finish your pre-configuration, you can install cPanel & WHM. Follow the Best Practices for cPanel Virtualization Templates as you usually would to install cPanel.
Deploy your VPS
When you deploy the customer's VPS, you must automatically update some files. If you use the
libguestfs virt-sysprep command, you can achieve this via the "
--firstboot" or "
--firstboot-command" flags. If you do not use the
libguestfs command, consult your hypervisor's documentation for an alternative option to run scripts or commands upon first boot.
If you use a tool such as
libguestfs virt-sysprep to help finalize your template, ensure that you do not accidentally remove any user accounts or cron jobs.
Before you deploy your VPS, complete the following steps:
- Automatically call the
/usr/local/cpanel/bin/set_hostnamescript on the first boot of the image before any cPanel services start. You can either randomize the hostname or set the hostname based on your customer's choice.
/etc/wwwacct.confto the main IP address for the VPS.
- If you run a 1:1 NAT environment, run the
/scripts/build_cpnatscript to build your NAT file, and configure Apache accordingly.
- Run the
/scripts/rebuildhttpdconfscript to rebuild your Apache configuration with the correct addresses.
The following bash script executes the steps above, but it does not update
Updating your Templates
As cPanel, Inc. releases updates, you will need to update your templates.
To avoid this situation, plan regular updates on all of your templates.
To update your template, run the following commands:
Before you shut down the VM to create the template, run the following commands to ensure that cPanel, Inc. does not lock your license:
The following bash script runs the commands shown above:
- The hostname on OpenVZ/Virtuozzo may not meet the requirement of a Fully Qualified Domain Name (FQDN) on CentOS 7. Virtuozzo controls the hostname via VPS configuration (the
--hostnameparameter of the
prlctlcommands). If you set the hostname manually from inside the VPS, Virtuozzo will reset the hostname on the next reboot. Ensure that you set up the full hostname correctly after you provision the VM, because cPanel & WHM requires an FQDN.
- OpenVZ/Virtuozzo requires that you enable second-level quotas, which can cause quota-initiation issues. For more information read our Enable Quotas on a Virtuozzo® VPS documentation, or Virtuozzo's Documentation.
- Jailshell requires specific steps to enable a full proc mount. For more information, read our Best Practices for cPanel Virtualization Templates documentation.