PUQ Mautic

Hetzner Datacenter WHMCS module

The Hetzner WHMCS module enables seamless integration with Hetzner Cloud services, enabling automated provisioning, management, and billing of cloud servers directly from the WHMCS platform. This module supports a wide range of features, including server creation, suspension, resumption, termination, and various server management tasks such as reboot, reset, and remote console access. In addition, it offers features such as IP address monitoring, bandwidth monitoring, backup and snapshot management, making it a complete solution for reselling Hetzner Cloud services.

Description

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ
The module, fully installed and correctly implemented in the system, offers the following functionalities.

Module Functions:

Available options in the admin panel:

Available options in the client panel:

WHMCS minimal version: 8 +

settingsHetznerDatacenter.png

HomeHetznerDatacenter.png

ReinstallHetznerDatacenter.png

SnapshotHetznerDatacenter.png

 

ISOmountHetznerDatacenter.png

ChartsHetznerDatacenter.png

Changelog

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ
v2.0.1 Released 17-10-2024
  1. Added the ability to set the user as root in the package settings.
  2. The Public Network DNS PTR list will be copied into the domain field if the field is empty.
  3. Fix a bug preventing the use of SSH keys.
  4. Fix a bug in handling cloud-init when saving a package.
v2.0 Released 24-09-2024

Module is coded ionCube v13

Supported php version:

v1.0 Released 02-09-2024

First version

 

 

Installation and configuration guide

Installation and configuration guide

WHMCS setup(install/update)

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ

Module is coded ionCube v13

Supported php version:

To install and update a module, you must perform one and the same action.

 
1. Download the latest version of the module.

PHP 8.2

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-HetznerDatacenter/php82/PUQ_WHMCS-HetznerDatacenter-latest.zip

PHP 8.1

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-HetznerDatacenter/php81/PUQ_WHMCS-HetznerDatacenter-latest.zip

PHP 7.4

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-HetznerDatacenter/php74/PUQ_WHMCS-HetznerDatacenter-latest.zip

All versions are available via link: http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-HetznerDatacenter/

2. Unzip the archive with the module
unzip PUQ_WHMCS-HestiaCP-latest.zip
3. Copy and Replace "puqHetznerDatacenter" to "WHMCS_WEB_DIR/modules/servers/"
 
Installation and configuration guide

Basic concepts and requirements

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ

Requirements for the successful operation of the module

The logic of the module.

You can offer your clients virtual machines from Hetzner. The module allows you to deploy almost any service based on Hetzner.
Creating a new Account.
  1. Checking the module license
  2. Generating the server name in the format NameServer-[*user_id*]-[*service_id*]
  3. Generating data to create a server
  4. Sending data via API and creating a server
Package change
  1. The package change function allows you to enable and disable backups
Suspending an Account
  1. Checking the module license
  2. Selecting the suspension method: server shutdown or enabling firewall rules
  3. Executing the suspension via API
Unsuspending an Account
  1. Checking the module license
  2. Selecting the restoration method: server power on or restoring firewall rules
  3. Executing the restoration via API
Terminating an Account
  1. Checking the module license
  2. Deleting the server via API
  3. Updating information in the WHMCS database
Client Area

The module provides clients with the ability to manage virtual machines through the WHMCS client area, including functions for creating, suspending, restoring, and deleting servers, as well as managing backups and snapshots.

Installation and configuration guide

Setup guide: WHMCS preparation and configuration

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ
1. Download the latest version of the module.

PHP 8.X

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-HetznerDatacenter/PUQ_WHMCS-HetznerDatacenter-latest.zip

PHP 7.4

wget http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-HetznerDatacenter/php74/PUQ_WHMCS-HetznerDatacenter-latest.zip

All versions are available via link: http://download.puqcloud.com/WHMCS/servers/PUQ_WHMCS-HetznerDatacenter/

2. Unzip the archive with the module
unzip PUQ_WHMCS-HetznerDatacenter-latest.zip
3. Copy "HetznerDatacenter" to "WHMCS_WEB_DIR/modules/servers/"
4. Create new server HetznerDatacenter in WHMCS (System Settings -> Products/Services -> Servers)
System Settings->Servers->Add New Server

image-1724850441575.png

image-1724851230866.png

6. Create a new server Group

For the module to work correctly, you need to create a group and add our server that we created to it. If you want to use several projects, you need to create your own server for each project and create a group and add one server to one group.

System Settings->Products/Services->Create New Group

image-1724853090096.png

6. Create a new Products/Services
System Settings->Products/Services->Create a New Product

 

In the Module settings section, select the "PUQ Hetzner Datacenter" module

Please note that you need to select a group with a configured server, so we can separate services by projects in the Hetzner console

settingsHetznerDatacenter.png

Package Settings

License key: A pre-purchased license key for the "PUQ Hetzner Datacenter" module. For the module to work correctly, the key must be active.

Server name: This option allows you to add a prefix string to the server name. A new name will be generated each time the create account function is called. When NameServer will only be present if the field is set: NameServer-[*user_id*]-[*service_id*].

Server type: The type of server to be deployed. This is selected from the available server types provided by Hetzner. This field is automatically populated based on your selection from Select Server and Location.

Server location: The physical location of the server. This is selected from the available locations provided by Hetzner. This field is automatically populated based on your selection from Select Server and Location.

Server placement groups: The placement groups for the server. This allows you to specify how the server should be grouped within the data center. This field is automatically populated based on your selection from the Select Placement Group.

Server image: The operating system image to be used for the server. This is selected from the available images provided by Hetzner. This field is automatically populated based on the selection from Select Image.

SSH keys: The SSH keys to be used for accessing the server. You can add multiple SSH keys. This field is automatically populated based on your selection from Select SSH Keys.

Server networks: The networks to which the server will be connected. This field is automatically populated based on your selection from Private Networks.

Server firewalls: The firewall rules to be applied to the server. You can select from predefined firewall rules or create custom ones. This field is automatically populated based on your selection from Select Firewalls.

User data: Custom user data to use during server creation. This field is limited to 32KB. You can use this to provide cloud-init configuration scripts or other initialization data.

Package setting: Additional settings for the package, including:

API Settings

Select Server and Location: Choose the server type and location from the available options provided by Hetzner.

Select Image: Choose the operating system image for the server from the available options provided by Hetzner.

Custom option name for image: Specify a custom option name for the server image if needed.

Allow user to select ISO image: Enable this option to allow users to select an ISO image.

Allow user to reinstall service: Enable this option to allow users to reinstall the service from the client area.

Allow user to choose backup and snapshot when reinstalling service: Enable this option to allow users to choose a backup and snapshot when reinstalling the service.

Select Placement Group: Choose the placement group for the server from the available options provided by Hetzner.

Select SSH Keys: Choose the SSH keys to be used for accessing the server from the available options provided by Hetzner.

Public Networks: Configure the public network settings for the server. This includes enabling or disabling public IPv4 and IPv6 addresses.

Private Networks: Configure the private network settings for the server.

Select Firewalls: Choose the firewall rules to be applied to the server from the available options provided by Hetzner.

Email configuration: Setting up email templates. Selection of pre-prepared templates to inform the user about some actions:

Metric Billing: Configuration for metric billing, including:

Installation and configuration guide

Add server (Hetzner)

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ
Add a new server to the system WHMCS.
System Settings->Servers->Add New Server

image-1724850441575.png

image-1724851230866.png

Installation and configuration guide

Email Template (puqHetznerDatacenter Custom Welcome Email)

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ
Create an email template for customer notifications.
System Settings->Email Templates->Create New Email Template

Unique Name: puqHetznerDatacenter Custom Welcome Email

image-1725014242260.png


Subject: 

Your Server is Now Ready for Use

Body:

Dear {$client_name},

Congratulations! Your server has been successfully deployed and is ready for you to begin configuring.

Server Details:
IPv4 DNS PTR: {$ipv4_dns_ptr}
IPv4 IP: {$ipv4_ip}
IPv6 IP: {$ipv6_ip}
Server Cores: {$server_cores}
Server Memory: {$server_memory}
Server Disk: {$server_disk}
Root Password: {$root_password}
Accessing Your Server

To begin managing your new server, you will need to connect via SSH (Secure Shell). Here’s how you can do that:

    Open an SSH client on your computer. For Windows, we recommend using PuTTY, while macOS and Linux users can use the built-in Terminal application.

    Connect to your server by executing the following command in your terminal or SSH client:
    ssh root@{$ipv4_ip}

    When prompted, enter the root password provided below:

    Root Password: {$root_password}

Once connected, you’ll have full access to your server’s console and can monitor the installation.
Need Assistance?

If you have any questions or encounter any issues during this process, please do not hesitate to reach out to our support team. We are here to help! You can submit a support ticket via the following link: Submit a Ticket.

Thank you for choosing us as your hosting provider. We’re excited to be part of your journey and are committed to ensuring your experience is successful.

Kind regards,
{$signature}

image-1725014459758.png

Installation and configuration guide

Email Template (puqHetznerDatacenter Custom start stop service Email)

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ
Create an email template for customer notifications.
System Settings->Email Templates->Create New Email Template

Unique Name: puqHetznerDatacenter Custom start stop service Email

image-1725014717960.png


Subject: 

{if $server_action eq "start"}Your Server Has Been Successfully Started{/if}{if $server_action eq "stop"}Important: Your Server Has Been Stopped{/if}

Body:

Dear {$client_name},

{if $server_action eq "start"}Your server has been successfully started.{/if}{if $server_action eq "stop"}Your server has been stopped.{/if}

Product/Service: {$service_product_name}

If you have any questions or need further assistance, do not hesitate to contact our support team.

Thank you for choosing us.

{$signature}

image-1725016539213.png

Installation and configuration guide

Email Template (puqHetznerDatacenter Custom reset password Email)

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ
Create an email template for customer notifications.
System Settings->Email Templates->Create New Email Template

Unique Name: puqHetznerDatacenter Custom reset password Email

image-1725018922546.png


Subject: 

For user {$user} on Product/Service: {$service_product_name} password has been change

Body:

Dear {$client_name},

You change password for user {$user} on Product/Service: {$service_product_name}. Below is the user logging data.

User: {$user}
New password: {$password}


{$signature}

image-1725019070065.png

Installation and configuration guide

Email Template (puqHetznerDatacenter Custom snaphot action service Email)

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ
Create an email template for customer notifications.
System Settings->Email Templates->Create New Email Template

Unique Name: puqHetznerDatacenter Custom snaphot action service Email

image-1725200462144.png


Subject: 

{if $snapshot_action eq "create"}Snapshot started create Successfully{/if}{if $snapshot_action eq "remove"}Snapshot Removed Successfully{/if}{if $snapshot_action eq "rollback"}A restore from your snapshot has been initiated{/if}

Body:

Dear {$client_name},

{if $snapshot_action eq "create"}Snapshot creation started.{/if}{if $snapshot_action eq "remove"}Your snapshot has been successfully removed.{/if}{if $snapshot_action eq "rollback"}A restore from your snapshot has been initiated.{/if}

{if $snapshot_id}Snapshot ID: {$snapshot_id}{/if}
{if $snapshot_description}Snapshot Description: {$snapshot_description}{/if}
{if $service_product_name}Service name: {$service_product_name}{/if}

If you have any questions or need further assistance, do not hesitate to contact our support team.

Thank you for choosing us.

{$signature}

image-1725200542055.png

Installation and configuration guide

Email Template (puqHetznerDatacenter Custom backup action service Email)

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ
Create an email template for customer notifications.
System Settings->Email Templates->Create New Email Template

Unique Name: puqHetznerDatacenter Custom backup action service Email

image-1725200731607.png


Subject: 

{if $backup_action eq "enable"}Backup Enabled Successfully{/if}{if $backup_action eq "disable"}Backup Disabled Successfully{/if}{if $backup_action eq "create"}Backup Creation Initiated Successfully{/if}{if $backup_action eq "remove"}Backup Removed Successfully{/if}{if $backup_action eq "restore"}Backup Restoration Initiated Successfully{/if}

Body:

Dear {$client_name},

{if $backup_action eq "enable"}Your backup has been successfully enabled.{/if}{if $backup_action eq "disable"}Your backup has been successfully disabled.{/if}{if $backup_action eq "create"}The creation of your backup has been successfully initiated.{/if}{if $backup_action eq "remove"}Your backup has been successfully removed.{/if}{if $backup_action eq "restore"}The restoration of your backup has been successfully initiated.{/if}

{if $backup_id}Backup ID: {$backup_id}{/if}
{if $backup_description}Backup Description: {$backup_description}{/if}

If you have any questions or need further assistance, do not hesitate to contact our support team.

Thank you for choosing us.

{$signature}

image-1725200882832.png

Installation and configuration guide

Email Template (puqHetznerDatacenter Custom ISO action service Email)

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ
Create an email template for customer notifications.
System Settings->Email Templates->Create New Email Template

Unique Name: puqHetznerDatacenter Custom ISO action service Email

image-1725200967532.png


Subject: 

{if $iso_action eq "mount"}ISO Mounted Successfully{/if}{if $iso_action eq "unmount"}ISO Unmounted Successfully{/if}

Body:

Dear {$client_name},

{if $iso_action eq "mount"}Your ISO has been successfully mounted.{/if}{if $iso_action eq "unmount"}Your ISO has been successfully unmounted.{/if}

{if $iso_id}ISO ID: {$iso_id}{/if}
{if $iso_name}ISO Name: {$iso_name}{/if}
{if $iso_description}ISO Description: {$iso_description}{/if}

If you have any questions or need further assistance, do not hesitate to contact our support team.

Thank you for choosing us.

{$signature}

image-1725200998574.png

Installation and configuration guide

Email Template (puqHetznerDatacenter Custom reinstall action service Email)

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ
Create an email template for customer notifications.
System Settings->Email Templates->Create New Email Template

Unique Name: puqHetznerDatacenter Custom reinstall action service Email

image-1725201180316.png


Subject: 

Server Rebuild Initiated Successfully

Body:

Dear {$client_name},

We are pleased to inform you that the rebuild of your server has been successfully initiated. The server will be rebuilt using the following image:

Image Name: {$image_name}
Image Description: {$image_description}
Disk Size: {$image_disk_size} GB
Architecture: {$image_architecture}
Image Type: {$image_type}

Please be patient as the rebuild process completes. If you have any questions or need further assistance, do not hesitate to contact our support team.

Thank you for choosing us.

{$signature}

image-1725201209597.png

Client Area

Client Area

Home screen

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ
The end customer, after logging in to his own customer panel, has access to the following information and options:

1. The Manage tab

  1. Control Buttons:

    • Start - Green button with a power icon. Starts the server if it was stopped.
    • Stop - Red button with a power icon. Stops the current operation of the server.
    • noVNC - Blue button with a monitor icon. Allows you to open a remote server management window via a web interface (VNC).
    • Charts - Orange button with a graph icon. Allows you to view server performance charts.

  2. Server Status and Information:

    • Status - The current status of the server (in this case, "running" - the server is active).
    • CPU - The number of processor cores allocated to the server (in this case, 1 core).
    • RAM - The amount of RAM allocated to the server (in this case, 2 GB).
    • System Disk - The amount of disk space allocated for the operating system (in this case, 20 GB).
    • Datacenter - The location of the data center where the server is hosted (in this case, Helsinki 1 virtual DC 2).
    • Image - The operating system and its version installed on the server (in this case, Debian 11).
    • Outgoing Traffic - The outgoing traffic used by the server (in this case, 195.31 KB).
    • Ingoing Traffic - The incoming traffic used by the server (in this case, 658.44 MB).
    • Public Network IPv4 - The public IPv4 address assigned to the server.
    • Public Network IPv6 - The public IPv6 address assigned to the server.
    • Public Network DNS PTR - The reverse DNS record for the server's public IP address.

  3. Additional Actions:

    • User manual - Opens the user manual.
    • Open PTR Record - Opens the PTR record for editing.
    • Reinstall - Reinstalls the operating system on the server.
    • Snapshots - Manages snapshots of the server's current state.
    • Backups - Manages the server's backups.
    • Reset password - Resets the password for server access.
    • ISO mount - Mounts an ISO image for installing or restoring the operating system.

image-1725221245271.png

2. Configurable Options tab

image-1725203831061.png

3. Metrics tab

The "Metrics" tab provides detailed information about usage-based billing for your server in addition to the base price. This section displays various usage metrics, the current usage levels, associated pricing, and the last time the data was updated.

Detailed Breakdown of Metrics:

  1. Floating IPv4 addresses:

    • Current Usage: The number of floating IPv4 addresses currently being used. (In this case, 0)
    • Pricing: The cost associated with each owned floating IPv4 address. (In this case, 10.00 EUR per owned IP)
    • Last Update: The timestamp showing when this data was last refreshed. (In this case, 4 hours ago)

  2. Floating IPv6 addresses:

    • Current Usage: The number of floating IPv6 addresses currently being used. (In this case, 0)
    • Pricing: The cost associated with each owned floating IPv6 address. (In this case, 1.00 EUR per owned IP)
    • Last Update: The timestamp showing when this data was last refreshed. (In this case, 4 hours ago)

  3. Bandwidth Usage (GB):

    • Current Usage: The amount of bandwidth used by the server. (In this case, 0.26 GB)
    • Pricing: The cost per gigabyte of bandwidth used beyond the included allowance. (In this case, 0.01 EUR per GB, with 5000.00 GB included)
    • Last Update: The timestamp showing when this data was last refreshed. (In this case, 4 hours ago)

  4. Snapshot Usage (GB):

    • Current Usage: The amount of storage used for server snapshots. (In this case, 0.00 GB)
    • Pricing: The cost per gigabyte of snapshot storage used. (In this case, 2.00 EUR per GB)
    • Last Update: The timestamp showing when this data was last refreshed. (In this case, 4 hours ago)

image-1725221482708.png

3. Additional Information tab

image-1725205218236.png

2. The Resource Usage tab

image-1725221299141.png

Client Area

Charts Section Description

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ

The "Charts" section provides visual representations of various performance metrics of your server over different time periods. This section is useful for monitoring and analyzing the server's resource usage and performance trends.

Available Time Frames:

At the top of the section, there are buttons that allow you to select the time frame for the displayed metrics:

Performance Metrics:

  1. CPU Usage:

    • Description: This chart shows the CPU usage over time, represented by a blue line. The vertical axis indicates the percentage of CPU usage, while the horizontal axis represents time.
    • Purpose: Monitoring CPU usage helps to understand the server's processing load and identify periods of high or low activity.

  2. Disk IOPS (Input/Output Operations Per Second):

    • Description: This chart displays the disk IOPS, split into Read IOPS (blue) and Write IOPS (red). The vertical axis indicates the number of IOPS, and the horizontal axis represents time.
    • Purpose: Tracking disk IOPS is important for understanding how frequently the disk is being accessed, which can affect the overall performance of the server, especially under high read/write operations.

  3. Disk Bandwidth:

    • Description: This chart shows the disk bandwidth usage, differentiated into Read Bandwidth (MB) (blue) and Write Bandwidth (MB) (red). The vertical axis shows the bandwidth in megabytes, and the horizontal axis represents time.
    • Purpose: This metric helps to monitor the amount of data being read from or written to the disk, which is crucial for assessing the impact of disk operations on the server's performance.

  4. Network Packets:

    • Description: This chart displays the number of network packets processed by the server, with Packets In (blue) and Packets Out (red). The vertical axis shows the number of packets, and the horizontal axis represents time.
    • Purpose: Tracking network packets allows you to monitor the volume of incoming and outgoing network traffic, which is essential for understanding network load and identifying any potential issues with connectivity or bandwidth.

  5. Network Bandwidth:

    • Description: This chart shows the network bandwidth usage, with Bandwidth In (MB) (green) and Bandwidth Out (MB) (blue). The vertical axis indicates the bandwidth in megabytes, while the horizontal axis represents time.
    • Purpose: Monitoring network bandwidth usage helps to evaluate the server's network performance and ensure that it can handle the necessary data throughput without bottlenecks.

image-1725223474727.png

Client Area

Reinstall Section Description

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ

The "Reinstall" section is a critical area where you can perform a complete reinstallation of your virtual machine. This section includes several important warnings and steps to ensure that users understand the consequences of reinstalling the server.

Key Warnings:

Steps to Reinstall:

  1. Select Image:

    • Image Type: First, you need to select the type of operating system image you want to reinstall. This is done through a dropdown menu where you can select from available images.
    • Available Options: There are options to show backups and snapshots by checking the corresponding boxes, allowing you to restore from a previous state if necessary.

  2. Image Details:

    • Below the selection area, detailed information about the selected image is provided in a table format. The attributes include:

      • Id: The unique identifier for the image.
      • Type: The type of image (in this case, 'system').
      • Status: The current availability status of the image.
      • Name: The name of the selected image.
      • Description: A brief description of the image.
      • Disk Size: The size of the disk associated with the image.
      • Created: The creation date and time of the image.
      • OS Flavor: The flavor of the operating system (e.g., Debian).
      • OS Version: The version of the operating system.
      • Rapid Deploy: Indicates whether rapid deployment is enabled.
      • Protection: Indicates whether delete protection is enabled.
      • Architecture: The architecture of the image (e.g., x86).

    • Note: The attributes listed here are dynamic and may vary depending on the selected image or the server configuration. Users should carefully review these details before proceeding.

  3. Confirmation:

    • Protection Mechanism: To protect against accidental reinstallation, the user is required to type the word "REINSTALL" in capital letters in a provided text box. This step is mandatory and acts as a final confirmation that the user intends to proceed with the reinstallation.

  4. Execute Reinstallation:

    • Once the word is correctly entered, the green Reinstall button at the bottom can be clicked to initiate the reinstallation process. This action will completely wipe the server and install the selected operating system image.

 

image-1725223947181.png

Client Area

Snapshots Section Description

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ

The "Snapshots" section allows you to manage snapshots of your server. Snapshots are immediate, complete copies of your server's disks, capturing the current state of the server. This is useful for backing up data or creating restore points before making significant changes to the system.

Key Features and Actions:

  1. Snapshot Creation:

    • Snapshot Description: There is a text box where you can enter a descriptive name for the snapshot you are about to create.
    • Take Snapshot: The green Take Snapshot button allows you to create a new snapshot of the server. It’s recommended to shut down your server before capturing a snapshot to ensure data consistency.

  2. Snapshot Management:

    • The section lists all existing snapshots, showing the following details for each:
      • Snapshot Name: The user-defined name of the snapshot (e.g., "My Snapshot").
      • Timestamp: The date and time when the snapshot was created (e.g., 2024-09-01T21:02:15+00:00).
      • Size: The amount of storage space used by the snapshot (e.g., 2.19 GB).

  3. Actions for Each Snapshot:

    • Rollback: The yellow Rollback button allows you to restore the server to the state it was in at the time the snapshot was taken. This is particularly useful if you encounter issues and need to revert to a previous stable state.
    • Remove: The red Remove button allows you to delete the snapshot, freeing up the space it occupies. This action is irreversible, so it should be done with caution.

  4. Refresh Button:

    • Refresh: A green Refresh button at the top of the section allows you to update the list of snapshots, ensuring that the latest snapshots and any changes are displayed.

Important Notes:

image-1725259880671.png

Client Area

Backups Section Description

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ

The "Backups" section is where you can manage and restore backups of your virtual machine. This section is crucial for maintaining data integrity and providing recovery options in case of system failure or other critical issues.

Key Features and Actions:

  1. Backup Creation:

    • Backup Notes: There is a text box labeled "Backups notes" where you can enter a description or notes for the backup you are about to create. This allows you to easily identify the purpose or specific details of the backup later on.
    • Backup Now: The green Backup now button allows you to initiate a new backup of the current state of your virtual machine. This backup will include all data and settings at the time of creation.

  2. Backup Management:

    • The section lists all existing backups, providing the following details for each:
      • Timestamp: The date and time when the backup was created (e.g., 2024-09-01T18:14:41+00:00).
      • Backup Name: The user-defined name or automatically generated name for the backup (e.g., "Backup 2024-09-01T18:14:41.639092+00:00" or "My Backup").

  3. Actions for Each Backup:

    • Restore: The yellow Restore button allows you to restore the virtual machine to the state it was in when the backup was created. This will overwrite the current state of the machine with the backup, reverting any changes made since the backup was created.
    • Remove: The red Remove button allows you to delete the backup. Deleting a backup will free up storage space, but this action is irreversible, so it should be done carefully.

  4. Refresh Button:

    • Refresh: A green Refresh button at the top of the section allows you to update the list of backups, ensuring that the most current backups and any recent changes are displayed.

image-1725261921631.png

Client Area

ISO Mount Section Description

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ

The "ISO Mount" section allows users to manage and mount ISO images to their virtual machine. These ISO images are used for installing operating systems, recovery tools, and various software packages on the server. The interface is designed to provide a list of available ISO images, along with the option to view additional details and mount or unmount these images.

Key Features and Actions:

  1. Mounted ISO:

    • At the top of the section, the currently mounted ISO image is displayed. In this example, Windows Server 2019 English is shown as the mounted image.
    • Unmount Button: A red Unmount button is provided next to the mounted image, allowing users to unmount the ISO if they wish to detach it from the virtual machine.

  2. Available ISO Images:

    • Below the mounted ISO, a list of all available ISO images is displayed. Each ISO image is presented with the following information:
      • Name: The name of the ISO image, such as "Windows Server 2016 English (x86)" or "Debian 12.4 (arm64/netinstall)".
      • Mount Button: Each ISO has a yellow Mount button next to it, allowing users to mount the selected ISO image to the virtual machine.
      • Expandable Details: Some ISO images have additional details that can be expanded by clicking on the image name. These details include:
        • Id: A unique identifier for the ISO image.
        • Name: The full name of the ISO file, including its path.
        • Type: The type of the ISO image (e.g., public or private).
        • Size: The size of the ISO image in gigabytes.

  3. Managing ISO Images:

    • Users can click the Mount button next to any ISO image to mount it to the virtual machine. Once mounted, the ISO can be used to boot the server or perform installations.
    • If an ISO image is already mounted, mounting a new ISO will typically require unmounting the current image first.

  4. Search and Navigation:

    • The list of ISO images is scrollable, allowing users to navigate through all available options. This includes a variety of operating systems, recovery tools, and other software distributions.

image-1725262568682.png

Client Area

Reset Password Section Description

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ

The "Reset Password" section allows users to reset the password of their virtual machine through an automated process. This section is designed to be a quick and convenient way to regain access to the server if the password has been lost or needs to be changed.

Key Information:

  1. Important Warning:

    • The section prominently displays a warning in red text, stating that the password reset procedure will only work if the packages responsible for the operation of cloud-init have not been removed from the virtual machine. cloud-init is a tool used to initialize cloud instances, and it must be present for the automated password reset to function correctly.

  2. Additional Instruction:

    • Below the warning, there is an additional note in smaller text indicating that if the reset procedure was successful but the password was not changed, the user will need to manually connect to the virtual machine using the noVNC console, boot into safe mode, and change the password manually.

  3. Reset Password Button:

    • A green Reset password button is provided for users to initiate the password reset process. This button triggers the automated procedure that attempts to reset the virtual machine's password.

image-1725262815813.png

Client Area

Upgrade/Downgrade Options Section Description

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ

The "Upgrade/Downgrade Options" section allows users to modify the configurable options associated with their product or service. This interface is particularly useful for adjusting features like backup settings, among other configurable options.

Key Features and Actions:

  1. Current Configuration:

    • The section displays the current configuration of the product or service. This includes any active options or features that have been enabled or disabled. For example, the current status of the Backup option is shown here as "Yes" if it is enabled.

  2. New Configuration:

    • On the right side, the new configuration can be selected. Users can enable or disable options such as Backup by checking or unchecking the corresponding box. In this example, the Backup option is checked, indicating that backups will remain enabled or will be enabled if they were previously disabled.

  3. Backup Option:

    • Backup Toggle: This section specifically highlights the ability to toggle the backup feature on or off. By using this option, users can easily include or exclude backups as part of their service, directly influencing how their data is managed and protected.
    • Enabling backups can provide crucial data recovery options, while disabling it can save costs if the user decides backups are no longer necessary.

  4. Continue Button:

    • Once the desired configuration changes have been made, users can click the Continue button to proceed with applying the changes. This action will update the service with the new settings.

image-1725263068099.png

Admin Area

Admin Area

Product Information

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ

The "Product Information" section is a comprehensive dashboard that provides administrators with detailed information and control over a specific product or service associated with a user's account. This interface is critical for managing and troubleshooting the product, as well as for making configuration changes.

Key Elements:

  1. Order Information:

    • Order #: Displays the order number and provides a link to view the full order details.
    • Product/Service: Specifies the name of the product or service (e.g., "Hetzner product").
    • Server: Indicates the data center or server instance where the product is hosted.

  2. User and Server Details:

    • Hostname: The hostname assigned to the server.
    • Dedicated IP: The public IP address assigned to the server.
    • Username: The username associated with the server's access credentials.
    • Password: The password field shows the encrypted password or a placeholder for the server’s access credentials.
    • Status: The current status of the service (e.g., "Active").
    • Assigned IPs: Lists both IPv4 and IPv6 addresses assigned to the server.
    • Nameserver 1 & 2: The nameservers associated with the product.
    • Operating System: The operating system installed on the server (e.g., "debian-11").
    • Backup Option: Indicates whether the backup feature is enabled or disabled (in this case, "Yes").

  3. Billing and Subscription Details:

    • Registration Date: The date when the product or service was registered.
    • Quantity: The quantity of the product or service being managed.
    • First Payment Amount: The initial payment made for the service.
    • Recurring Amount: The recurring cost associated with the service.
    • Next Due Date: The next billing date for the service.
    • Termination Date: If applicable, the date when the service is scheduled to be terminated.
    • Billing Cycle: Indicates the billing cycle for the service (e.g., "Free").
    • Payment Method: The payment method used for the service (e.g., "PayPal").
    • Promotion Code: Displays any promotion code applied to the service.

  4. Module Commands:

    • API Connection Status: Displays the status of the API connection, which is necessary for managing the product through automated scripts or external systems. (e.g., "API answer OK").
    • Commands: Provides buttons for creating, suspending, unsuspending, terminating the service, changing the package, and sending a custom welcome email.

  5. Server Status:

    • This section provides real-time status information about the server:
      • Start/Stop: Indicates whether the server is running or stopped.
      • CPU, RAM, and Disk Usage: Displays the resource usage statistics for the server.
      • Datacenter: Indicates the data center location.
      • Public Network IPs: Shows the public IPv4 and IPv6 addresses assigned to the server.
      • Public Network DNS PTR: Displays the PTR record for reverse DNS.

  6. Metric Statistics:

    • This section shows various usage metrics and their statuses, including:
      • Floating IPv4/IPv6 addresses: Whether these are enabled and their current usage.
      • Bandwidth Usage: The amount of bandwidth used.
      • Snapshot Usage: The amount of disk space used by snapshots.
    • A Refresh Now button allows updating the metrics to display the latest data.

  7. Addons and Additional Information:

    • Addons: Lists any additional services or features associated with the product.
    • Hostname (Domain): Displays the domain associated with the product.
    • Password: Shows the password or its placeholder.
    • Subscription ID: Identifies the subscription tied to the service.
    • Override Auto-Suspend: Allows the administrator to prevent the service from being automatically suspended.
    • Auto-Terminate End of Cycle: Provides an option to terminate the service at the end of its billing cycle.
    • Admin Notes: Allows the administrator to add any notes or information relevant to the management of the service.

  8. Save or Cancel Changes:

    • Save Changes: A purple button to save any changes made in this section.
    • Cancel Changes: Allows the administrator to discard any modifications and revert to the previous settings.

IP Address Logging. The system now includes a mechanism that automatically tracks and logs all IP address changes. Every time a new IP address is added or an existing one is removed, a note is automatically added to the Admin Notes section. This note includes the date, time, and details of the IP changes. This feature ensures that all changes are documented for easy reference and auditing.

image-1725264544352.png

Admin Area

Product configuration in WHMCS

Hetzner Datacenter module WHMCS

 Order now | Download | FAQ

License key: A pre-purchased license key for the "PUQ Hetzner Datacenter" module. For the module to work correctly, the key must be active.

Server name: This option allows you to add a prefix string to the server name. A new name will be generated each time the create account function is called. When NameServer will only be present if the field is set: NameServer-[*user_id*]-[*service_id*].

Server type: The type of server to be deployed. This is selected from the available server types provided by Hetzner. This field is automatically populated based on your selection from Select Server and Location.

Server location: The physical location of the server. This is selected from the available locations provided by Hetzner. This field is automatically populated based on your selection from Select Server and Location.

Server placement groups: The placement groups for the server. This allows you to specify how the server should be grouped within the data center. This field is automatically populated based on your selection from the Select Placement Group.

Server image: The operating system image to be used for the server. This is selected from the available images provided by Hetzner. This field is automatically populated based on the selection from Select Image.

SSH keys: The SSH keys to be used for accessing the server. You can add multiple SSH keys. This field is automatically populated based on your selection from Select SSH Keys.

Server networks: The networks to which the server will be connected. This field is automatically populated based on your selection from Private Networks.

Server firewalls: The firewall rules to be applied to the server. You can select from predefined firewall rules or create custom ones. This field is automatically populated based on your selection from Select Firewalls.

User data: Custom user data to use during server creation. This field is limited to 32KB. You can use this to provide cloud-init configuration scripts or other initialization data.

Package setting: Additional settings for the package, including:

API Settings

Please pay attention to the order of filling in the API Settings section. Since different localizations have different networks, and some networks are not available in some localizations.

Select Server and Location: Choose the server type and location from the available options provided by Hetzner.

Select Image: Choose the operating system image for the server from the available options provided by Hetzner.

Please note that you have the ability to deploy services based on your backup or snapshots. In this way, you can prepare a service for the client.

Custom option name for image: Specify a custom option name for the server image if needed.

Custom option name for image parameter is only triggered during service deployment. You can pass image name that you want to use for server deployment.

Allow user to select ISO image: Enable this option to allow users to select an ISO image.

Allow user to reinstall service: Enable this option to allow users to reinstall the service from the client area.

Allow user to choose backup and snapshot when reinstalling service: Enable this option to allow users to choose a backup and snapshot when reinstalling the service.

Allow user to choose backup and snapshot when reinstalling service option allows users to find their snapshots and backups in the list and reinstall the system from a snapshot or backup.

Select Placement Group: Choose the placement group for the server from the available options provided by Hetzner.

Select SSH Keys: Choose the SSH keys to be used for accessing the server from the available options provided by Hetzner.

Public Networks: Configure the public network settings for the server. This includes enabling or disabling public IPv4 and IPv6 addresses.

If you want to turn off public networks, you need to select at least one private network.

Private Networks: Configure the private network settings for the server.

Select Firewalls: Choose the firewall rules to be applied to the server from the available options provided by Hetzner.

Email configuration: Setting up email templates. Selection of pre-prepared templates to inform the user about some actions:

Metric Billing: Configuration for metric billing, including:

settingsHetznerDatacenter.png