We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Page tree
Skip to end of metadata
Go to start of metadata


Overview

This document explains how to install a cPanel & WHM instance on the Google Compute Engine™ service through the Google Marketplace.

Note:

Google currently offers a 365-day trial and a $300 service credit.

Warning:

You must purchase a license for cPanel & WHM. New installations automatically receive a free 15-day trial license.

For security reasons, cPanel, L.L.C. allows only one trial license for each IP address. Due to the recycling of IP addresses at hosting providers, the provider may assign a previously-licensed IP address to your new server. If a license error appears when you first  log in to cPanel & WHM, contact cPanel Customer Service to unlock the trial license for your server's IP address.


Create a cPanel & WHM instance on Google Compute Engine


Access the Google Compute Engine.

To log in to the Google Compute Engine website, perform the following steps:

  1. If you do not already possess a Google account, create one. Then, log in to Google.
  2. Navigate to the Google Compute Engine website. The Google Compute Engine interface will appear.
  3. Click Get Started. A new interface will appear.



Accept the trial offer.

Accept the Terms of Service and click CONTINUE. The Payment Information interface will appear.



Enter or confirm your payment information.

To enter or confirm your payment information, perform the following steps:

  1. Enter your payment information or confirm the existing payment method on your account.
  2. Click START MY FREE TRIAL. The Google Cloud Platform interface will appear, and Google will send you a confirmation email.




Use the cPanel & WHM Marketplace image.

To use the cPanel & WHM image on Marketplace, perform the following steps:

  1. In the left navigation bar, click Marketplace. The Marketplace interface will appear.
  2. Search for cPanel. A list of products will appear.
  3. Click cPanel & WHM on Linux. The cPanel & WHM Marketplace profile will appear.
  4. Read the details, such as estimated costs.
  5. Click LAUNCH ON COMPUTE ENGINE.

Important

You must enable billing on your account to proceed. Click Enable Billing. Wait for the Configuring APIs message to vanish.



Create an instance.

To create the instance, perform the following steps:

  1. In the Deployment name text box, enter a name for the instance.

    Note:

    The Deployment name may only contain lowercase characters, numbers or dashes. It must start with a lowercase letter and cannot end with a dash.

  2. In the Zone menu, select the datacenter in which you wish to create the server.
  3. Under Machine type, select the number of CPUs you need.
    • Click Customize if your instance requires more memory, a specific CPU style, or to specify the number of CPUs.
  4. In the Boot disk section, click Change. A new section will appear.
  5. Select Standard persistent disk for the Boot disk type.
  6. Set the Boot disk size in GB text box to more than 20GB.
  7. In the Networking section, do not make any changes.
  8. In the Firewall section, do not make any changes.
  9. Click Deploy. Google Cloud Platform's Deployment Manager interface will appear.



Connect to the instance.

The interface will display a green icon next to the instance name when it is ready. The right panel contains helpful information to help you to log in to the server.

To connect to the instance, perform the following steps:

  1. Click SSH. A new window will appear with a terminal session.
  2. Enter sudo su - to get root access.



Change the root password.

To change the root user's password, perform the following steps:

  1. Run the passwd command.
  2. Enter a new password.
  3. Enter the new password again.

A confirmation message will appear.



Assign a hostname to the server.

To assign a hostname to the server, run the following command, where hostname.example.com represents your desired hostname:

hostnamectl set-hostname hostname.example.com



Create the hostname fix hook.

To configure VPS deployments, many cloud hosting providers use the dhclient script. This script includes the configuration of the instance's hostname. But, the dhclient script may not preserve the locally-configured hostname. So, hosting providers use scripts to work around this issue. For example, Google Cloud Platform Services™ uses the google_set_hostname script.

The workaround scripts may interfere with WHM's Change Hostname feature (WHM >> Home  >> Networking Setup >> Change Hostname). These can cause hostname configuration issues and a locked cPanel & WHM license. You must create a dhclient exit hook script to set the hostname properly.

To create the hook, run the following command, where hostname.example.com represents your server's hostname:

 Click here to view...
mkdir -p /etc/dhcp/dhclient-exit-hooks.d/ && echo -ne '#!/bin/sh\nhostname hostname.example.com\n/scripts/fixetchosts\n' > /etc/dhcp/dhclient-exit-hooks.d/zzz-set-hostname.sh && chmod +x /etc/dhcp/dhclient-exit-hooks.d/zzz-set-hostname.sh

For information on this hook, read our Cloud-Hosted Hostname Solution documentation.

When you are finished, close the terminal session and return to the Google Compute Engine interface.



Configure a static IP address.

By default, Google assigns ephemeral IP addresses to VM instances. They will remain assigned to the server as long as the VM is active, but will change if you turn off and then turn back on a VM.

To configure a static IP address for the server, perform the following steps:

  1. Under Assign a static external IP address to your VM instance, click Learn more. A help interface will appear.
  2. Click GO TO THE EXTERNAL UP ADDRESSES PAGE. The External IP Addresses interface will appear.
  3. Click the arrow next to Ephemeral.
  4. Select Static. A new window will appear.
  5. In the Name text box, enter a name for the IP address.
  6. Click Reserve.



Log in to WHM.

To log in to WHM, perform the following steps:

  1. Navigate to the following URL, where IPADDRESS represents your server's IP address:

    https://IPADDRESS:2087

    Note:

    You can also return to the Deployment Manager interface and click the Admin URL link.

  2. Enter your username and password.
  3. Click Log in.



Agree to our license, and configure contact and nameservers.

To log in to WHM, perform the following steps:

  1. Agree to the software license. A new interface will appear.
  2. Enter the your contact information and nameserver information. The WHM Home interface will appear.

Reminder:

You must purchase a license for cPanel & WHM. New installations automatically receive a free 15-day trial license.

For security reasons, cPanel, L.L.C. allows only one trial license for each IP address. Due to the recycling of IP addresses at hosting providers, the provider may assign a previously-licensed IP address to your new server. If a license error appears when you first  log in to cPanel & WHM, contact cPanel Customer Service to unlock the trial license for your server's IP address.


Configure WHM.

After you agree to our software license, you're ready to configure cPanel & WHM.

For more information about how to configure cPanel & WHM, read our WebHost Manager documentation.

Google blocks port 25.

By default, Google disables port 25 for outbound email traffic.

For more information on Google's block of port 25, read Google's Sending Email from an Instance documentation.

For potential solutions, read Google's SMTP relay: Route outgoing non-Gmail messages through Google support article and the Sharthost configuration section on our Exim Configuration Manager documentation.

Additional documentation

There is no content with the specified labels

There is no content with the specified labels

There is no content with the specified labels

There is no content with the specified labels