Module Installation for Hetzner Storage Box for WHMCS

Hetzner Storage Box Automation for WHMCS is a highly convenient tool for anyone looking to automate the management of their Hetzner Cloud Storage services as backup solution.

This module enables your clients to remotely store backups (offsite) of 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 Storage Box 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 StorageBox

    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.
    e. Pricing times is set for future.

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 StorageBox

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

   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 StorageBox
2. Here you can list down all your Storage Boxes

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 StorageBox
   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. Storage Prefix – Since we have selected Product Type (Previous step) as Other its mandatory to provide default Prefix example – whmcs (lower case only)
    b. Project ID – Select the project ID to which the Cloud StorageBox will be created
    c. Plan Name – Select the plan name for the product
    d. Environment  – A tag for identification
    e. Other options ( Samba/ ZFS/SSH (Secure)/WebDAV/Reachable externally ) select these as you wish to provide the service to your end users
    f. Whitelabel - If checked it wont show u1337.your-storagebox.de rather will show its IP address
    p. Save Changes – Once all done click on Save changes

5. Custom Fields – You can verify but not required to do any changes ( they are for setuped automatically such as location)

Assigning a server to a user

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

Importing a server into WHMCS

1. Go to Addons > Hetzner StorageBox and click on View StorageBox
2. Search your storage box and you would see it's storageId and projectId ( note down these 2 values )

Assigning the imported StorageBox to the end user

1. Search for the user to whom you wanted to assign the StorageBox and got that user’s profile and click on edit icon of the service for which we will assign the server
2. In StorageId custom field put the coped/ noted storageId and projectId in the format storageId_projectId (e.g. 124893_1 ) where 124893 is for storageId and 1 is projectId
3. Now do a save changes and we are done.