Personal tools
Namespaces

Variants
Actions

Inactive Account Manager For cPanel

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
m (Installation and Configuration)
(Configuration)
Line 107: Line 107:
 
===Configuration===
 
===Configuration===
 
{|
 
{|
|style="padding: 10px 0px 15px 15px;"|In Configuratyion section you will need to define some details concerning sending notifications, cron frequency, actions automation and few other:
+
|style="padding: 10px 0px 15px 15px;"|In Configuration section you will need to define some details concerning sending notifications, cron frequency, actions automation and few other:
Notifications and Cron:
+
 
*Sender -  
+
*Sender - define an email address that will be visible as a sender of an email notification from this plugin
*Notification Recipient -  
+
*Notification Recipient - type in an email address where email notifications will be delivered from the plugin
*Cron Frequency -  
+
*Cron Frequency - here you can define how often cron, responsible for plugin actions () should run, type in the number of hours
*Days To Send Notification -  
+
*Time Before Notification - Enter here the '''number of days''' the account must stay inactive before the first informing notification is sent to its owner
*Days To suspend -  
+
*Time Before Suspension - Enter here the '''number of days''' the account must stay inactive before notification about its approaching suspension is sent to its owner
*Days To Terminate -  
+
*Time Before Termination - Enter here the '''number of days''' the account must stay inactive before notification informing that the account will be terminated soon is sent to its owner
*Automatic Suspension -  
+
*Automatic Suspension - enable this option and all inactive accounts (including ignored ones, depending on their configuration) will be automatically suspended once a day
*Automatic termnination -  
+
*Automatic Termination - enable this option and all inactive accounts (including ignored ones, depending on their configuration) will be automatically terminated once a day
 
|}
 
|}
 
{|
 
{|
Line 123: Line 123:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Skip validation for:
 
|style="padding: 0px 0px 15px 15px;"|Skip validation for:
*DNS Servers -  
+
*DNS Servers - enumerate DNS servers, accounts that exist on these servers will be skipped during validation. Enerter one DNs server per line
*Account Owners -  
+
*Account Owners - type in the accounts owners, one per line. Their accounts will not be taken into consideration when searching for new inactive accounts
 
|}
 
|}
 
{|
 
{|

Revision as of 10:57, 26 April 2021


Contents

About Inactive Accounts Manager For cPanel

Inactive Account Manager For cPanel plugin has been created to allow smooth management of all the inactive accounts on the server.
Actions such as terminate, activate or suspend made in bulk or fully automated will help to shorten the banal searches.
Reduce the costs of cPanel licensing based on the amount of all accounts with nothing more but this simple plugin.
  • WHM Area:
  • cPanel Area:
  • General Info
✔ Token Based Certificates Installation
✔ Requires Servertastic SSL For WHMCS Module
✔ Multi-Language Support
✔ 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.
STCP 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 1.png
3. Once the module is uploaded, run the following command from the console:
cd /root/InactiveAccountManager/
sudo sh install

Configuration

4. In order to configure the plugin, go to 'WHM' 'Plugins' 'InactiveAccountManager' .
IAM 1.png
5. Click the 'Configuration' and fill in the records.
IAM 1.png
Your module is almost ready to use.

Management

IAM For cPanel

WHM Area

In the WHM area

Configuration

In Configuration section you will need to define some details concerning sending notifications, cron frequency, actions automation and few other:
  • Sender - define an email address that will be visible as a sender of an email notification from this plugin
  • Notification Recipient - type in an email address where email notifications will be delivered from the plugin
  • Cron Frequency - here you can define how often cron, responsible for plugin actions () should run, type in the number of hours
  • Time Before Notification - Enter here the number of days the account must stay inactive before the first informing notification is sent to its owner
  • Time Before Suspension - Enter here the number of days the account must stay inactive before notification about its approaching suspension is sent to its owner
  • Time Before Termination - Enter here the number of days the account must stay inactive before notification informing that the account will be terminated soon is sent to its owner
  • Automatic Suspension - enable this option and all inactive accounts (including ignored ones, depending on their configuration) will be automatically suspended once a day
  • Automatic Termination - enable this option and all inactive accounts (including ignored ones, depending on their configuration) will be automatically terminated once a day
screen
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
screen

Inactive Accounts

Inactive accounts sections contains a list of all accounts on your server which are detected as inactive for any reason.

You will find detailed information on every such account here. That is:

  • time of inactivity, with details to seconds
  • user associated with the account
  • associated domain and email address
  • reason of inactivity
  • date when such account will be suspended or terminated (according to set up previously configuration)
  • current status: active/suspended or terminated


Allowed actions for single account Ignore/suspend/Terminate. All of these actions can be performed in bulk for many selected accounts.

At the top, you can see the time when data were updated for the last time. By default, cron refreshes the list and ins data according to your configuration (e.g. once a day). In case of necessity, you can also manually force the plugin to refresh data at any moment. Press 'Refresh Now' button.

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 tree default options. Sending alerts, auto suspension, and auto termination. Simply switch the trigger next to a single account.

Logs

Logs section contains a list of all logs - actions triggered by the module. Review thenm insearch of any needed information.
You may clear logs at any tyime you need.

Emial Templates

There are three defult email tyemplates that are used by the plugin.
  • Account exceeded inactivity period
  • Account Suspended
  • Account terminated

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.

Reseller View

REsellers may view teh list of their inactive account i nie wiem co jeszce ?:D
IAM 1.png

Tips

1. When you


Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. Due to
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Inactive Account Manager For cPanel