Support

Documentation

The "System - Admin Tools" plugin

[Note]Note

The scheduling features of this plugin are only available in the Professional release. The Core release does need the plugin to be enabled for the SEO and Link Tools features to work.

The "System - Admin Tools" plugin, or plg_admintools for short, has a dual role for the Professional release of Admin Tools. On one hand it is necessary for the correct operation of the Web Application Firewall and URL Redirections features of Admin Tools. On the other hand it allows you to schedule various aspects of your site's maintenance.

You can access the plugin's configuration parameters by going to your back-end's Extensions, Plugin Manager menu item. Then find the item System - Admin Tools on the list and click on it. The standard Joomla! plug-in configuration page opens.

On the left-hand side of the administrator area you can find the standard Joomla! controls. First, make sure that Enabled is set to Yes. Then, in order for the plugin to be published in the correct order, select 0 - First from the Order drop-down list.

The plugin options is where all the important functionality can be scheduled. You have the following options:

Rescue URL (Joomla! 3.6 or later only)

When enabled (default) the Rescue Mode feature is enabled, allowing Super Users with blocked IPs to request a temporary Rescue URL which lets them log into the site and lift the block. We recommend leaving this feature enabled unless you know what you are doing. See the Rescue Mode section for more information.

[Important]Important

You will only receive the email to activate Rescue Mode if your IP is being blocked by Admin Tools. If your IP is NOT blocked by Admin Tools you will NOT receive any email. This is by design. It doesn't make sense to temporarily unblock yourself with Rescue Mode when you are not blocked!

Rescue duration (minutes)

How long is the Rescue Mode active. This controls two things:

  1. The maximum amount of time between requesting a Rescue URL and visiting it.

  2. The maximum amount of time between visiting the Rescue URL and the end of Rescue Mode.

We recommend leaving this setting to 15 minutes. Lower values tend to be very impractical.

Email language

Admin Tools will send you emails to notify you of security exceptions when you enter an email address in WAF Configuration. By default, the current user's language (or your site's default language, if no user is currently logged in) is being loaded, which means that these emails will be sent out in this language. If you have a multilingual website it means that you may receive an email in any language available in your site. This can lead to confusion and makes it nigh impossible to set up any email filters. Therefore we give you this option. You can enter the language tag of the language in which you wish those security exception emails to be sent. For example, typing en-GB in this field will cause all emails to be sent out in English. If left blank (default) the current language loaded by Joomla! will be used.

Enable Session Optimizer

When enabled, the Session Optimizer will be scheduled to run automatically. This feature will repair and optimize Joomla!'s sessions table.

Run every X minutes

How often to run the Session Optimizer feature, in minutes

Enable Session Cleaner

When enabled, the Session Cleaner will be scheduled to run automatically. This feature will purge (completely empty) and optimize Joomla!'s sessions table. Watch out! This will automatically log all users out of your site! You should only use it on sites where you don't expect to have logged in users at all, e.g. a company presentation site.

Run every X minutes

How often to run the Session Cleaner feature, in minutes

Enable Cache Cleaner

When enabled, the Cache Cleaner will be scheduled to run automatically. This feature will try to purge (completely empty) Joomla!'s cache. This is not possible on occasions, especially if you are using a cache adapter which doesn't support purging.

Run every X minutes

How often to run the Cache Cleaner feature, in minutes

Enable Cache Auto-expiration

When enabled, the Cache Auto-expiration will be scheduled to run automatically. This feature will try to expire and delete stale items in Joomla!'s cache. Unlike the Joomla! built-in feature, it will try to run this operation across all caches. This is not possible on occasions, especially if you are using a cache adapter which doesn't support automatic expiration control.

Run every X minutes

How often to run the Cache Auto-expiration feature, in minutes

Delete inactive users

When this option is enabled, the Admin Tools plugin will automatically delete inactive users, i.e. users who registered on the site but never logged in. On each page load, up to five inactive users will be deleted, to avoid slowing down your site. There are four different options:

Never

Disables this feature

Only if they haven't activated their account

Users who have never activated their account will be removed. If they have activated their account they will not be removed.

Only if they activated, but never logged in

Users who have activated their account but never logged in will be removed. If they haven't activated their account yet, they will not be removed.

Activated or not, as long as they haven't logged in

Any user who hasn't logged in for the number of days specified in the next option will be removed from the site, no matter if he has activated his account or not.

Delete after this many days

How many days must elapse between the registration date of an inactive user and its deletion. For example, if this option is set to 7 then if a user registers on your site on the 1st of the month and has not logged in at least once by the eighth of the month, his user account will be removed.

Maximum security exceptions log entries

Specify the maximum number of entries to keep in the security exceptions log. Excess records will be deleted. Use 0 to turn off this feature and keep all security exceptions log entries (recommended).

[Note]Note

If you have thousands of old entries it will take a while for Admin Tools to remove all of the old entries. Old records are deleted in 100 record batches on each page load for performance reasons.

All expiration options are best-effort scheduled. This means that they will try to run every X minutes, but only as long as there is visitor traffic to trigger them. In any other case they will defer their execution for when there is visitor traffic.

Cookies Notification - Action required

This website uses cookies to provide user authentication and improve your user experience. Please indicate whether you consent to our site placing these cookies on your device. You can change your preference later, from the controls which will be made available to you at the bottom of every page of our site.