KeyHelp - Fossmanager
How to Install the FOSSBilling KeyHelp Manager by ModGecko.
Module Version: v0.0.1 (BETA) | Author: @Pyryxe (Hadrian) part of the ModGecko team.
This guide walks you through integrating KeyHelp with FOSSBilling using the custom Server Manager module. This
integration allows for automated account provisioning, suspension, and management directly from your billing panel.
📋 Prerequisites
Before proceeding, ensure your environment meets the following requirements:
- FOSSBilling Version: v0.7.2 or later.
- PHP Version: 8.2 or later.
- KeyHelp Server: Admin access to generate an API Key (API v2).
🛠️ Step 1: Install the Module
1. Download the module file from the repository.
2. Upload or clone the files into your FOSSBilling installation directory at the following path:
/library/Server/Manager/KeyHelp (Note: Ensure the folder name is exactly KeyHelp so FOSSBilling detects the class
correctly).
⚙️ Step 2: Configure the Server
1. Log in to your FOSSBilling Admin Panel.
2. Navigate to System → Settings → Hosting.
3. Click "New Server".
4. Fill in the "Connection" tab details:
- Name: KeyHelp Server (or your preferred name).
- Hostname: Your KeyHelp server's IP address or hostname (e.g., server.example.com).
- Server Manager: Select KeyHelp from the dropdown list (Remember the KeyHelp might be shown as being blank but
don't worry it's still working.)
- Username: (Leave blank currently unused by the API).
- Password: [IMPORTANT] Paste your KeyHelp API Key here.
5. Click Save.
⚠️ Note: The KeyHelp API Key is stored in the "Password" field for this module.
📦 Step 3: Configure Your Products
For the module to know which package to deploy on the KeyHelp server, you must configure your products with a specific
custom parameter.
1. Navigate to Products → Products & Services.
2. Edit the hosting product you wish to link.
3. Go to the Configuration tab.
4. Under "Custom Configuration" (or Product Configuration), add the following parameter:
- Variable Name: id_hosting_plan
- Value: [Your_Plan_ID]
5. Click Save.
Finding your Plan ID: Do not use the name of the plan (e.g., "Gold Plan"). You must use the numeric ID. To find this ID:
Open KeyHelp, edit the Hosting Plan template, and look at the URL in your browser address bar. It will look like
...&id=12. In this case, your ID is 12.
🛑 Limitations & Beta Notice
Please be aware of the following operational notes:
- Beta Status: This module is currently in BETA. Please test thoroughly before using in a production environment.
- Immutable Fields: KeyHelp does not support changing Usernames, Domains, or IP addresses via API after creation.
- Resellers: Reseller login URLs are not currently supported.
🐛 Support & Bugs
This software is open-source (GPLv3).
- Bug Reports: Please open an issue on the GitHub Repository.
- Community: Join our Discord for setup assistance.