Difference between revisions of "Ensim"

Latest revision as of 18:36, 22 April 2022

About this Module

We deprecated and removed this module in WHMCS 6.0.

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

This module only works for Ensim servers that are local to the WHMCS installation.
This module requires access to the sudo command.
You must comment out Defaults requiretty in the /etc/sudoers file in order to allow the sudo command access to PHP.

Supported Features

Create	Suspend	Unsuspend	Terminate
Yes	Yes	Yes	Yes

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

Adding a Ensim Server

To set up a Ensim server in WHMCS:

Go to Setup > Products/Services > Servers.
Click Add New Server.
Select EnsimX from the menu.
Enter server details.
Click Save.
Create symbolic links to the VirtDomain scripts on the local Ensim server. You will need to be logged in as the root account for this step. For example:
cd /usr/local/bin
ln -s AddVirtDomain AddVirtDomain-PASSWORD
ln -s DeleteVirtDomain DeleteVirtDomain-PASSWORD
ln -s EnableVirtDomain EnableVirtDomain-PASSWORD
ln -s DisableVirtDomain DisableVirtDomain-PASSWORD
ln -s EditVirtDomain EditVirtDomain-PASSWORD
ln -s AddReseller AddReseller-PASSWORD
Where PASSWORD is the server password.
Copy the ChangeDomainPasswd-PASSWORD file from the zip file to /usr/local/bin.
Edit the /etc/sudoers file. Add the following lines to the end of the file, substituting your link names:
Cmnd_Alias ENSIM = /usr/local/bin/AddVirtDomain-PASSWORD, \
/usr/local/bin/DeleteVirtDomain-PASSWORD, \
/usr/local/bin/EnableVirtDomain-PASSWORD, \
/usr/local/bin/DisableVirtDomain-PASSWORD, \
/usr/local/bin/EditVirtDomain-PASSWORD, \
/usr/local/bin/AddReseller-PASSWORD, \
/usr/local/bin/ChangeDomainPasswd-PASSWORD
apache ALL=(ALL) NOPASSWD: ENSIM
Save and close the file.

Creating an Ensim Product

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

WHMCS Connect

This module does not support WHMCS Connect.

Troubleshooting

N/A

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: @@
-== '''Important Notes''' ==
+== About this Module ==
+<div class="docs-alert-danger">
+We deprecated and removed this module in WHMCS 6.0.
+</div>
+The Ensim module allows you to add and manage Ensim servers in WHMCS.
-.	This only currently works for ensim servers local to the WHMCS install. A script specifically for remote ensim servers is being developed.
+* This module only works for Ensim servers that are local to the WHMCS installation.
+* This module requires access to the <tt>sudo</tt> command.
+* You must comment out <tt>Defaults requiretty</tt> in the <tt>/etc/sudoers</tt> file in order to allow the <tt>sudo</tt> command access to PHP.
-.	Access to the Sudo command is required from PHP for this to work.
+{{Provisioning_Module
+| changepw = Yes}}
+== Adding a Ensim Server ==
-.	By default Ensim has a command in the /etc/sudoers file "Defaults requiretty"  you will need to commend this out by changing it to "#Defaults requiretty" in order to allow Sudo access to PHP
+To set up a Ensim server in WHMCS:
+# Go to '''Setup > Products/Services > [[Servers]]'''.
-== '''Overview''' ==
+# Click '''Add New Server'''.
+# Select ''EnsimX'' from the menu.
+# Enter server details.
-) [[Ensim#Step_1:_Setup_the_WHMCS_Local_Server|Setup the WHMCS Local Server]]
+# Click '''Save'''.
+# Create symbolic links to the VirtDomain scripts on the local Ensim server. You will need to be logged in as the <tt>root</tt> account for this step. For example: <div class="source-cli">cd /usr/local/bin<br/>ln -s AddVirtDomain AddVirtDomain-PASSWORD<br/>ln -s DeleteVirtDomain DeleteVirtDomain-PASSWORD<br/>ln -s EnableVirtDomain EnableVirtDomain-PASSWORD<br/>ln -s DisableVirtDomain DisableVirtDomain-PASSWORD<br/>ln -s EditVirtDomain EditVirtDomain-PASSWORD<br/>ln -s AddReseller AddReseller-PASSWORD</div>Where <tt>PASSWORD</tt> is the server password.
-) [[Ensim#Step_2:_Symbolic_Links|Setup Symbolic Links on your server]]
+# Copy the <tt>ChangeDomainPasswd-PASSWORD</tt> file from [https://www.whmcs.com/members/dl.php?type=d&id=29 the zip file] to <tt>/usr/local/bin</tt>.
+# Edit the <tt>/etc/sudoers</tt> file. Add the following lines to the end of the file, substituting your link names:<div class="source-cli">Cmnd_Alias ENSIM = /usr/local/bin/AddVirtDomain-PASSWORD, \<br/>/usr/local/bin/DeleteVirtDomain-PASSWORD, \<br/>/usr/local/bin/EnableVirtDomain-PASSWORD, \<br/>/usr/local/bin/DisableVirtDomain-PASSWORD, \<br/>/usr/local/bin/EditVirtDomain-PASSWORD, \<br/>/usr/local/bin/AddReseller-PASSWORD, \<br/>/usr/local/bin/ChangeDomainPasswd-PASSWORD<br/>apache ALL=(ALL) NOPASSWD: ENSIM</div>
-) [[Ensim#Step_3:_Setup_the_Products_with_Ensim_Packages|Setup the Products with Ensim Packages]]
+# Save and close the file.
-=== '''Step 1: Setup the WHMCS Local Server''' ===
-* 1. Goto Configuration -> Add New Server
+=== Creating an Ensim Product ===
-* 2. Click Add New Server
+You can create a product that provisions accounts on your Ensim 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'''.
-* 3. Configure your server settings, choose the server type "EnsimX"
-* 4. Enter a Password for the server, you will need this password later on. A Username Or server hash is not required
-* 5. Click Save
-=== '''Step 2: Symbolic Links''' ===
-Now you will need to create symbolic links to the VirtDomain scripts on the local Ensim server. You will need to be logged in as the root account in order to complete this step. For our example, we would use the following commands to create the needed links:
-'''**** REPLACE PASSWORD IN EACH LINE BELOW WITH YOUR SERVER PASSWORD'''
-cd /usr/local/bin
-ln -s AddVirtDomain AddVirtDomain-PASSWORD
-ln -s DeleteVirtDomain DeleteVirtDomain-PASSWORD
-ln -s EnableVirtDomain EnableVirtDomain-PASSWORD
-ln -s DisableVirtDomain DisableVirtDomain-PASSWORD
-ln -s EditVirtDomain EditVirtDomain-PASSWORD
-ln -s AddReseller AddReseller-PASSWORD
-Copy the file "ChangeDomainPasswd-PASSWORD" from the zip file here http://support.whmcs.com/dl.php?type=d&id=29 to /usr/local/bin .. remember to rename the file with your server password entered above instead of PASSWORD
-Edit the file /etc/sudoers. Add the following lines to the end of the file, substituting your link names as needed.
-<nowiki>==================================================================</nowiki>
-Cmnd_Alias ENSIM = /usr/local/bin/AddVirtDomain-PASSWORD, \
-/usr/local/bin/DeleteVirtDomain-PASSWORD, \
-/usr/local/bin/EnableVirtDomain-PASSWORD, \
-/usr/local/bin/DisableVirtDomain-PASSWORD, \
-/usr/local/bin/EditVirtDomain-PASSWORD, \
-/usr/local/bin/AddReseller-PASSWORD, \
-/usr/local/bin/ChangeDomainPasswd-PASSWORD
-apache ALL=(ALL) NOPASSWD: ENSIM
-<nowiki>==================================================================</nowiki>
-Save and close the file.
-=== '''Step 3: Setup the Products with Ensim Packages''' ===
-* 1.	Setup the Hosting Plans in your Ensim Server Administrator Panel By clicking on SITE MANAGER -> Add Service Plan. Write down the name of the service plan - DO NOT PUT SPACES IN THE NAME - If you want to put a space, put an underscore _
-* 2.	Login to the WHMCS Control Panel
-* 3.	Go to Configuration -> Products/Services
-* 4.	Create a product and configure as required
-* 5.	Then click "Module Settings"
-* 6.	Choose Applies to Server Type "EnsimX"
+=== WHMCS Connect ===
-* 7.	Set "Package Name" to the same name as the Service Plan you setup in step 1
+This module does not support [[WHMCS Connect]].
-* 8.	Save changes, and test by placing a new order and setting the cost of the product to $0
+==Troubleshooting==
-Enjoy!
+''N/A''
 {{modules}}

Documentation