home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / webalizr.zip / sample.conf < prev    next >
Text File  |  1999-06-30  |  17KB  |  409 lines
  1. #
  2. # Sample Webalizer configuration file
  3. # Copyright 1997-1999 by Bradford L. Barrett (brad@mrunix.net)
  4. #
  5. # Distributed under the GNU General Public License.  See the
  6. # files "Copyright" and "COPYING" provided with the webalizer
  7. # distribution for additional information.
  8. #
  9. # This is a sample configuration file for the Webalizer (ver 1.30)
  10. # Lines starting with pound signs '#' are comment lines and are
  11. # ignored.  Blank lines are skipped as well.  Other lines are considered
  12. # as configuration lines, and have the form "ConfigOption  Value" where
  13. # ConfigOption is a valid configuration keyword, and Value is the value
  14. # to assign that configuration option.  Invalid keyword/values are
  15. # ignored, with appropriate warnings being displayed.  There must be
  16. # at least one space or tab between the keyword and its value.
  17. #
  18. # As of version 0.98, The Webalizer will look for a 'default' configuration
  19. # file named "webalizer.conf" in the current directory, and if not found
  20. # there, will look for "/etc/webalizer.conf".
  21.  
  22.  
  23. # LogFile defines the web server log file to use.  If not specified
  24. # here or on on the command line, input will default to STDIN.
  25.  
  26. #LogFile        /var/lib/httpd/logs/access_log
  27.  
  28. # LogType defines the log type being processed.  Normally, the Webalizer
  29. # expects a CLF or Combined web server log as input.  Using this option,
  30. # you can process ftp logs as well (xferlog as produced by wu-ftp and
  31. # others).  Values can be 'web' or 'ftp', with 'web' the default.
  32.  
  33. #LogType    web
  34.  
  35. # OutputDir is where you want to put the output files.  This should
  36. # should be a full path name, however relative ones might work as well.
  37. # If no output directory is specified, the current directory will be used.
  38.  
  39. #OutputDir      /var/lib/httpd/htdocs/usage
  40.  
  41. # HistoryName allows you to specify the name of the history file produced
  42. # by the Webalizer.  The history file keeps the data for up to 12 months
  43. # worth of logs, used for generating the main HTML page (index.html).
  44. # The default is a file named "webalizer.hist", stored in the specified
  45. # output directory.  If you specify just the filename (without a path),
  46. # it will be kept in the specified output directory.  Otherwise, the path
  47. # is relative to the output directory, unless absolute (leading /).
  48.  
  49. #HistoryName    webalizer.hist
  50.  
  51. # Incremental processing allows multiple partial log files to be used
  52. # instead of one huge one.  Useful for large sites that have to rotate
  53. # their log files more than once a month.  The Webalizer will save its
  54. # internal state before exiting, and restore it the next time run, in
  55. # order to continue processing where it left off.  This mode also causes
  56. # The Webalizer to scan for and ignore duplicate records (records already
  57. # processed by a previous run).  See the README file for additional
  58. # information.  The value may be 'yes' or 'no', with a default of 'no'.
  59. # The file 'webalizer.current' is used to store the current state data,
  60. # and is located in the output directory of the program (unless changed
  61. # with the IncrementalName option below).  Please read at least the section
  62. # on Incremental processing in the README file before you enable this option.
  63.  
  64. #Incremental    no
  65.  
  66. # IncrementalName allows you to specify the filename for saving the
  67. # incremental data in.  It is similar to the HistoryName option where the
  68. # name is relative to the specified output directory, unless an absolute
  69. # filename is specified.  The default is a file named "webalizer.current"
  70. # kept in the normal output directory.  If you don't specify "Incremental"
  71. # as 'yes' then this option has no meaning.
  72.  
  73. #IncrementalName    webalizer.current
  74.  
  75. # ReportTitle is the text to display as the title.  The hostname
  76. # (unless blank) is appended to the end of this string (seperated with
  77. # a space) to generate the final full title string.
  78. # Default is (for english) "Usage Statistics for".
  79.  
  80. #ReportTitle    Usage Statistics for
  81.  
  82. # HostName defines the hostname for the report.  This is used in
  83. # the title, and is prepended to the URL table items.  This allows
  84. # clicking on URL's in the report to go to the proper location in
  85. # the event you are running the report on a 'virtual' web server,
  86. # or for a server different than the one the report resides on.
  87. # If not specified here, or on the command line, webalizer will
  88. # try to get the hostname via a uname system call.  If that fails,
  89. # it will default to "localhost".
  90.  
  91. #HostName       localhost
  92.  
  93. # HTMLExtension allows you to specify the filename extension to use
  94. # for generated HTML pages.  Normally, this defaults to "html", but
  95. # can be changed for sites who need it (like for PHP embeded pages).
  96.  
  97. #HTMLExtension  html
  98.  
  99. # PageType lets you tell the Webalizer what types of URL's you
  100. # consider a 'page'.  Most people consider html and cgi documents
  101. # as pages, while not images and audio files.  If no types are
  102. # specified, defaults will be used ('htm*', 'cgi' and HTMLExtension
  103. # if different).
  104.  
  105. PageType    htm*
  106. PageType    cgi
  107. #PageType    phtml
  108. #PageType    php3
  109. #PageType    pl
  110.  
  111. # UseHTTPS should be used if the analysis is being run on a
  112. # secure server, and links to urls should use 'https://' instead
  113. # of the default 'http://'.  If you need this, set it to 'yes'.
  114. # Default is 'no'.  This only changes the behaviour of the 'Top
  115. # URL's' table.
  116.  
  117. #UseHTTPS       no
  118.  
  119. # HTMLPre defines HTML code to insert at the very beginning of the
  120. # file.  Default is the DOCTYPE line shown below.  Max line length
  121. # is 80 characters, so use multiple HTMLPre lines if you need more.
  122.  
  123. #HTMLPre <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  124.  
  125. # HTMLHead defines HTML code to insert within the <HEAD></HEAD>
  126. # block, immediately after the <TITLE> line.  Maximum line length
  127. # is 80 characters, so use multiple lines if needed.
  128.  
  129. #HTMLHead <META NAME="author" CONTENT="The Webalizer">
  130.  
  131. # HTMLBody defined the HTML code to be inserted, starting with the
  132. # <BODY> tag.  If not specified, the default is shown below.  If
  133. # used, you MUST include your own <BODY> tag as the first line.
  134. # Maximum line length is 80 char, use multiple lines if needed.
  135.  
  136. #HTMLBody <BODY BGCOLOR="#E8E8E8" TEXT="#000000" LINK="#0000FF" VLINK="#FF0000">
  137.  
  138. # HTMLPost defines the HTML code to insert immediately before the
  139. # first <HR> on the document, which is just after the title and
  140. # "summary period"-"Generated on:" lines.  If anything, this should
  141. # be used to clean up in case an image was inserted with HTMLBody.
  142. # As with HTMLHead, you can define as many of these as you want and
  143. # they will be inserted in the output stream in order of apperance.
  144. # Max string size is 80 characters.  Use multiple lines if you need to.
  145.  
  146. #HTMLPost     <BR CLEAR="all">
  147.  
  148. # HTMLTail defines the HTML code to insert at the bottom of each
  149. # HTML document, usually to include a link back to your home
  150. # page or insert a small graphic.  It is inserted as a table
  151. # data element (ie: <TD> your code here </TD>) and is right
  152. # alligned with the page.  Max string size is 80 characters.
  153.  
  154. #HTMLTail <IMG SRC="msfree.gif" ALT="100% Micro$oft free!">
  155.  
  156. # HTMLEnd defines the HTML code to add at the very end of the
  157. # generated files.  It defaults to what is shown below.  If
  158. # used, you MUST specify the </BODY> and </HTML> closing tags
  159. # as the last lines.  Max string length is 80 characters.
  160.  
  161. #HTMLEnd </BODY></HTML>
  162.  
  163. # The Quiet option suppresses output messages... Useful when run
  164. # as a cron job to prevent bogus e-mails.  Values can be either
  165. # "yes" or "no".  Default is "no".  Note: this does not suppress
  166. # warnings and errors (which are printed to stderr).
  167.  
  168. #Quiet        no
  169.  
  170. # ReallyQuiet will supress all messages including errors and
  171. # warnings.  Values can be 'yes' or 'no' with 'no' being the
  172. # default.  If 'yes' is used here, it cannot be overriden from
  173. # the command line, so use with caution.  A value of 'no' has
  174. # no effect.
  175.  
  176. #ReallyQuiet    no
  177.  
  178. # TimeMe allows you to force the display of timing information
  179. # at the end of processing.  A value of 'yes' will force the
  180. # timing information to be displayed.  A value of 'no' has no
  181. # effect.
  182.  
  183. #TimeMe        no
  184.  
  185. # GMTTime allows reports to show GMT (UTC) time instead of local
  186. # time.  Default is to display the time the report was generated
  187. # in the timezone of the local machine, such as EDT or PST.  This
  188. # keyword allows you to have times displayed in UTC instead.  Use
  189. # only if you really have a good reason, since it will probably
  190. # screw up the reporting periods by however many hours your local
  191. # time zone is off of GMT.
  192.  
  193. #GMTTime        no
  194.  
  195. # Debug prints additional information for error messages.  This
  196. # will cause webalizer to dump bad records/fields instead of just
  197. # telling you it found a bad one.   As usual, the value can be
  198. # either "yes" or "no".  The default is "no".  It shouldn't be
  199. # needed unless you start getting a lot of Warning or Error
  200. # messages and want to see why.  (Note: warning and error messages
  201. # are printed to stderr, not stdout like normal messages).
  202.  
  203. #Debug        no
  204.  
  205. # VisitTimeout allows you to set the default timeout for a visit
  206. # (sometimes called a 'session').  The default is 30 minutes,
  207. # which should be fine for most sites.  The value is formatted
  208. # as HHMMSS where HH=hours MM=minutes and SS=seconds (use '00').
  209. # Visits are determined by looking at the time of the current
  210. # request, and the time of the last request from the site.  If
  211. # the time difference is greater than the VisitTimeout value, it
  212. # is considered a new visit, and visit totals are incremented.
  213.  
  214. #VisitTimeout    3000
  215.  
  216. # IgnoreHist shouldn't be used in a config file, but it is here
  217. # just because it might be usefull in certain situations.  If the
  218. # history file is ignored, the main "index.html" file will only
  219. # report on the current log files contents.  Usefull only when you
  220. # want to reproduce the reports from scratch.  USE WITH CAUTION!
  221. # Valid values are "yes" or "no".  Default is "no".
  222.  
  223. #IgnoreHist    no
  224.  
  225. # Country Graph allows the usage by country graph to be disabled.
  226. # Values can be 'yes' or 'no', default is 'yes'.
  227.  
  228. #CountryGraph    yes
  229.  
  230. # HourlyGraph and HourlyStats allows the hourly statistics graph
  231. # and statistics table to be disabled (not displayed).  Values
  232. # may be "yes" or "no". Default is "yes".
  233.  
  234. #HourlyGraph    yes
  235. #HourlyStats    yes
  236.  
  237. # GraphLegend allows the color coded legends to be turned on or off
  238. # in the graphs.  The default is for them to be displayed.  This only
  239. # toggles the color coded legends, the other legends are not changed.
  240. # If you think they are hideous and ugly, say 'no' here :)
  241.  
  242. #GraphLegend    yes
  243.  
  244. # GraphLines allows you to have index lines drawn behind the graphs.
  245. # I personally am not crazy about them, but a lot of people requested
  246. # them and they weren't a big deal to add.  The number represents the
  247. # number of lines you want displayed.  Default is 2, you can disable
  248. # the lines by using a value of zero ('0').  [max is 20]
  249. # Note, due to rounding errors, some values don't work quite right.
  250. # The lower the better, with 1,2,3,4,6 and 10 producing nice results.
  251.  
  252. #GraphLines    2
  253.  
  254. # The "Top" options below define the number of entries for each table.
  255. # Defaults are Sites=30, URL's=30, Referrers=30 and Agents=15, and
  256. # Countries=50. TopKSites and TopKURLs (by KByte tables) both default
  257. # to 10, as do the top entry/exit tables (TopEntry/TopExit).  The top
  258. # search strings default to 20.  Tables may be disabled by using
  259. # zero (0) for the value.
  260.  
  261. #TopSites        30
  262. #TopKSites       10
  263. #TopURLs         30
  264. #TopKURLs        10
  265. #TopReferrers    30
  266. #TopAgents       15
  267. #TopCountries    50
  268. #TopEntry        10
  269. #TopExit         10
  270. #TopSearch       20
  271.  
  272. # The Webalizer normally strips the string 'index.' off the end of
  273. # URL's in order to consolidate URL totals.  For example, the URL
  274. # /somedir/index.html is turned into /somedir/ which is really the
  275. # same URL.  This option allows you to specify additional strings
  276. # to treat in the same way.  You don't need to specify 'index.' as
  277. # it is always scanned for by The Webalizer, this option is just to
  278. # specify _additional_ strings if needed.  If you don't need any,
  279. # don't specify any as each string will be scanned for in EVERY
  280. # log record... A bunch of them will degrade performance.  Also,
  281. # the string is scanned for anywhere in the URL, so a string of
  282. # 'home' would turn the URL /somedir/homepages/brad/home.html into
  283. # just /somedir/ which is probably not what was intended.
  284.  
  285. #IndexAlias     home.htm
  286. #IndexAlias    homepage.htm
  287.  
  288. # The Hide*, Group* and Ignore* and Include* keywords allow you to change
  289. # the way Sites, URL's, Referrers and User Agents are manipulated.  The
  290. # Ignore* keywords will cause The Webalizer to completely ignore
  291. # records as if they didn't exist (and thus not counted in the main
  292. # site totals).  The Hide* keywords will prevent things from being
  293. # displayed in the 'Top' tables, but will still be counted in the
  294. # main totals.  The Group* keywords allow grouping similar objects
  295. # as if they were one.  Grouped records are displayed in the 'Top'
  296. # tables and can optionally be displayed in BOLD and/or shaded.
  297. # Groups cannot be hidden, and are not counted in the main totals.
  298. # The Group* options do not, by default, hide all the items that
  299. # it matches.  If you want to hide the records that match (so just
  300. # the grouping record is displayed), follow with an identical Hide*
  301. # keyword with the same value.  (see example below)  In addition,
  302. # Group* keywords may have an optional label which will be displayed
  303. # instead of the keywords value.  The label should be seperated from
  304. # the value by at least one 'white-space' character, such as a space
  305. # or tab.
  306. #
  307. # The value can have either a leading or trailing '*' wildcard
  308. # character.  If no wildcard is found, a match can occur anywhere
  309. # in the string. Given a string "www.yourmama.com", the values "your",
  310. # "*mama.com" and "www.your*" will all match.
  311.  
  312. # Your own site should be hidden
  313. #HideSite    *mrunix.net
  314. #HideSite    localhost
  315.  
  316. # Your own site gives most referrals
  317. #HideReferrer    mrunix.net/
  318.  
  319. # This one hides non-referrers ("-" Direct requests)
  320. #HideReferrer    Direct Request
  321.  
  322. # Usually you want to hide these
  323. HideURL        *.gif
  324. HideURL        *.GIF
  325. HideURL        *.jpg
  326. HideURL        *.JPG
  327. HideURL        *.ra
  328.  
  329. # Hiding agents is kind of futile
  330. #HideAgent    RealPlayer
  331.  
  332. # Grouping options
  333. #GroupURL    /cgi-bin/*    CGI Scripts
  334. #GroupURL    /images/*    Images
  335.  
  336. #GroupSite    *.aol.com
  337. #GroupSite    *.compuserve.com
  338.  
  339. #GroupReferrer    yahoo.com/    Yahoo!
  340. #GroupReferrer    excite.com/     Excite
  341. #GroupReferrer    infoseek.com/   InfoSeek
  342. #GroupReferrer    webcrawler.com/ WebCrawler
  343.  
  344. # The following is a great way to get an overall total
  345. # for browsers, and not display all the detail records.
  346. # (You should use MangleAgent to refine further...)
  347.  
  348. #GroupAgent    MSIE        Micro$oft Internet Exploder
  349. #HideAgent    MSIE
  350. #GroupAgent    Mozilla        Netscape
  351. #HideAgent    Mozilla
  352. #GroupAgent    Lynx*        Lynx
  353. #HideAgent    Lynx*
  354.  
  355. # The GroupShading allows grouped rows to be shaded in the report.
  356. # Useful if you have lots of groups and individual records that
  357. # intermingle in the report, and you want to diferentiate the group
  358. # records a little more.  Value can be 'yes' or 'no', with 'yes'
  359. # being the default.
  360.  
  361. #GroupShading    yes
  362.  
  363. # GroupHighlight allows the group record to be displayed in BOLD.
  364. # Can be either 'yes' or 'no' with the default 'yes'.
  365.  
  366. #GroupHighlight    yes
  367.  
  368. # The Ignore* keywords allow you to completely ignore log records based
  369. # on hostname, URL, user agent or referrer.  I hessitated in adding these,
  370. # since the Webalizer was designed to generate _accurate_ statistics
  371. # about a web servers performance.  By choosing to ignore records, the
  372. # accuracy of reports become skewed, negating why I wrote this program
  373. # in the first place.  However, due to popular demand, here they are.
  374. # Use the same as the Hide*/Group* keywords, where the value can have a
  375. # leading or trailing wildcard '*'.
  376.  
  377. #IgnoreSite    bad.site.net
  378. #IgnoreURL    /test*
  379. #IgnoreReferrer    file:/*
  380. #IgnoreAgent    RealPlayer
  381.  
  382. # The Include* keywords allow you to force the inclusion of log records
  383. # based on hostname, URL, user agent or referrer.  They take precidence
  384. # over the Ignore* keywords.  Note: Using Ignore/Include combinations to
  385. # selectivly process parts of a web site is _extremely inefficent_!!!
  386. # Avoid doing so if possible (ie: grep the records to a seperate file).
  387.  
  388. # Example: Only show stats on Joe User's pages...
  389. #IgnoreURL    *
  390. #IncludeURL    ~joeuser*
  391.  
  392. # The MangleAgents allows you to specify how much, if any, The Webalizer
  393. # should mangle user agent names.  This allows several levels of detail
  394. # to be produced when reporting user agent statistics.  There are six
  395. # levels that can be specified, which define different levels of detail
  396. # supression.  Level 5 shows only the browser name (MSIE or Mozilla)
  397. # and the major version number.  Level 4 adds the minor version number
  398. # (single decimal place).  Level 3 displays the minor version to two
  399. # decimal places.  Level 2 will add any sub-level designation (such
  400. # as Mozilla/3.01Gold or MSIE 3.0b).  Level 1 will attempt to also add
  401. # the system type if it is specified.  The default Level 0 displays the
  402. # full user agent field without modification and produces the greatest
  403. # amount of detail.  User agent names that can't be mangled will be
  404. # left unmodified.
  405.  
  406. #MangleAgents    0
  407.  
  408. # End of configuration file...  Have a nice day!
  409.