Difference between revisions of "WebsitePanel"

Latest revision as of 18:35, 21 April 2022

About this Module

This module only supports WebsitePanel v1.x. A WebsitePanel v2.x module is available from WebsitePanel directly.

The WebsitePanel module allows you to add and manage WebsitePanel servers in WHMCS.

Supported Features

Create	Suspend	Unsuspend	Terminate
Yes	Yes	Yes	Yes

Change Package	Change Password	Usage Updates	Client Area Link
Yes	Yes	Yes	Yes

The following ports should be open for outbound connections from your WHMCS server: 9001 & 9002

Adding a WebsitePanel Server

To set up a WebsitePanel server in WHMCS:

Make certain that your server's PHP complication includes SOAP.
- You can check this at Utilities > System > PHP Info.
- WHMCS Technical Support cannot assist with recompiling PHP. For help, contact your system administrator or hosting provider.
Go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.
Click Add New Server.
Select WebsitePanel from the menu.
Enter the hostname or IP address.
Enter the username and password or the access hash.
Click Continue.
Enter the desired additional server details.
Click Create Server.
If this is the only WebsitePanel server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.

Creating an WebsitePanel Product

You can create a product that provisions accounts on your WebsitePanel server at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services.

When you do this, make certain that you configure the following settings correctly:

Package Name — Enter the package name. This also becomes the hosting space name in WebsitePanel.
Parent SpaceID — Enter the space ID under which you will create all of your accounts.
Different Portal URL — Check if your panel portal is on a different hostname. If you check this, enter the full URL for Portal URL.
Send DNP Account Summary email — Check to cause WebsitePanel to send an account creation email in accordance with the reseller policies.
Create Mail account — Check to create a default mail account in accordance with the reseller mail policy.
Temporary domain — Check to create a temporary domain on account creation.
Create Website — Check to create a website for the domain in the hosting space.
PlanID — Enter the WebsitePanel plan ID as it appears in the URL in WebsitePanel editing the plan. For example, in http://servername.com/editPlan.php?ID=5 the ID to enter is 5.
Enterprise Server Port — Enter the port to use to connect. The default is 9002. You can configure this using the WebsitePanel configuration utility.
Send DNP Hosting Space Summary email — Check to send a summary of the hosting plan at account creation.
Create FTP account — Check to create an FTP account with the same username and password as the WebsitePanel account, however will be prefixed/suffixed as per your reseller account FTP account policies
HTML email — Check to send emails from WebsitePanel for bandwidth use, password reminders, and similar needs.

WHMCS Connect

This module does not support WHMCS Connect.

Troubleshooting

Undefined Error: -300

This means the Space ID under Module Settings at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services is incorrect. Entering the correct value will resolve this error, we've seen users enter the reseller ID instead of the space ID in the past so that's worth checking.

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible

@@ Line 1: / Line 1: @@
-==Additional Requirement==
+== About this Module ==
-The WebsitePanel module requires SOAP compiled in your server's PHP configuration. In your WHMCS administration navigate to '''Utilities > PHP Info''' if you see no mention of SOAP then it is likely you will need to recompile.
-WHMCS technical support cannot assist with recompiling PHP, please contact your server admin/hosting provider for assistance.
+<div class="docs-alert-info">
+This module only supports WebsitePanel v1.x. A WebsitePanel v2.x module is [http://www.websitepanel.net/downloads/ available from WebsitePanel directly].
+</div>
-==Adding a WebsitePanel server==
+The WebsitePanel module allows you to add and manage WebsitePanel servers in WHMCS.
+{{Provisioning_Module
+| changepackage = Yes
+| changepw = Yes
+| usageupdates = Yes
+| clientarealink = Yes
+| port = 9001 & 9002}}
+== Adding a WebsitePanel Server ==
+To set up a WebsitePanel server in WHMCS:
-#Begin by going to Setup > Servers
+# Make certain that your server's PHP complication includes SOAP.
-#Click Add New Server
+#* You can check this at '''Utilities > System > [[PHP Info]]'''.
-#In the server details box, select the server type "WebsitePanel" from the dropdown menu.
+#* WHMCS Technical Support cannot assist with recompiling PHP. For help, contact your system administrator or hosting provider.
-#Enter the IP/Hostname of your '''Enterprise server''' install
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
-#Enter the username and password for the account that has permissions to create your users. The account has to be a reseller account with permissions to create packages under the top level hosting space your customers will be created under.
+# Click '''Add New Server'''.
-#Tick SSL if you wish to connect using a SSL connection
+# Select ''WebsitePanel'' from the menu.
+# Enter the hostname or IP address.
+# Enter the username and password or the access hash.
+# Click '''Continue'''.
+# Enter the desired additional server details.
+# Click '''Create Server'''.
+# If this is the only WebsitePanel server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.
+=== Creating an WebsitePanel Product ===
+You can create a product that provisions accounts on your WebsitePanel server at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
-==Setting up a WebsitePanel Package==
+When you do this, make certain that you configure the following settings correctly:
-To create a WebsitePanel package:
+* '''Package Name''' — Enter the package name. This also becomes the hosting space name in WebsitePanel.
+* '''Parent SpaceID''' —  Enter the space ID under which you will create all of your accounts.
+* '''Different Portal URL''' — Check if your panel portal is on a different hostname. If you check this, enter the full URL for '''Portal URL'''.
+* '''Send DNP Account Summary email''' — Check to cause WebsitePanel to send an account creation email in accordance with the reseller policies.
+* '''Create Mail account''' — Check to create a default mail account in accordance with the reseller mail policy.
+* '''Temporary domain''' — Check to create a temporary domain on account creation.
+* '''Create Website''' — Check to create a website for the domain in the hosting space.
+* '''PlanID''' — Enter the WebsitePanel plan ID as it appears in the URL in WebsitePanel editing the plan. For example, in <tt><nowiki>http://servername.com/editPlan.php?ID=5</nowiki></tt> the ID to enter is <tt>5</tt>.
+* '''Enterprise Server Port''' — Enter the port to use to connect. The default is <tt>9002</tt>. You can configure this using the WebsitePanel configuration utility.
+* '''Send DNP Hosting Space Summary email''' — Check to send a summary of the hosting plan at account creation.
+* '''Create FTP account''' — Check to create an FTP account with the same username and password as the WebsitePanel account, however will be prefixed/suffixed as per your reseller account FTP account policies
+* '''HTML email''' — Check to send emails from WebsitePanel for bandwidth use, password reminders, and similar needs.
-# Go to Setup > Products/Services
+=== WHMCS Connect ===
-# Click ''Create new product''
-# Select "Shared Hosting Account" from the Product Type drop down list
-# Enter a name and select a product group if relevant and click next
-# Select the "Module settings" tab
-# In the Module Name drop down list, select WebsitePanel
-There are several settings here that must be set in order for the module to function correctly
+This module does not support [[WHMCS Connect]].
-#'''Package Name''' - The name you give the package, this will also be the hosting space name in WSP
+==Troubleshooting==
-#'''PlanID''' - This is the WSP plan ID, this can be found by looking in the query string in WSP when editing the plan. It shows in the address bar something like http://servername.com/editPlan.php?ID=5 and in that case the Plan ID would be 5 that you need to enter into WHMCS.
-#'''Parent SpaceId''' -  Space ID that all packages will be created under, e.g. 1 for serveradmin etc, Again, can be got from the query string in WSP
-#'''Enterprise Server Port''' - The port to connect to ES with, default is 9002. This is set when you install WSP and can be configured using the WSP configuration utility.
-The optional settings that can be set are:
+===Undefined Error: -300===
-#'''Different Portal URL''' - Tick this if your panel portal is on a different hostname to ES. If ticked, set the full URL in the "Portal URL" text box
+This means the Space ID under '''Module Settings''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services''' is incorrect. Entering the correct value will resolve this error, we've seen users enter the reseller ID instead of the space ID in the past so that's worth checking.
-#'''Send WSP Account Summary email''' - If ticked, WSP will send out an email when the account is created as defined in the reseller policies.
-#'''Send WSP Hosting Space Summary email''' - If ticked wills end hour a summary of the Hosting plan when created as defined in the reseller policies.
-#'''Create Mail account''' - If ticked a default mail account will be created as defined in the reseller mail policy
-#'''Create FTP account''' - If ticked a FTP account will be created with the same username and password as the WSP account, however will be prefixed/suffixed as per your reseller account FTP account policies
-#'''Temporary domain''' - If ticked and enabled in WSP policies, a temporary domain will be created
-#'''HTML email''' - If ticked user in WSP will be sent HTML email from WSP(for bandwidth usage, password reminders etc)
-#'''Create Website''' - If ticked a website for the domain will be created under the hosting space
-==Common Problems==
+{{modules}}
-===Undefined Error: -300===
-This means the Space ID under Setup > Products/Services > Edit > Module Settings tab > Parent SpaceId is incorrect. Entering the correct value will resolve this error, we've seen users enter the reseller ID instead of the space ID in the past so that's worth checking.

Documentation