+- WHMCS Services Forum (https://www.whmcsservices.community)
+-- Forum: WS Modules (https://www.whmcsservices.community/forumdisplay.php?fid=5)
+--- Forum: Addons Modules (https://www.whmcsservices.community/forumdisplay.php?fid=6)
+---- Forum: Invite Required (https://www.whmcsservices.community/forumdisplay.php?fid=59)
+---- Thread: Installation Instructions (/showthread.php?tid=674)
Installation Instructions - wssupport - 04-19-2020
Installing Invite Required is very simple. The following steps will guide you through the process:
1) Upload the entire folder to your website - if you experience problems, try uploading in binary mode. However, do not upload the “upload” folder, just the files inside of it!
2) In WHMCS, go to System settings -> Addon modules -> Invite Required -> Configure button
3) Set time limits for invite expiration, lockout, and order time requirements.
4) By default and within an invite, the module will restrict all pages except for login and password reset
4a. to allow a specific page, you need to know either the template that was used or the file name that is given.
4b. Once you have the filename or template used, a place in the Pages and Templates allowed for everyone and for invitees
4c. If you wanted the store accessible, for example, in WHMCS 8.1 and above you would use the template of "products".
4d. NOTE: adding "index" to the allowed pages list will effectively give all access except registration.
5) By default, the module removes the most common WHMCS menus. To remove custom ones or new ones not in the module, add that menu to "Menu Items to Hide for everyone" and "Menu Items to Hide for invitee".
5a. To get the menu name, look at the page source and find the menu item. The menu item's ID will be:
"Primary_Navbar-NAME Of ITEM" where "NAME Of ITEM" is the name of the menu item.
5b. Once you have the name of that menu, add it to the list and it will now be hidden.
6) Set the credit amount - either a whole amount or a percentage like 5% for 5% of the total of the order.
6a. NOTE: credit is applied to referring client when the order is accepted
7) By default, the module will delete accounts that do not order within the allowed time -- uncheck the take action checkbox to stop any actions against the account.
NOTE: if somehow the account has an active service or domain at the end of the allowed time, no action will be taken.
8) You can access your module at 'Addons' → 'Invite Required'