Module Installation for Hetzner Cloud VPS Servers for WHMCS

Hetzner Cloud VPS Automation for WHMCS is a highly convenient tool for anyone looking to automate the management of their Hetzner Cloud VPS servers.

This module enables your clients to remotely manage server status, access the console, and rebuild their machines with ease. It also offers flexibility to customize your services, making it easy to meet even the most demanding client requirements.

Installation and Configuration This tutorial will guide you through the smooth installation and configuration of Hetzner Cloud VPS Servers Automation for WHMCS.

We will guide you step by step through the whole process.:

1. Download and obtain the license key from our client area.
2. Extracted files (modules folder content) into your WHMCS directory.

Activating Hetzner Cloud Automation Module in WHMCS:

1. First go to Configuration > System Settings > Addon Modules

2. Next to Hetzner Cloud Automation

    a. Activate – Click on Activate to activate the module
    b. Configure – Now click on configure for module configurations
    c. Module License – Provide license key that we get during module download
    d. Access Control – Provide access control based on your requirement whereas Administrator is a mandatory Access control.

Configuring Hetzner Cloud API into Hetzner Cloud Automation Module

1. Go to https://console.hetzner.cloud to get the API key for our project

2. Within Hetzner Cloud Console

    a. From the left side menu find the Security section and click on it
    b. Click on API Tokens menu
    c. Click on Generate API Token button from right side
    d. Provide suitable Description for your API key identification
    e. Select Permission as Read & Write
    f. Then click on Generate API Token to complete key generation

3. Now API key has been generated successfully copy the key and save it into your local instance and latter you won’t be able to view to fully and hence you need to regenerate if you lost it

4. Within your WHMCS admin panel go to Addons > Hetzner Cloud

5. Let’s add the API key that we generated at Hetzner Cloud Console into our Hetzner Cloud Automation

   1. Add Project API Key – Click on it and the dialog box will come up
   2. Project Name – Provide suitable project name
   3. API Key - Paste the copied API key from Hetzner Cloud Console
   4. Confirm – Once all the information provided click to submit API details

Module Configuration

1. Go to Addons > Hetzner Cloud Automation and click on Configuration

2. Now click on Configuration menu

3. General Configuration:

    a. Delete Database – It required to be ON if you are upgrading from previous version to new version
    b. Snapshot – Enable it if you wanted to allow user to build the VM from Snapshot its best for Windows VM etc
    c. Default Reverse PTR – Its required if you wanted to set IP address default reverse DNS as say: static.12.132.12.198.clients.whmcsmodule.net for the primary or floating IP of 198.12.132.12

4. Product Services – Adjust these settings based on your requirement which will reflect at user profile-based product

Configuration of Product/Services

1. In order to create a product, we need to first Navigate into Configuration > System Settings > Product/Services

2. Now let’s create a product group, click on Create Product Group

3. In next page provide a Product Group name and adjust all other things based on your requirement then click on Save Changes

4. Now Create a New Product

5. In the next you need to configure below details

   1. Product Type – Server/VPS or Other, we recommended to select type as Other, because during order process your customer will not promoted to provide Hostname, Password, NS1 & NS2 prefix. If Sever/VPS selected then your customer will be prompted to provide these details.
   2. Product Group – Select the product group that we created
   3. Product Name – Provide your product name
   4. Module – Hetzner Cloud Automation
   5. Create as Hidden – Off
   6. Save Change - Once the above required filed is set click on Save changes

In next page

1. Verify – Product Type

2. Welcome Email – Select Dedicated/VPS Server Welcome Email or any custom template in case you wish to provide Windows VM

3. Module Settings – Select Module Settings Tab

4. In Modules Settings Tab select below required details

    a. Cloud VM Hostname – Since we have selected Product Type (Previous step) as Other its mandatory to provide default hostname example – whmcs (lower case only)
    b. Project ID – Select the project ID to which the Cloud VM will be created
    c. Plan Name – Select the plan name for the product
    d. Server Location – Select default server location if customer did not select during order process it will create VM at this location
    e. Volume Type – Required as it will create volume based on this selection
    f. Rescue Mode – Optional adjust as per your requirement
    g. Password Change - Optional adjust as per your requirement
    h. ISO Images - Optional adjust as per your requirement
    i. OS Installation - Optional adjust as per your requirement
    j. Protection - Optional adjust as per your requirement
    k. Console Access - Optional adjust as per your requirement
    l. Custom Script - Set to none otherwise select your script you can refer the script details in “modules/servers/HetznerCloud” directory if you want to have your own
    m. Snapshot Limit   - Define the snapshot maximum limit you would like to allow if a customer ordered
    n. Config Options – Just click on this to create configurable options for OS Images, Backup etc
    o. Auto Provision – Based on your requirement you can adjust like Automatically provision etc
    p. Save Changes – Once all done click on Save changes

5. Custom Fields – You can verify but not required to do any changes

Configurable Options – Required

1. In order to create a configurable option, we need to first Navigate into Configuration > System Settings > Configurable Options
2. Edit newly created Configurable Options which is as per the above product and adjust based on your requirements

Snapshot Management Snapshot Management is used to create Snapshot of a VM says to create a Windows OS out of Windows ISO installation based VM. Creating Snapshot

1. Go to Addons > Hetzner Cloud Automation and click on Snapshot icon next to your project and confirm the dialog

2. Click on Add Snapshot to create and Snapshot with label tagged as Windows,:

    a. Make sure the VM is powered off else you can not create snapshot out of the desired VM
    b. Now select the VM from drop down
    c. Give a Snapshot Description – It is the name of the snapshot

3. If you want to create other type of snapshots then you need to create it within product/services option of that specific server. Anything created here is marked as Windows image.

4. If you had already created the snapshots and wanted to mark them as windows image then simply click on Tag icon to make it done.

Assigning a server to a user

If you ware having any Cloud VM/ VPS before using the module then you need to follow these steps so that you can assign an existing VM/ VPS to your existing customer.

Importing a server into WHMCS

1. Go to Addons > Hetzner Cloud Automation and click on View Servers
2. Now click on the + icon to import the server as WHMCS server
3. Navigate to Configuration > System Settings > Servers to validate whether the server is imported or not

Assigning the imported VM/ VPS to the end user

1. Search for the user to whom you wanted to assign the imported server and got that user’s profile and click on edit icon of the service for which we will assign the server
2. From servers drop down select the server which you would like to assign the end user
3. Now we have assigned an existing server into a user and the user will continue to perform the cloud vm action.