Location: PHPKode > projects > XMail Log Archiver > xmlogarch.d/xmlogarch_conf.php
<?php
/*
	 License
    XMail Log Archiver
	 http://xmlogarch.sourceforge.net
    Copyright (C) 2006 Bryn Mosher

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License Version 2 as
	 published by the Free Software Foundation.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not contact , write to 
	 hide@address.com
	 - or -
	 Free Software Foundation, Inc.
	 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#
# User defined options
# Before changing these settings, please run 'xmlogarch --help' and read
# the help text completely.
#

#
# TRUE/FALSE (switch) settings
#
# show something for every repeated action
# command line option: -da
$dotAll = FALSE;
# !$moveLogs NOT FULLY IMPLEMENTED YET - DO NOT USE !
# command line option: -m
$moveLogs = TRUE;
# do not report anything (ie: do nothing ) for configuration testing
# command line option: -n
$noReports = FALSE;
# Do not print output to console
# command line option: -q
$quiet = FALSE;
# quitely skip disabled reports
# command line option: -qs
$quietSkip = FALSE;
# report memory use to console
# command line option: -u
$reportMemUse = FALSE;
# send report to $reportRecipient below
$sendMail = FALSE;
#whether or not to show dots
# command line option: -d
$showDots = TRUE;
# write actions and information to xmlogarch-YYYYMMDDHHHH within the
# MailRoot's log directory - this ignores XMail's log rotation settings
# and merely creates logs once per day. Command line switch turns off
# logging.
# command line option: -nl
$toLogFile = TRUE;
#verbose output
# command line option: -v
$verbose = FALSE;
# wordrap output to 80 characters - this also activates $wrapScores
$wrap = TRUE;
# wordrap high scores to 80 characters for readable formatting
$wrapScores = TRUE;
# !$zipLogs NOT FULLY IMPLEMENTED YET - DO NOT USE !
$zipLogs = TRUE;

#
# Settings with values
#
# dots to print per processed item
# command line option: -dp
$dotsPer = "10";
# dot multiplier for large numbers of steps, such as reading each line of a 100MB+ log file
# command line option: -dpe
$dotsPerEntry = "10";
# number of high scores to show
# command line option: -t
$highScoreCount = "10";
# log file search patterns to process (wildcards ok)
$logTypes = "pop3-* lmail-* filters-* finger-* smail-* ctrl-* smtp-* logarch-*";
# Max memory in megabytes
# command line option: -mm
$maxMem = "32";
# who to email reports to if $sendMail is enabled
$reportRecipient = "hide@address.com";
# hours before logs get moved by us - compares against file modification time as xmail creates new logs every day
# command line option: -s
$staleAge = "24";

#
# XMail server information
#
# XMail control account user name
$xmailLogin = "root";
# whether or not the XMail ctrl account password in this config is encrypted or not.
# a setting of TRUE means a plain text password
$truePass = FALSE;
# optionally encrypted copy of XMail ctrl account's password. Command line option -gp generates the password
# command line option: -p
$xmailPass = "";
# XMail administrative port
# command line option: -xp
$xmailPort = "6017";
# server name of XMail server
$xmailServer = "mail.yourdomain.com";

#
# directory and file settings of this scripts components
#
# geets appended to $logDir
$archDir = "archive";
# gets appended to $mailRoot
$logDir = "logs";
# XMail's MailRoot directory
$mailRoot = "/var/MailRoot";
# location of report modules - write code to validate this
$repModsLoc = "/var/MailRoot/bin/xmlogarch.d/reports.d";
# name of zip file to archive logs into if zipping is enabled
$zipFile = "xmail_log_arch.zip";

#
# directory and file locations of external commands
# Windows users can get zip and mv from http://unxutils.sourceforge.net/
# linux users can probably leave the defaults
#
# move command
$mvCommand = "/bin/mv";
# move command options
# for more info type 'mv --help' at a console
$mvCommandOpts = "-uv";
# zip command
$zipCommand = "/usr/bin/zip";
# zip command options
# for more info type 'zip --help' at a console
$zipCommandOpts = "-u -9 -m -D";

#
# reports
#
# HELO bouncer from http://brynmosher.com/bouncer.zip
$bouncerReport = FALSE;
# crtl accounts report
$ctrlReport = TRUE;
# finger report
$fingerReport = FALSE;
# filters report
$filtersReport = TRUE;
# moved to archive logs report
$moveReport = FALSE;
# pop3 report
$pop3Report = TRUE;
# server status report
$serverReport = TRUE;
# smtp report
$smtpReport = TRUE;
# zipped logs report
$zipReport = FALSE;

#
# testing only settings
# testing mode is incomplete, so please just leave these be
#
# testing mode - as yet to be fully coded - do not use
$testing = FALSE;
# fake XMail root directory containing a copy of your server's 'logs' directory for testing
# the copy will be freshened with actual logs from MailRoot when run but old logs will remain
$testMailRoot = "/foo/bar/tst";

?>
Return current item: XMail Log Archiver