Personal tools
Namespaces

Variants
Actions

Inactive Account Manager For cPanel

From ModulesGarden Wiki
Jump to: navigation, search

Contents

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
✔ 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 Notifyications
✔ 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 Ignored Accounts:
✔ Toggle Sending Inactivity Alerts
✔ Toggle Account Auto Suspension
✔ Toggle Account Auto Termination
✔ 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

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.

Installation

1. Log in to our client area and download the module.
IAM 1.png
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.

IAM 2.png
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'.

IAM 3.png
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'.

IAM 4.png
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:

IAM 4 1.png
The installation process has finished successfully.

Now, you can move to the module configuration itself in your WHM.

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'.

IAM 5.png
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
  • Notification Recipient - type in an email address where email notifications will be delivered from the module
  • Cron Frequency - here you can define how often cron, responsible for module actions, should run; type in the number of hours
  • Time Before Notification - enter the number of days the account must stay inactive before the first informing notification is sent to its owner.
    An exact date to send the email alert is automatically defined when the account is detected as inactive.
    Use action buttons in 'Inactive Accounts' section to change the dates per account if needed or disable this option for a single account by previously adding it to ignored.
  • Time Before Suspension - enter the number of days the account must stay inactive before notification about its approaching suspension is sent to its owner.
    An exact date of the account suspension is automatically defined when the account is detected as inactive. Note that it can be always changed or completely turned off per single account.
  • Time Before Termination - enter the number of days the account must stay inactive before notification informing that the account is about to be terminated soon is sent to its owner.
    The exact date is set once the account is detected as inactive. The date can be changed per account manually at any moment or disabled when the account is added to 'Ignored Accounts'.
  • Automatic Suspension - enable this option and inactive accounts (including ignored ones, depending on their configuration) will be automatically suspended on the due date
  • Automatic Termination - enable this option and inactive accounts (including ignored ones, depending on their configuration) will be automatically terminated on the due date
Skip validation for:
  • DNS Servers - enumerate DNS servers, accounts that exist on these servers will be skipped during validation. Enerter one DNS server per line
  • Account Owners - type in the accounts owners, one per line. Their accounts will not be taken into consideration when searching for new inactive accounts
IAM 6.png
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.

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.

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.

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.
The list includes information on every such account here, these are:

  • Detected time of inactivity, with details to seconds
  • User name associated with the account
  • Associated domain and email address
  • Reason for claiming the account as inactive
  • Date when the account will be suspended or terminated (according to set up previously configuration)
  • Current status: Active/Suspended or Terminated
IAM 7.png
Actions that can be performed on any inactive account, either per single account or in bulk using Mass Actions option:
  • Ignore
  • Suspend
  • Terminate
IAM 8.png
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.
IAM 9.png

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.
Switch the trigger next to a single account, then, automatic actions taken from general settings will be replaced with configuration per single account.
If you switch off for example 'Auto Terminate' , then the account will be suspended and notifications sent according to general settings.

IAM 10.png
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:

  • Switch "Send Alerts"
  • Switch "Auto Suspend"
  • Switch "Auto Terminate"
  • Switch All
IAM 11.png

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.
You may clear logs at any time you need.

IAM 12.png

Emial Templates

There are three defult email templates that are used by the module to send alerts to accounts owners:
  • Exceeded Inactivity Period
  • Account Suspension
  • Account Termination

Here you may see their content and change it freely. Under every template content, you can find variables available for this message.
Use them freely to compose a message that will perfectly suit your needs.

IAM 13.png

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.
IAM 14.png

Configuration

In 'Configuration ' section reseller may change the 'Notification Recipient' - the email address where notifications and alerts from the module are sent.
IAM 15.png

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:
  • Detected time of inactivity, with details to seconds
  • User name associated with the account
  • Associated domain and email address
  • Reason for claiming the account as inactive
  • Date when the account is going to be suspended or terminated
  • Current status: Active/Suspended or Terminated
At the top of this page, you can see the time when data were updated for the last time.
IAM 17.png

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.
Switch the trigger next to a single account, then, automatic actions taken from the general configuration will be replaced with configuration per single account.
If you switch off for example 'Auto Terminate' , then the account will be suspended and notifications sent according to the general settings.

IAM 18.png
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:

  • Switch "Send Alerts"
  • Switch "Auto Suspend"
  • Switch "Auto Terminate"
  • Switch All
IAM 19.png

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.
Press 'Clear Logs ' to delete all entries on the list.

IAM 20.png


Plugin Workflow

Below you can see how the module works, read to find out its logic:
  1. Fetch all the accounts existing on the cPanel server
  2. Fetch the main domain of an account
  3. Fetch NS records of that domain
    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.
  4. Fetch the IP address of the main domain
    Compare the IP address with the one assigned to the account. If IP addresses match, claim the account as active and finish the process.
  5. Fetch MX records of the domain
    If any of the records point to the account IP address, claim the account as active and finish the process.
  6. Fetch the account available domains
    If there are no domains, claim the account as inactive.
  7. Check available methods as in points 3,4 and 5
    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.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Navigation
WHMCS Modules
WHMCS Translations
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
FAQ
Community
Inactive Account Manager For cPanel