WHMCS¶

In this article

• WHMCS. Key Features
• Deployment Features
• Getting Started after Deploying WHMCS
• Initial WHMCS Configuration
• Connecting to the Server via SSH
• Configuring License Key and Database
• Creating Administrator Account
• Completing Installation
• Logging Into the System
• Initial System Setup
• Configuring Addons and Modules
• Configuring HOSTKEY VPS/Dedicated Module
• Currency Configuration
• Ordering a server with WHMCS using the API

WHMCS. Key Features¶

• WHMCS automates everyday tasks and operations, including billing, invoicing, client management, and support request processing;
• The platform easily integrates with all leading control panels, payment systems, domain registrars, and cloud services;
• WHMCS supports major payment gateways such as PayPal, Google Checkout, and Authorize.Net, including support for multiple currencies and promotional campaigns;
• The system includes a full-featured shopping cart, allowing visitors to purchase web hosting services in one place;
• WHMCS provides domain management tools, including registration, renewal, and transfer of domain names;
• Built-in customer support system with ticket creation and tracking, knowledge base, and notification system;
• The platform offers advanced analytics and real-time reporting for business decision-making;
• WHMCS is a flexible, scalable, and extensible platform with hundreds of available applications and integrations for all leading service providers;
• The system includes a powerful API for developers and deep customization capabilities to meet business needs;
• WHMCS provides mobile applications for managing business on the go and remote administration.

Deployment Features¶

• Minimum system requirements for WHMCS installation:

  • Processor: 2 cores, 64-bit;
  • RAM: 4 GB;
  • Disk space: 20 GB HDD.

• Recommended system requirements:

  • Processor: 4+ cores, 64-bit;
  • RAM: 8+ GB;
  • Disk space: 50+ GB SSD.

• Installation structure:

  • Main WHMCS files: /var/www/html/whmcs/;
  • Configuration panel: /opt/panel/;
  • Logs and cache: /var/log/, /var/cache/;
  • SSL certificates: /var/www/certbot/.

Web interface will be available at: https://whmcs{Server_ID_from_Invapi}.hostkey.in

Admin panel: https://whmcs{Server_ID_from_Invapi}.hostkey.in/admin

Getting Started after Deploying WHMCS¶

After payment, an email will be sent to the registered address indicating that the server is ready for use. It will include the VPS IP address as well as login and password for connection. Our company's clients manage equipment through the server management panel and API — Invapi.

Authorization data can be found in the Info >> Tags section of the server control panel or in the sent email:

• Link to access WHMCS web interface: in tag webpanel;
• Username and Password for server management: sent via email to your address when the server is delivered.

Initial WHMCS Configuration¶

Connecting to the Server via SSH¶

Before starting WHMCS installation, you need to connect to the server via SSH to execute commands in the terminal.

ssh root@<Server_IP>

1. The system will ask for connection confirmation - enter yes;
2. Enter the password for the specified user;
3. After successful connection, you will see the server command line.

Configuring License Key and Database¶

On the first installation screen, you need to enter the following data:

License Key¶

• Enter your license key in the License Key field.

Database Settings¶

Fill in the following fields to connect to MySQL database:

• Database Host: localhost;
• Database Port: 3306 (standard MySQL port);
• Database Username: whmcs_user (database username);
• Database Password: enter the password for database access (matches the password for SSH server connection);
• Database Name: whmcs_db (database name).

After filling all fields, click Continue:

Creating Administrator Account¶

On the second screen, you need to configure the administrator account:

Fill in the required fields:

• First Name: administrator's first name;
• Last Name: administrator's last name;
• Email: administrator's email address;
• Username: administrator's username;
• Password: password;
• Confirm Password: password confirmation.

After filling all fields, click Complete Setup:

Completing Installation¶

After successful installation, a screen with confirmation and next steps will appear:

Mandatory security actions:¶

1. Delete installation folder

   Connect to the server via SSH and execute the command:

   rm -rf /var/www/html/whmcs/install/
   

   

2. To log into the administrative panel, return to the web interface and click Go to the Admin Area Now:

   

Logging Into the System¶

After installation completion, use the created credentials to log in:

1. Enter Username (administrator's login);
2. Enter Password (administrator's password);
3. Optionally check Remember Me to save the session;
4. Click Login:

Initial System Setup¶

After successfully logging into the WHMCS admin panel, the main management dashboard will open:

5.1 Dashboard Overview¶

On the main page you will see:

• Statistics of orders, tickets, and cancellations;
• System information (version 8.13.1);
• System activity graphs;
• PayPal integration suggestions.

5.2 Access to System Settings¶

To configure the system:

1. Click on the icon in the upper right corner;
2. Select System Settings from the dropdown menu:

Configuring Addons and Modules¶

6.1 Navigating to Addon Management¶

1. In the System Settings section, find and click on the Apps & Integrations section title;
2. Select Addon Modules to manage additional modules:

6.2 Activating Required Modules¶

In the list of available addons, you will find:

• Bulk Pricing Updater - for bulk price updates;
• Google Analytics - for analytics integration;
• HOSTKEY VPS/Dedicated - for server management;
• Licensing Manager - for license management;
• MailChimp - for email marketing;
• PayPal Transaction Lookup - for PayPal transaction search;
• Project Management - for project management;
• Staff Notifboard - for staff notifications.

To activate a module, click the Activate button next to the required addon.

Configuring HOSTKEY VPS/Dedicated Module¶

After activating the HOSTKEY VPS/Dedicated module in the Addon Modules section, you need to configure API keys for integration with HOSTKEY services.

7.1 Obtaining API Key¶

1. In server management panel and API — Invapi, in the server card find the API keys & control panel section (marked as "new!")
2. Click the Add new button to create a new API key:

7.2 Creating API Key¶

In the opened "Add new API key and control panel" window:

1. In the Name field, enter a name for the key (for example, my_api_key);
2. In the IP ACL field, you can specify IP addresses to restrict access (leave empty for unrestricted access);
3. Make sure the Active checkbox is checked;
4. Click the Create button:

7.3 Saving API Key¶

After creating the key, the system will show a confirmation window:

1. Important! Copy and save the displayed API key in a secure place (highlighted with red background);
2. This key will no longer be shown in the control panel - only its hash is saved;
3. Also save the server management panel link;
4. Click OK to complete.

7.4 Configuring Module in WHMCS¶

1. In WHMCS, go to Addons → HOSTKEY VPS/Dedicated;
2. In the API Key field, paste the obtained API key;
3. In the API URL field, specify: https://invapi.hostkey.com/:

7.5 Configuring Product Import¶

In the Select products to resell section:

1. Check the required product types for import:

   • Import VPS products - for importing VPS servers;
   • Import Bare metal products - for importing dedicated servers;
   • Import GPU products - for importing GPU servers.

2. Configure markup pricing for each product type:

   • Enter markup percentage in the corresponding fields;
   • Select markup type from the dropdown list.

3. In the Round price to field, select price rounding rules;

4. In the Email template field, select email notification template.

7.6 Importing Products¶

After completing the configuration, click the Import products/Adjust prices button to import products from HOSTKEY catalog into your WHMCS system.

The system will automatically create products with all necessary characteristics and configured prices according to the specified markup.

Currency Configuration¶

8.1 Accessing Currency Settings¶

1. In the sidebar menu, select Payments;
2. Click on Currencies.

8.2 Adding Additional Currency¶

By default, the system is configured for USD. To add a new currency (for example, EUR):

1. In the Add Additional Currency section, fill in the fields:

   • Currency Code: EUR
   • Prefix: €
   • Suffix: EUR
   • Format: select display format (for example, 1234.56)
   • Base Conv. Rate: specify conversion rate to base currency (for example, 1.00)

   

2. Click the Add Currency button to save settings.

8.3 Configuring Currency Rates¶

The system allows configuring automatic currency rate updates or setting them manually through the Base Conv. Rate field.

Ordering a server with WHMCS using the API¶

To install this software using the API, follow these instructions

Some of the content on this page was created or translated using AI.