Licensing Addon - Revision history

James.white: /* Activating Licensing Addon */

2023-08-29T14:36:02Z

‎Activating Licensing Addon

SarahK: /* Change Log */

2022-12-28T15:52:45Z

‎Change Log

SarahK: /* Activating Licensing Addon */

2022-05-05T20:28:07Z

‎Activating Licensing Addon

SarahK at 20:13, 25 April 2022

2022-04-25T20:13:01Z

SarahK at 22:17, 16 March 2022

2022-03-16T22:17:56Z

Show changes

SarahK at 19:40, 17 December 2021

2021-12-17T19:40:29Z

Joshua at 21:32, 13 December 2021

2021-12-13T21:32:36Z

John: Reverted edits by Joshua (talk) to last revision by SarahK

2021-09-07T14:20:17Z

Reverted edits by Joshua (talk) to last revision by SarahK

Joshua: /* Integrating the Check Code */

2021-09-07T13:24:02Z

‎Integrating the Check Code

Joshua: /* Integrating the Check Code */

2021-09-07T13:22:45Z

‎Integrating the Check Code

@@ Line 26: / Line 26: @@
 == Activating Licensing Addon ==
-You must first purchase, download, and upload this addon. Then, you can activate it through the Admin Area.
+You must first purchase this addon. Then, you can activate it through the Admin Area.
 To do this:

← Older revision		Revision as of 15:52, 28 December 2022
Line 203:		Line 203:
	==Change Log==		==Change Log==

−	~~''N/A''~~	+	=== Licensing Addon v3.0 ===
		+
		+	Release Date: 9th February 2012
		+
		+	New Features Added:
		+
		+	* Free Trial Option
		+	* Public License Verification Tool
		+	* Banned Domains
		+	* Intelligent Search Integration
		+	* Added Maximum Allowed Reissues Limit
		+	* Auto Logs Prune

@@ Line 32: / Line 32: @@
 # Purchase the addon in the WHMCS Marketplace.
 # Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
-# Click '''Activate''' for '''name'''.
+# Click '''Activate'''.
 # Click '''Configure'''.
 # Choose one of the following options:
@@ Line 39: / Line 39: @@
 #* '''Auto Logs Prune''' — To prevent the licence access logs from becoming too large you can specify for how long they should be kept.
 # Select the admin role groups who will have access to this addon.
 # Click '''Save Changes'''.
 == Using this Addon ==

@@ Line 74: / Line 74: @@
 #Ensure your licensing product is created first
-#Then, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Product Addons'''.
+#Then, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Product Addons]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Product Addons'''.
 #Click '''Add New'''.
 #Enter the name, description, price and recurring cycle - leave the Show on Order setting unchecked
@@ Line 97: / Line 97: @@
 ===Managing Licenses===
-To manage licenses, go to Addons > Licenses Manager.  From here you can browse through all the license keys that have been issued, search for license keys and make changes to the allowed domains, ips and directory for a license.
+To manage licenses, go to '''Addons > Licenses Manager'''.  From here you can browse through all the license keys that have been issued, search for license keys and make changes to the allowed domains, ips and directory for a license.
 ===Integrating the Check Code===
@@ Line 178: / Line 178: @@
 <div class="docs-alert-info">
 The module create function of this module does not generate a username and password by design. Therefore the username/password fields will be blank under the client's Products/services tab.
 </div>

@@ Line 25: / Line 25: @@
 *Key Prefix - this defines the start of the license key and is how you can validate an applicable key for the product you're performing the checking in has been entered - eg. Monthly-, Owned-, Mobile-, etc...
 *Allow Reissue - determines whether a client can reissue the license from the client area
-*Allow Domain Conflict - When unticked WHMCS will make sure the location at which the licence is being used matches the 'Valid Domain' value in the service record. Tick the option if you want to allow a user to run the product on multiple domains.
+*Allow Domain Conflict - If you don't check this, WHMCS will make sure the location at which the licence is being used matches the 'Valid Domain' value in the service record. Check the option if you want to allow a user to run the product on multiple domains.
 *Allow IP Conflict - as above but for the IP address
 *Allow Directory Conflict - as above but for the directory
 *Support/Updates Addon - explained in detail below
-*Free Trial - This option can be ticked to prevent clients from using more than one licence of this product on the same domain. If a client tries to order a second copy of this product and use it on the same domain as a previous service, it will be automatically suspended with the reason "Duplicate Free Trial Use". Useful for limiting free trials to one per domain.
+*Free Trial - This option can be checked to prevent clients from using more than one licence of this product on the same domain. If a client tries to order a second copy of this product and use it on the same domain as a previous service, it will be automatically suspended with the reason "Duplicate Free Trial Use". Useful for limiting free trials to one per domain.
 ==Downloads==
@@ Line 51: / Line 51: @@
 #Click '''Add New'''.
 #Enter the name, description, price and recurring cycle - leave the Show on Order setting unchecked
-#Now tick the licensing product(s) in the applicable products section for the addon
+#Check the licensing product(s) in the applicable products section for the addon
 #Now go back to the product configuration area and click the edit icon next to your licensing product
 #On the Module Settings tab, choose the addon you just created in the "Support/Updates Addon" field and save
-And that's it! If you didn't want to include it free with the initial purchase, you would leave the setting on the Module Settings tab at None and tick the box for Show on Order in the addon configuration.
+And that's it! If you didn't want to include it free with the initial purchase, you would leave the setting on the Module Settings tab at None and check the box for Show on Order in the addon configuration.
 ==Module Commands==

@@ Line 75: / Line 75: @@
 ==Integrating the Check Code==
-The code used to integrate the license check is included with the addon in the /modules/servers/licensing/check_sample_code.php file.  The idea here is that you would have your user enter the license key they get issued during an install process or by simply pasting it into a file, and then you load that in your file before calling the check_license function to validate where the file is being run.  For each successful check, a local key is returned which you then also store in your DB or a file to verify against locally on subsequent page loads.
+The code used to integrate the license check is included with the addon in the <tt>/modules/servers/licensing/check_sample_code.php</tt> file. The user can then enter their license key during an installation process or by pasting it into a file. You can then load that key in your file before calling the <tt>check_license</tt> function to validate in which the file is run. For each successful check, a local key is returned. You can then store that local key in your database or a file to use locally for license verification on subsequent page loads.
-The steps to integrate are described in more detail below:
+To integrate the license check, perform these steps:
-#Copy & paste the code into the top of the file you want to protect
+# Copy and paste the license check code from the <tt>check_sample_code.php</tt> file into the top of the file you want to protect.
-#Enter the URL to your WHMCS system root directory in the $whmcsurl variable
+# Enter the System URL from your WHMCS installation in the <tt>$whmcsurl</tt> variable.
-#Customise the $licensing_secret_key variable used to ensure your local keys are different from other licensing addon users
+# Customise the <tt>$licensing_secret_key</tt> variable used to ensure your local keys are different from other licensing addon users.
-#Optionally change the $localkeydays & $allowcheckfaildays variables if you want to change how often a remote check is made
+# Optionally, change the <tt>$localkeydays</tt> and <tt>$allowcheckfaildays</tt> variables if you want to change how often a remote license check is made.
-#Now retrieve the license key and local key from the database or file storage you have saved them in
+# Ensure that your code performs the following actions:
-#Then call the check_license function
+#* Retrieve the license key and local key from the database or file storage.
-#And then act on the result based on the sample code if statements
+#* Call the <tt>check_license</tt> function.
-#You then store the local key that gets returned
+#* Perform the desired actions in accordance with the results of the <tt>check_license</tt> function. For sample <tt>if</tt> statements, see the <tt>check_sample_code.php</tt> file.
 ===Using Product Addons===
@@ Line 134: / Line 135: @@
    $configoptions[] = $temparr;
 }</nowiki></pre>
 ==Frequently Asked Questions==

@@ Line 77: / Line 77: @@
 The code used to integrate the license check is included with the addon in the '''/modules/servers/licensing/check_sample_code.php''' file.  The idea here is that you would have your user enter the '''license key''' they get issued during an install process or by simply pasting it into a file, and then you load that in your file before calling the '''check_license''' function to validate where the file is being run.  For each successful check, a local key is returned which you then also store in your DB or a file to verify against locally on subsequent page loads.
-The steps to integrate are described in more detail below:
+The steps to integrate are described in more detail below, as well as in the '''check_sample_code.php''' file:
 #Copy & paste the code into the top of the file you want to protect