CheckAuthLog Reference documentation: Difference between revisions

From voipsupport
Jump to navigation Jump to search
No edit summary
No edit summary
Line 17: Line 17:
Manually adds the user to the blocked users
Manually adds the user to the blocked users


-c config_file: uses the named configuration file instead of checking in /etc/check_auth_log.conf
===-c config_file===
-d username: deletes the block, thereby re-enabling mail sending for the user.
 
-e email: sends a test blocking notification email to the specified address. Useful for testing email setup and template without having to trigger a block.
Uses the named configuration file instead of checking in /etc/check_auth_log.conf
-t activates tracing to standard output. Useful for debugging.
 
-v prints the version and terminates
===-d username===
-x extract the authenication entries from internal db. The database contains info on the authentication times and ip addresses. When new entries are added old ones are purged if no longer needed (older than expire time)
 
-y extract the cache file entries from internal cache file db. The cache file contains info on the log lines already parsed and their offset in the mail log file.
Deletes the block, thereby re-enabling mail sending for the user.
-z runs the self check routines only
 
===-e email===
 
Sends a test blocking notification email to the specified address. Useful for testing email setup and template without having to trigger a block.
 
===-t===
 
Activates tracing to standard output. Useful for debugging.
 
===-v===
 
Prints the version and terminates
 
===-x===
 
Extracts the authentication entries from internal db. The database contains info on the authentication times and ip addresses. When new entries are added old ones are purged if no longer needed (older than expire time).
 
===-y===
 
Extract the cache file entries from internal cache file db. The cache file contains info on the log lines already parsed and their offset in the mail log file.
 
===-z===
 
Runs the self check routines only


==Configuration File Reference==
==Configuration File Reference==

Revision as of 17:29, 13 June 2016

Running from Crontab

After installing and configuring Check Auth Log the best way to run it is to schedule it in crontab, for example:

vi /etc/crontab

The following entry will run CheckAuthLog every 5 minutes

*/5 * * * *     root /path/to/check_auth_log

If you provide the configuration file in the standard location /etc/check_auth_log.conf there is no need to run with any parameters.

Command Line Parameter Reference

-a username

Manually adds the user to the blocked users

-c config_file

Uses the named configuration file instead of checking in /etc/check_auth_log.conf

-d username

Deletes the block, thereby re-enabling mail sending for the user.

-e email

Sends a test blocking notification email to the specified address. Useful for testing email setup and template without having to trigger a block.

-t

Activates tracing to standard output. Useful for debugging.

-v

Prints the version and terminates

-x

Extracts the authentication entries from internal db. The database contains info on the authentication times and ip addresses. When new entries are added old ones are purged if no longer needed (older than expire time).

-y

Extract the cache file entries from internal cache file db. The cache file contains info on the log lines already parsed and their offset in the mail log file.

-z

Runs the self check routines only

Configuration File Reference