|
1 | | -# Cpanel Addon for VPS Module in MyAdmin |
| 1 | +# cPanel VPS Addon for MyAdmin |
2 | 2 |
|
3 | | -Cpanel Addon for VPS Module in MyAdmin |
| 3 | +[](https://github.com/detain/myadmin-cpanel-vps-addon/actions/workflows/tests.yml) |
| 4 | +[](https://packagist.org/packages/detain/myadmin-cpanel-vps-addon) |
| 5 | +[](https://packagist.org/packages/detain/myadmin-cpanel-vps-addon) |
| 6 | +[](https://packagist.org/packages/detain/myadmin-cpanel-vps-addon) |
4 | 7 |
|
5 | | -## Build Status and Code Analysis |
| 8 | +A MyAdmin plugin that provides cPanel license management as a VPS addon. This package integrates with the MyAdmin hosting management platform to allow automated provisioning, activation, and deactivation of cPanel licenses on VPS instances. |
6 | 9 |
|
7 | | -Site | Status |
8 | | ---------------|--------------------------- |
9 | | - | [](https://travis-ci.org/detain/myadmin-cpanel-vps-addon) |
10 | | - | [](https://codeclimate.com/github/detain/myadmin-cpanel-vps-addon) [](https://codeclimate.com/github/detain/myadmin-cpanel-vps-addon/coverage) [](https://codeclimate.com/github/detain/myadmin-cpanel-vps-addon) |
11 | | - | [](https://scrutinizer-ci.com/g/myadmin-plugins/cpanel-vps-addon/?branch=master) [](https://scrutinizer-ci.com/g/myadmin-plugins/cpanel-vps-addon/?branch=master) [](https://scrutinizer-ci.com/g/myadmin-plugins/cpanel-vps-addon/build-status/master) |
12 | | - | [](https://www.codacy.com/app/detain/myadmin-cpanel-vps-addon) [](https://www.codacy.com/app/detain/myadmin-cpanel-vps-addon?utm_source=github.com&utm_medium=referral&utm_content=detain/myadmin-cpanel-vps-addon&utm_campaign=Badge_Coverage) |
13 | | - | [](https://coveralls.io/github/detain/myadmin-cpanel-vps-addon?branch=master) |
14 | | - | [](https://packagist.org/packages/detain/myadmin-cpanel-vps-addon) [](https://packagist.org/packages/detain/myadmin-cpanel-vps-addon) [](//packagist.org/packages/detain/myadmin-cpanel-vps-addon) [](https://packagist.org/packages/detain/myadmin-cpanel-vps-addon) [](https://packagist.org/packages/detain/myadmin-cpanel-vps-addon) [](https://packagist.org/packages/detain/myadmin-cpanel-vps-addon) |
| 10 | +## Features |
15 | 11 |
|
| 12 | +- Automated cPanel license activation when a VPS addon is purchased |
| 13 | +- Automated cPanel license deactivation on cancellation with admin email notification |
| 14 | +- IP-based license status checking before activation/deactivation |
| 15 | +- Integration with MyAdmin's event dispatcher for hook-based plugin loading |
| 16 | +- Configurable addon cost via the MyAdmin settings interface |
16 | 17 |
|
17 | 18 | ## Installation |
18 | 19 |
|
19 | | -Install with composer like |
| 20 | +Install via Composer: |
20 | 21 |
|
21 | 22 | ```sh |
22 | 23 | composer require detain/myadmin-cpanel-vps-addon |
23 | 24 | ``` |
24 | 25 |
|
25 | | -## License |
| 26 | +The package registers itself automatically through the MyAdmin plugin system. The following event hooks are registered: |
| 27 | + |
| 28 | +| Event | Handler | Purpose | |
| 29 | +|-------------------------|--------------------|--------------------------------------------| |
| 30 | +| `function.requirements` | `getRequirements` | Registers the page requirement function | |
| 31 | +| `vps.load_addons` | `getAddon` | Registers the cPanel addon with the VPS module | |
| 32 | +| `vps.settings` | `getSettings` | Adds the cPanel cost setting to the admin UI | |
| 33 | + |
| 34 | +## Configuration |
| 35 | + |
| 36 | +The addon cost is configurable through the MyAdmin admin panel under VPS module settings. The setting `VPS_CPANEL_COST` controls the price charged for the cPanel license addon. |
26 | 37 |
|
27 | | -The Cpanel Addon for VPS Module in MyAdmin class is licensed under the LGPL-v2.1 license. |
| 38 | +## Running Tests |
| 39 | + |
| 40 | +```sh |
| 41 | +composer install |
| 42 | +vendor/bin/phpunit |
| 43 | +``` |
| 44 | + |
| 45 | +To generate a coverage report: |
| 46 | + |
| 47 | +```sh |
| 48 | +vendor/bin/phpunit --coverage-html build/coverage |
| 49 | +``` |
| 50 | + |
| 51 | +## License |
28 | 52 |
|
| 53 | +This package is licensed under the [LGPL-2.1](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html) license. |
0 commit comments