update README

This commit is contained in:
Yuri Karamian
2025-12-16 22:08:31 +01:00
parent b4529ee9b2
commit 94bc3045b8
+123 -10
View File
@@ -1,24 +1,138 @@
# WHMCS VPS Management Module - ArkHost VPSAG # WHMCS VPS Management Module - ArkHost VPSAG
A WHMCS server module for VPS management with multi-language support. A WHMCS server module for VPSAG VPS management with multi-language support.
**Note:** Originally based on [andretunes/whmcs-module-vpsag](https://github.com/andretunes/whmcs-module-vpsag). Current version has been substantially rewritten. **Note:** Originally based on [andretunes/whmcs-module-vpsag](https://github.com/andretunes/whmcs-module-vpsag). Current version has been substantially rewritten.
## Features ## Features
- VPS control (start/stop/restart) - VPS provisioning and lifecycle management
- Backup management - VPS control (start/stop/restart/shutdown)
- Backup management (create/restore/delete)
- Firewall configuration - Firewall configuration
- OS reinstallation with advanced options - OS reinstallation with SSH key injection and post-install scripts
- Resource monitoring - Resource monitoring with graphs
- VNC console access - VNC console access
- 8 language support - Hostname and rDNS management
- Responsive design - ISO mounting
- 8 language support (English, Dutch, French, German, Italian, Portuguese, Russian, Spanish)
- Responsive client area design
## Requirements ## Requirements
- WHMCS 8.9+ - WHMCS 8.9+
- PHP 7.4+ - PHP 7.4+
- VPSAG reseller account with API access
## Installation
1. Upload the `ArkhostVPSAG` folder to `/modules/servers/` in your WHMCS installation
2. Navigate to **Setup > Products/Services > Servers** in WHMCS admin
3. Add a new server with:
- **Module:** ArkhostVPSAG
- **Hostname:** `www.vpsag.com`
- **Username:** Your VPSAG API username
- **Password:** Your VPSAG API key
4. Click **Test Connection** to verify credentials
## Product Configuration
### Creating a Product
1. Go to **Setup > Products/Services > Products/Services**
2. Create a new product or edit an existing one
3. Under **Module Settings** tab:
- **Module Name:** ArkhostVPSAG
- **Server Group:** Select your VPSAG server group
### Configurable Options
The module uses two primary configurable options that are dynamically populated from the VPSAG API:
| Option | Config Key | Description |
|--------|------------|-------------|
| **Plan ID** | `configoption1` | VPS plan - dropdown populated from `/api/v1/plans` showing plan names with prices |
| **OS ID** | `configoption2` | Operating system - dropdown populated from `/api/v1/os/plan/{plan_id}` based on selected plan |
#### Setting Up Configurable Options
You can override the default product options using WHMCS Configurable Options:
1. Go to **Setup > Products/Services > Configurable Options**
2. Create a new group and link it to your VPSAG product(s)
3. Add options with these exact names:
- `planid` - To allow customers to select different plans
- `osid` - To allow customers to select their OS during order
The module checks for configurable options first, then falls back to product-level settings.
### Callback URL
For automatic provisioning updates (IP, password delivery), configure your callback URL in VPSAG:
```
https://yourdomain.com/modules/servers/ArkhostVPSAG/callback.php
```
The callback handler:
- Validates requests using SHA256 signature verification
- Updates service with username, password, IPs (IPv4/IPv6)
- Sets VPS label to `WHMCS {service_id}` for easy identification
## Module Functions
### Client Area Actions
| Action | Description |
|--------|-------------|
| Start/Stop/Restart | Basic power controls |
| VNC Console | Browser-based console access |
| Reinstall OS | Fresh install with optional SSH key and post-install script |
| Reset Root Password | Generate new root password |
| Hostname/rDNS | Set hostname and reverse DNS |
| Graphs | View CPU, RAM, disk, network usage over time |
| Backups | Create, restore, and delete backups |
| Firewall | Add/remove rules, commit changes |
| ISO | Mount/unmount ISO images |
### Admin Actions
| Action | Description |
|--------|-------------|
| Start/Stop/Reboot | Power controls from admin panel |
| VNC Console | Direct VNC link |
| Suspend/Unsuspend | Service suspension management |
| Terminate | Cancel VPS at VPSAG |
| Change Package | Upgrade to higher plan |
### Sidebar Buttons
The module adds custom sidebar buttons to the client area:
- Start, Stop, Restart, VNC Console
## API Integration
Base URL: `https://www.vpsag.com/api/v1/`
Authentication headers:
- `X_API_USER`: API username
- `X_API_KEY`: API key
The module handles all API communication internally with:
- TLS 1.2 enforcement
- 15-second timeout
- Full request/response logging via WHMCS module log
## VPS ID Storage
The VPS ID is stored in WHMCS service properties with key `vpsag|VPSAG ID` in format `VPSAG-{numeric_id}`.
## Language Customization
Override translations by creating files in:
```
/modules/servers/ArkhostVPSAG/lang/overrides/{language}.php
```
## Screenshots ## Screenshots
@@ -50,10 +164,9 @@ A WHMCS server module for VPS management with multi-language support.
- Resource Usage Card (RAM, Bandwidth, CPU) - Resource Usage Card (RAM, Bandwidth, CPU)
- Quick Actions Card (Start/Stop, Restart, VNC Console) - Quick Actions Card (Start/Stop, Restart, VNC Console)
- Fixed Quick Actions button functionality - Fixed Quick Actions button functionality
- Completed all language translations (8 languages: English, Dutch, French, German, Italian, Portuguese, Russian, Spanish) - Completed all language translations (8 languages)
- Enhanced UI styling with gradient backgrounds and smooth animations - Enhanced UI styling with gradient backgrounds and smooth animations
- Improved responsive design and layout consistency - Improved responsive design and layout consistency
- Removed duplicate VPS Information section
### Version 1.3 ### Version 1.3
- Enhanced API integration - Enhanced API integration
@@ -79,7 +192,7 @@ A WHMCS server module for VPS management with multi-language support.
## Credits ## Credits
Originally based on work by [andretunes](https://github.com/andretunes/whmcs-module-vpsag) Originally based on work by [andretunes](https://github.com/andretunes/whmcs-module-vpsag)
Substantially rewritten and extended by ArkHost Substantially rewritten and extended by ArkHost
## License ## License