Inactive Account Manager For cPanel
(→Ignored Accounts) |
(→Module Uninstallation) |
||
(28 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <meta name="keywords" content="inactive account manager for cpanel, inactive account manager configuration, cpanel inactive account management, cpanel inactive account manager installation, cpanel inactive account manager common problems, about cpanel inactive account, cpanel inactive account manager documentation, cpanel inactive account manager faq, cpanel inactive account manager help, cpanel inactive account manager guide, cpanel inactive account manager wiki, cpanel inactive accounts manager tutorial, cpanel inactive accounts manager tips, | + | <meta name="keywords" content="inactive account manager for cpanel, inactive account manager configuration, cpanel inactive account management, cpanel inactive account manager installation, cpanel inactive account manager common problems, about cpanel inactive account, cpanel inactive account manager documentation, cpanel inactive account manager faq, cpanel inactive account manager help, cpanel inactive account manager guide, cpanel inactive account manager wiki, cpanel inactive accounts manager tutorial, cpanel inactive accounts manager tips, cPanel inactive accounts manager wiki, WHM inactive clients, WHM inactive accounts management"></meta> |
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Inactive Accounts Manager For cPanel Module."></meta> | <meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Inactive Accounts Manager For cPanel Module."></meta> | ||
− | |||
=About [https://www.modulesgarden.com/products/cpanel/inactive-account-manager Inactive Account Manager For cPanel]= | =About [https://www.modulesgarden.com/products/cpanel/inactive-account-manager Inactive Account Manager For cPanel]= | ||
Line 40: | Line 39: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Sending Inactivity Alerts | + | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Sending Inactivity Alerts |
|} | |} | ||
{| | {| | ||
Line 47: | Line 46: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Account Auto Termination | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Account Auto Termination | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 45px;"|✔ Remove From List | ||
|} | |} | ||
{| | {| | ||
Line 76: | Line 78: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 60px;"|✔ | + | |style="padding: 0px 0px 0px 60px;"|✔ Sending Email Notifications |
|} | |} | ||
{| | {| | ||
Line 111: | Line 113: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 45px;"|✔ Suspension/Termination Time | |style="padding: 0px 0px 0px 45px;"|✔ Suspension/Termination Time | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Manage Inactive Accounts: | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 45px;"|✔ Add To Ignored Accounts List | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 45px;"|✔ Suspend Account | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 45px;"|✔ Terminate Account | ||
|} | |} | ||
{| | {| | ||
Line 123: | Line 137: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Account Auto Termination | |style="padding: 0px 0px 0px 45px;"|✔ Toggle Account Auto Termination | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 45px;"|✔ Remove From List | ||
|} | |} | ||
{| | {| | ||
Line 135: | Line 152: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 00px 0px 0px 30px;"|✔ Enable | + | |style="padding: 00px 0px 0px 30px;"|✔ Enable Automated Management Of Inactive Accounts |
|} | |} | ||
{| | {| | ||
Line 184: | Line 201: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''5. Once the module is uploaded, run the following command from the console: <br/> |
+ | |||
cd /root/InactiveAccountManager/ | cd /root/InactiveAccountManager/ | ||
sudo sh install | sudo sh install | ||
+ | |||
+ | Confirm the installation and wait until you see the following note in the console: | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 25px;"|[[File:IAM_4_1.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 30px 15px;"|'''The installation process has finished successfully.''' <br/> | ||
+ | Now, you can move to the module configuration itself in your WHM.'' | ||
|} | |} | ||
==Configuration== | ==Configuration== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|''' | + | |style="padding: 10px 0px 15px 15px;"|'''Once the first phase, installation, has been completed in the previous steps, it is time to configure the module to let it work smoothly.<br/> |
+ | Log into '' 'WHM' '' and then move to '' 'Plugins' '' → '' 'Inactive Account Manager' ''. The very first page you will see is named '' 'Inactive Accounts'.'' | ||
|} | |} | ||
{| | {| | ||
Line 197: | Line 225: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 5px 15px;"|''' | + | |style="padding: 0px 0px 5px 15px;"|'''Move to the '' 'Configuration' '' section, where you will need to define several details to allow the plugin serve its functions:''' |
*'''Sender''' - define an email address that will be visible as a sender of an email notification from this module | *'''Sender''' - define an email address that will be visible as a sender of an email notification from this module | ||
Line 226: | Line 254: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 15px;"|'''Your module is now ready to | + | |style="padding: 0px 0px 30px 15px;"|'''Well done! Your module is now ready to go. Do not waste any more time and put the accounts on you cPanel server in order just now.''' |
|} | |} | ||
Line 274: | Line 302: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|'' 'Ignored Accounts' '' section contains all the inactive accounts that have been maually moved there by the admin.<br/> | |style="padding: 10px 0px 15px 15px;"|'' 'Ignored Accounts' '' section contains all the inactive accounts that have been maually moved there by the admin.<br/> | ||
− | All accounts that are placed here can have personalized configuration, it is possible to turn off the three default options: sending alerts, auto suspension, and auto termination. <br/>Switch the trigger next to a single account, then, automatic actions taken from general settings will be replaced with configuration per single account.<br/> If you switch off for example '' 'Auto Terminate' '', then the account will be suspended and notifications sent according to general settings. | + | All accounts that are placed here can have personalized configuration, it is possible to turn off the three default options: sending alerts, auto suspension, and auto termination. <br/>Switch the trigger next to a single account, then, automatic actions taken from general settings will be replaced with configuration per single account.<br/> If you switch off for example '' 'Auto Terminate' '', then the account will be suspended and notifications sent according to general settings. <br/> |
+ | In order to quickly and easily remove an account from the list of ignored just press the '' 'Remove' '' button located in '' 'Actions'.'' | ||
|} | |} | ||
{| | {| | ||
Line 286: | Line 315: | ||
*Switch "Auto Terminate" | *Switch "Auto Terminate" | ||
*Switch All | *Switch All | ||
+ | *Remove | ||
|} | |} | ||
{| | {| | ||
Line 314: | Line 344: | ||
==Reseller View In WHM== | ==Reseller View In WHM== | ||
{| | {| | ||
− | |style="padding: 10px 0px 15px 15px;"|Ianctive Account Manager plugin gives resellers certain possibilities as well.<br/> Read below to | + | |style="padding: 10px 0px 15px 15px;"|Ianctive Account Manager plugin gives resellers certain possibilities as well.<br/> Read below to review all the opitons allowed to your resellers. |
|} | |} | ||
{| | {| | ||
Line 335: | Line 365: | ||
* Reason for claiming the account as inactive | * Reason for claiming the account as inactive | ||
* Date when the account is going to be suspended or terminated | * Date when the account is going to be suspended or terminated | ||
− | * Current status: ''Active/Suspended'' or ''Terminated'' | + | * Current status: ''Active/Suspended'' or ''Terminated''<br> |
− | + | ||
− | + | Available actions: | |
− | + | *Suspend | |
+ | *Terminate | ||
+ | *Ignore account<br/> | ||
+ | |||
+ | At the top of this page, you can see the time when data were updated for the last time. | ||
|} | |} | ||
{| | {| | ||
Line 347: | Line 381: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|Inactive accounts moved by the admin to '' 'Ignored Accounts' '' section.<br/> | |style="padding: 10px 0px 15px 15px;"|Inactive accounts moved by the admin to '' 'Ignored Accounts' '' section.<br/> | ||
− | All accounts that are placed here can have personalized configuration, it is possible to turn off the three default options: sending alerts, auto suspension, and auto termination. <br/>Switch the trigger next to a single account, then, automatic actions taken from the general configuration will be replaced with configuration per single account.<br/> If you switch off for example '' 'Auto Terminate' '', then the account will be suspended and notifications sent according to general settings. | + | All accounts that are placed here can have personalized configuration, it is possible to turn off the three default options: sending alerts, auto suspension, and auto termination. <br/>Switch the trigger next to a single account, then, automatic actions taken from the general configuration will be replaced with configuration per single account.<br/> If you switch off for example '' 'Auto Terminate' '', then the account will be suspended and notifications sent according to the general settings. |
|} | |} | ||
{| | {| | ||
Line 355: | Line 389: | ||
|style="padding: 0px 0px 15px 15px;"|You may switch off all the options for an account - then such account will be completely skipped and no action taken by the module. <br/> | |style="padding: 0px 0px 15px 15px;"|You may switch off all the options for an account - then such account will be completely skipped and no action taken by the module. <br/> | ||
It is possible to turn off the module actions for numerous accounts. Select the accounts' users and then in Mass Actions choose the option you are interested in: | It is possible to turn off the module actions for numerous accounts. Select the accounts' users and then in Mass Actions choose the option you are interested in: | ||
− | *Switch | + | *Switch "Send Alerts" |
− | *Switch Auto Suspend | + | *Switch "Auto Suspend" |
− | *Switch Auto | + | *Switch "Auto Terminate" |
*Switch All | *Switch All | ||
|} | |} | ||
Line 379: | Line 413: | ||
|} | |} | ||
--> | --> | ||
+ | |||
+ | =Plugin Workflow= | ||
+ | {| | ||
+ | |style="padding: 10px 0px 30px 15px;"|Below you can see how the module works, read to find out its logic:<br/> | ||
+ | # '''Fetch all the accounts existing on the cPanel server''' | ||
+ | # '''Fetch the main domain of an account''' | ||
+ | # '''Fetch NS records of that domain'''<br/> If these NS records are placed on the list of ''DNS Servers'' to skip during validation, claim the account as active and finish the process. | ||
+ | # '''Fetch the IP address of the main domain'''<br/> Compare the IP address with the one assigned to the account. If IP addresses match, claim the account as active and finish the process. | ||
+ | # '''Fetch MX records of the domain'''<br/> If any of the records point to the account IP address, claim the account as active and finish the process. | ||
+ | # '''Fetch the account available domains'''<br/> If there are no domains, claim the account as '''inactive.''' | ||
+ | # '''Check available methods as in points 3,4 and 5'''<br/> If at least one of them is true, claim the domain as active. In case '''all the checked aspects turn out false, claim the domain as inactive. ''' | ||
+ | |} | ||
+ | =Uninstallation Process= | ||
+ | {| | ||
+ | |style="padding: 10px 0px 30px 15px;"|If you no longer wish to use Inactive Account Manager For cPanel, you may safely uninstall the plugin. <br/> To do so, simply open the console and execute the following commands: | ||
+ | cd /root/InactiveAccountManager/ | ||
+ | and then run: | ||
+ | sh install uninstall | ||
+ | |||
+ | That is all, the plugin is completely and successfully uninstalled now. | ||
+ | |} | ||
=Common Problems= | =Common Problems= |
Latest revision as of 09:30, 31 May 2022
Contents |
[edit] About Inactive Account Manager For cPanel
Inactive Account Manager For cPanel module has been created to allow smooth management of all the inactive accounts on your server. Actions such as terminate, activate or suspend an account, made in bulk or fully automated, will help to shorten the common searches of single users. Reduce the costs of cPanel licensing, based on the number of all accounts, with nothing more but this simple plugin. |
- WHM Admin Area:
✔ View Inactive Accounts: |
✔ Inactivity Time |
✔ Username/Domain/Email/Status |
✔ Account Inactivity Reason |
✔ Suspension/Termination Time |
✔ Manage Inactive Accounts: |
✔ Add To Ignored Accounts List |
✔ Suspend Account |
✔ Terminate Account |
✔ Manage Ignored Accounts: |
✔ Toggle Sending Inactivity Alerts |
✔ Toggle Account Auto Suspension |
✔ Toggle Account Auto Termination |
✔ Remove From List |
✔ Edit Email Message Templates: |
✔ Exceeded Inactivity Period |
✔ Account Suspension |
✔ Account Termination |
✔ Configure Module Settings: |
✔ Provide Sender Email Used For Notifications |
✔ Provide Notifications Recipient Email |
✔ Set Cron Frequency |
✔ Set Number Of Days Before: |
✔ Sending Email Notifications |
✔ Suspending Account |
✔ Terminating Account |
✔ Toggle Automatic Accounts Suspension And Termination |
✔ Provide DNS Servers To Be Skipped |
✔ Provide Account Owners To Be Skipped |
✔ View Module Logs |
- WHM Reseller Area:
✔ View Inactive Accounts: |
✔ Inactivity Time |
✔ Username/Domain/Email/Status |
✔ Account Inactivity Reason |
✔ Suspension/Termination Time |
✔ Manage Inactive Accounts: |
✔ Add To Ignored Accounts List |
✔ Suspend Account |
✔ Terminate Account |
✔ Manage Ignored Accounts: |
✔ Toggle Sending Inactivity Alerts |
✔ Toggle Account Auto Suspension |
✔ Toggle Account Auto Termination |
✔ Remove From List |
✔ Provide Sender Email Used For Notifications |
✔ View Module Logs |
- General Info
✔ Monitor And Manage Inactive cPanel Accounts |
✔ Enable Automated Management Of Inactive Accounts |
✔ Requires ionCube Encoder |
✔ Multi-Language Support |
✔ Supports PHP 7.2 Up To PHP 7.4 |
✔ Supports cPanel & WHM 56 And Later |
[edit] Installation and Configuration
This tutorial will show you how to successfully install and configure Inactive Account Manager For cPanel. We will guide you step by step through the whole installation and configuration process. |
[edit] Installation
1. Log in to our client area and download the module. |
2. Upload and extract the module into the /root cPanel directory. Files in your cPanel /root/InactiveAccountManager directory should look like these on the following screen. |
3. When you install Inactive Account Manager For cPenel for the first time you have to rename 'license_RENAME.php' file. File is located in 'plugins/IanctiveAccountManager/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'. |
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file. Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'. |
5. Once the module is uploaded, run the following command from the console: cd /root/InactiveAccountManager/ sudo sh install Confirm the installation and wait until you see the following note in the console: |
The installation process has finished successfully. Now, you can move to the module configuration itself in your WHM. |
[edit] Configuration
Once the first phase, installation, has been completed in the previous steps, it is time to configure the module to let it work smoothly. Log into 'WHM' and then move to 'Plugins' → 'Inactive Account Manager' . The very first page you will see is named 'Inactive Accounts'. |
Move to the 'Configuration' section, where you will need to define several details to allow the plugin serve its functions:
|
Skip validation for:
|
Well done! Your module is now ready to go. Do not waste any more time and put the accounts on you cPanel server in order just now. |
[edit] Management
Inactive Account Manager For cPanel allows to quickly detect all accounts that remain inactive for some time.
Moreover, you are allowed to administer such accounts and take full control of their existence on your server. |
[edit] WHM Admin Area
In the WHM admin area you will find the core of the plugin. Starting from precise configuration, through accounts lists, email templates, and logs. |
[edit] Inactive Accounts
The first and foremost section that you are automatically directed to when you open the module is called 'Inactive Accounts.' It is here that you can find the core of the module functionality and place to manage all the inactive accounts on your cPanel server. This section contains a list of all accounts on your server which are detected and claimed as inactive for any reason.
|
Actions that can be performed on any inactive account, either per single account or in bulk using Mass Actions option:
|
At the top of this page, you can see the time when data were updated for the last time. By default, cron refreshes the list and its data according to your configuration (e.g. once a day or every 2 hours). In case of necessity, you can also manually force the module to refresh data at any moment. Press 'Refresh Now' button. |
[edit] Ignored Accounts
'Ignored Accounts' section contains all the inactive accounts that have been maually moved there by the admin. All accounts that are placed here can have personalized configuration, it is possible to turn off the three default options: sending alerts, auto suspension, and auto termination. |
You may switch off all the options for an account - then such account will be completely skipped and no action taken by the module. It is possible to turn off the module actions for numerous accounts. Select the accounts' users and then in Mass Actions choose the option you are interested in:
|
[edit] Logs
Move to 'Logs' section to find a list of all actions triggered by the module. Review them in search of any needed information, you can use the 'Search' box to find the activities you need. |
[edit] Emial Templates
There are three defult email templates that are used by the module to send alerts to accounts owners:
Here you may see their content and change it freely. Under every template content, you can find variables available for this message. |
[edit] Reseller View In WHM
Ianctive Account Manager plugin gives resellers certain possibilities as well. Read below to review all the opitons allowed to your resellers. |
[edit] Configuration
In 'Configuration ' section reseller may change the 'Notification Recipient' - the email address where notifications and alerts from the module are sent. |
[edit] Inactive Accounts
'Inactive Accounts' section contains a list of your accounts that for some reason have been detected and claimed as inactive. The list includes information on every such account, that is:
Available actions:
At the top of this page, you can see the time when data were updated for the last time. |
[edit] Ignored Accounts
Inactive accounts moved by the admin to 'Ignored Accounts' section. All accounts that are placed here can have personalized configuration, it is possible to turn off the three default options: sending alerts, auto suspension, and auto termination. |
You may switch off all the options for an account - then such account will be completely skipped and no action taken by the module. It is possible to turn off the module actions for numerous accounts. Select the accounts' users and then in Mass Actions choose the option you are interested in:
|
[edit] Logs
'Logs' includes a list of all actions attempted bn the module. Review them in search of any needed information, you may use the 'Search' box to find precise data. |
[edit] Plugin Workflow
Below you can see how the module works, read to find out its logic:
|
[edit] Uninstallation Process
If you no longer wish to use Inactive Account Manager For cPanel, you may safely uninstall the plugin. To do so, simply open the console and execute the following commands: cd /root/InactiveAccountManager/ and then run: sh install uninstall That is all, the plugin is completely and successfully uninstalled now. |
[edit] Common Problems
1. When you have problems with connection, check whether your SELinux or firewall does not block ports. |