The account scanner function will allow you to automatically check some/all of the accounts in your database to make sure the URLs are still working and that they are following your rules for blacklist items, etc. This document will describe how to setup and run the account scanner through the ToplistX control panel.
Viewing Scanner Configurations
To view the scanner configurations that have been created, access the Accounts > Account Scanner function from the control panel menu. This will display a page where you will be able to see all of the scanner configurations that are currently defined.
In the table that displays the scanner configurations, you will find several functions that you can run on each configuration. Each of those functions are described below.
|Click this icon to view the history for this scanner configuration|
|Click this icon to view the results of the last scan completed using this configuration|
|Click this icon to start the account scanner with this configuration|
|Click this icon to stop the account scanner with this configuration|
|Click this icon to edit this scanner configuration|
|Click this icon to delete this scanner configuration|
Starting/Stopping the Scanner
The account scanner will run as a background process on your server, so you may need to confirm with your server administrator that you are allowed to run background processes.
To start the account scanner, first locate the configuration you want to run and make sure the status shows that it is Not Running. You can then click on the icon to start the account scanner. You will be asked to confirm that you want to start the scanner, and if you select ok the process of starting the scanner will continue. A confirmation box will appear to let you know that the process has been completed, and you should now see the Status value updated with the current progress of the scanner.
To stop the account scanner, first locate the configuration you want to stop and make sure the status shows that it is scanning accounts. You can then click on the icon to halt the scanning process. It may take a few minutes for the scanner to stop, so during that time it is normal for the Status to still show that the scanner is working.
Adding a Scanner Configuration
To add a new scanner configuration access the Accounts > Account Scanner function from the control panel menu. This will display your scanner configurations that have been created. Near the top of the page in the header bar that reads "Account Scanner Configurations" click on the icon. This will display a popup window where you will be able to enter the settings for the scanner configuration that you want to add. Each of the form fields are described below.
|Identifier||Enter a short identifier so you can remember the options set for this configuration|
|Date Added Range||Enter a date range of when the accounts were added to restrict the scan to accounts in this range (leave blank to scan all)|
|Date Scanned Range||Enter a date range of when the accounts were last scanned to restrict the scan to accounts in this range (leave blank to scan all)|
|Categories||Select the categories that you want to scan, or select ALL CATEGORIES to scan accounts from all categories.|
Re-enable suspended accounts that no longer have exceptions
Check this box to have accounts un-suspended after having been suspended by the account scanner. For example, if you have the account scanner set to disable accounts with connection errors you can enable this option to have accounts that previously had a connection error but no longer do to be restored to their regular status in the account database.
Rebuild the ranking pages when the scanner is completed
Check this box to have your ranking pages rebuilt when the account scanner has finished scanning.
Send an e-mail to administrators when the scanner is completed
Check this box to have all administrators with the account scanner e-mail option enabled notified by e-mail when the account scanner has finished scanning
|Ignore||No action will be taken|
|Display in report only||The account will be displayed in the scanner report|
|Suspend the account||The account will be suspended and will be displayed in the scanner report|
|Delete account from database||The account will be deleted from the database and will be displayed in the scanner report|
|Delete account and blacklist||The account will be deleted from the database, the account data will be blacklisted, and the account will appear in the scanner report. The hostname from the account URL, e-mail address, and submitter IP will be added to the blacklist.|
|Connection errors||Select the action to take for accounts that the scanner cannot connect to. This could be the result of a DNS lookup failure, the server being offline, or internet connection issues. For this issue type it is not recommended that you delete or blacklist accounts because this can simply indicate that the server is temporarily offline.|
|Broken URLs||Select the action to take for accounts that the scanner has found are no longer working. Broken URLs are those that return a HTTP status code of 400 or greater. For example, a 404 Not Found status code for pages that no longer exist, or a 500 Internal Server Error for pages that are causing a server error.|
|Forwarding URLs||Select the action to take for accounts that the scanner has found are forwarding to a different URL. Forwarding URLs are those that return a HTTP status code in the 300 range, for example 302 Found. The scanner will take into account the 'Allow URL redirection' setting for partners and whitelisted data. If the account is allowed to redirect, it will not be flagged for this issue type if it produces a 300 level HTTP status code.|
|Blacklisted data||Select the action to take for accounts that the scanner has found to contain one or more items on your blacklist.|
Editing a Scanner Configuration
To edit a scanner configuration you will first need to locate it through the Account Scanner Configurations interface. When you locate the configuration you want to edit, click on the icon to bring up the editing interface. This interface is nearly identical to the scanner configuration creation interface, and has the same form fields with the same properties. You can make the changes that you want, and then press the Update Scanner Configuration button to save your changes.
Deleting a Configuration
To edit a scanner configuration you will first need to locate it through the Account Scanner Configurations interface. When you locate the configuration you want to delete, click on the icon, which will ask you to confirm the deletion.
You can also delete several configurations at once by putting a check in the box next to the configurations you want to delete, then pressing the Delete button at the bottom of the page.
Alternate Methods for Starting/Stopping the Scanner
If you are not able to start the account scanner through the control panel, there is currently one alternate method to run the scanner. This requires that you have shell access to your server and are comfortable working with the server's shell environment. You can login to your server using your favorite shell access software. Once logged in, change into the admin directory of your ToplistX installation and issue the following command: