From 36c930bf98be29dba36494546852951d1b40095d Mon Sep 17 00:00:00 2001 From: Stefan Pejcic Date: Wed, 1 May 2024 15:59:34 +0200 Subject: [PATCH] Update 0.1.7.md --- documentation/docs/changelog/0.1.7.md | 53 +++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/documentation/docs/changelog/0.1.7.md b/documentation/docs/changelog/0.1.7.md index 4094068..bb9c6dc 100644 --- a/documentation/docs/changelog/0.1.7.md +++ b/documentation/docs/changelog/0.1.7.md @@ -8,6 +8,7 @@ hide_table_of_contents: true Not yet released. ### 🚀 New features +- [WHMCS Module and RESTATPI](#whmcs-module) - [Cronjobs can now be enabled/disabled and run on demand](#cron-disable) - [Ubuntu 24.04 images](#ubuntu24-images) - [Admin users can now be edited: rename, change password, suspend/unsuspend from OpenAdmin interface](#edit-admin-users) @@ -45,6 +46,58 @@ Not yet released. ---- +### WHMCS Module + +WHMCS module is now available for OpenPanel. +Currently supported actions are: + +- ✅ create account +- ✅ change password +- ✅ suspend account +- ✅ unsuspend account +- ✅ terminate account +- ✅ autologin from frontend +- ✅ autologin from backend +- ❌ get disk usage for account +- ❌ change package + +To setup WHMCS to use your OpenPanel server follow these steps: + +1. **Enable API access on OpenPanel server** + First make sure that API access is enabled by going to `OpenAdmin > API` or by running `opencli config get api` from the terminal: + ![enable_api](https://i.postimg.cc/L6vwMQ4t/image.png) + If API is not enabled, click on the "Enable API access" button or from terminal run `opencli config update api on`. + + We recommend creating new Administrator user for API, to create a new user navigate to *OpenAdmin > OpenAdmin Settings* and create new admin user, or from terminal run: `opencli admin new USERNAME_HERE PASSWORD_HERE` + +2. **Install OpenPanel WHMC Module** + Login to SSH for WHMCS server + Navigate to `path_to_whmcs/modules/servers` + Run this command to create a new folder and in it download the module: `git clone https://github.com/stefanpejcic/openpanel-whmcs-module.git openpanel` + +3. **Establish connection between the two servers** + On OpenPanel server make sure that the OpenAdmin port 2087 is open on `OpenAdmin > Firewall` or whitelist the IP adress of your WHMCS server. + to whitelist ip address from terminal run: `ufw allow from WHMCS_IP_HERE` + + On WHMCS server also make sure that the 2087 port is opened or whitelist the IP address of your OpenPanel server. + From WHMS navigate to: *System Settings > Products & Services > Servers* + ![screenshot](https://i.postimg.cc/MHWpL3tc/image.png) + Click on *Create New Server* and under module select **OpenPanel** then add OpenPanel server IP, username and password for the OpenAdmin panel: + ![screenshot][https://i.postimg.cc/3Jh3nqWY/image.png] + +4. **Create hosting pachages** + Hosting packages need to be created on both OpenPanel and WHMCS servers. + On OpenPanel server login to admin panel and on `OpenAdmin > Plans` create hosting packages that you will be assinging to users on WHMCS. + + On the WHMCS server create first a new group and then create new plans under this group. When creating products, make sure to select OpenPanel for Module and the newly created group + ![screenshot2](https://i.postimg.cc/NLvF4GSc/image.png) + +5. **Test creating new accounts** + Create an order and create a new order to test OpenPanel API. + +--- + + ### Improved install - `git` is now removed from the install script