# $Id: sample.conf 171 2006-02-13 10:47:21Z steve $ # # Sample AWFFull configuration file # Copyright 1997-2000 by Bradford L. Barrett (brad@mrunix.net) # Copyright 2004, 2005, 2006 by Steve McInerney (spm@stedee.id.au) # # Distributed under the GNU General Public License. See the # files "Copyright" and "COPYING" provided with the AWFFull # distribution for additional information. # # This is a sample configuration file for AWFFull (v3.00) # Lines starting with pound signs '#' are comment lines and are # ignored. Blank lines are skipped as well. Other lines are considered # as configuration lines, and have the form "ConfigOption Value" where # ConfigOption is a valid configuration keyword, and Value is the value # to assign that configuration option. Invalid keyword/values are # ignored, with appropriate warnings being displayed. There must be # at least one space or tab between the keyword and its value. # # AWFFull will look for a 'default' configuration file named "awffull.conf" # in the current directory, and if not found there, will look for # "/etc/awffull.conf". # LogFile defines the web server log file to use. If not specified # here or on on the command line, input will default to STDIN. If # the log filename ends in '.gz' (ie: a gzip compressed file), it will # be decompressed on the fly as it is being read. LogFile /var/log/httpd/access_log # LogType defines the log type being processed. Normally, AWFFull # expects a CLF or Combined web server log as input. Using this option, # you can process ftp logs as well (xferlog as produced by wu-ftp and # others), or Squid native logs. Values can be 'clf', 'ftp' or 'squid', # with 'clf' the default. #LogType clf # OutputDir is where you want to put the output files. This should # should be a full path name, however relative ones might work as well. # If no output directory is specified, the current directory will be used. OutputDir /var/www/html/usage # HistoryName allows you to specify the name of the history file produced # by AWFFull. The history file keeps the data for up to 12 months # worth of logs, used for generating the main HTML page (index.html). # The default is a file named "awffull.hist", stored in the specified # output directory. If you specify just the filename (without a path), # it will be kept in the specified output directory. Otherwise, the path # is relative to the output directory, unless absolute (leading /). HistoryName awffull.hist # Incremental processing allows multiple partial log files to be used # instead of one huge one. Useful for large sites that have to rotate # their log files more than once a month. AWFFull will save its # internal state before exiting, and restore it the next time run, in # order to continue processing where it left off. This mode also causes # AWFFull to scan for and ignore duplicate records (records already # processed by a previous run). See the README file for additional # information. The value may be 'yes' or 'no', with a default of 'no'. # The file 'awffull.current' is used to store the current state data, # and is located in the output directory of the program (unless changed # with the IncrementalName option below). Please read at least the section # on Incremental processing in the README file before you enable this option. #Incremental no # IncrementalName allows you to specify the filename for saving the # incremental data in. It is similar to the HistoryName option where the # name is relative to the specified output directory, unless an absolute # filename is specified. The default is a file named "awffull.current" # kept in the normal output directory. If you don't specify "Incremental" # as 'yes' then this option has no meaning. IncrementalName awffull.current # ReportTitle is the text to display as the title. The hostname # (unless blank) is appended to the end of this string (seperated with # a space) to generate the final full title string. # Default is (for english) "Usage Statistics for". ReportTitle Usage Statistics for # HostName defines the hostname for the report. This is used in # the title, and is prepended to the URL table items. This allows # clicking on URL's in the report to go to the proper location in # the event you are running the report on a 'virtual' web server, # or for a server different than the one the report resides on. # If not specified here, or on the command line, awffull will # try to get the hostname via a uname system call. If that fails, # it will default to "localhost". #HostName localhost # HTMLExtension allows you to specify the filename extension to use # for generated HTML pages. Normally, this defaults to "html", but # can be changed for sites who need it (like for PHP embeded pages). #HTMLExtension html # PageType lets you tell AWFFull what types of URL's you # consider a 'page'. Most people consider html and cgi documents # as pages, while not images and audio files. If no types are # specified, defaults will be used ('htm', 'html', 'cgi' and HTMLExtension # if different for web logs, 'txt' for ftp logs). # Putting the more likely page types first in the list should increase the # speed of a run. PageType htm PageType html PageType cgi PageType php #PageType pl #PageType cfm #PageType phtml #PageType php3 #PageType pdf #PageType txt # NotPageType is the direct and incompatible opposite of PageType. # You can use one set or the other, but not both. # PageType specifies what *is* a Page, NotPageType specifices what # *isn't*, and hence by implication, everything else is a page. # Neither method is more or lessor correct than the other. It's more # what is more accurate for *your* site. # Do not add the "." or use any wildcards. As a general rule. # There are some assumed internal optimisations that may otherwise # break. # Those who understand pcre's would do well to examine the source # of parser.c if they wish to extract greater flexibility from the # below. #NotPageType gif #NotPageType css #NotPageType js #NotPageType jpg #NotPageType ico #NotPageType png # CSSFilename is used to set the name of the CSS file to use in conjunction # with the generated html. An existing file is *not* overwritten, so feel free # to make you own changes to the default file. #CSSFilename awffull.css # UseHTTPS should be used if the analysis is being run on a # secure server, and links to urls should use 'https://' instead # of the default 'http://'. If you need this, set it to 'yes'. # Default is 'no'. This only changes the behaviour of the 'Top # URL's' table. #UseHTTPS no # HTMLPre defines HTML code to insert at the very beginning of the # file. Default is the DOCTYPE line shown below. Max line length # is 80 characters, so use multiple HTMLPre lines if you need more. #HTMLPre # HTMLHead defines HTML code to insert within the
# block, immediately after the
# HTMLEnd defines the HTML code to add at the very end of the
# generated files. It defaults to what is shown below. If
# used, you MUST specify the and closing tags
# as the last lines. Max string length is 80 characters.
#HTMLEnd