# AWStats configure file #----------------------------------------------------------------------------- # Copy this file into awstats.www.mydomain.conf or awstats.conf and edit this # new file to setup AWStats (See documentation in docs/ directory). # The config file must be in /etc/opt/awstats, /etc/awstats or /etc (for # Unix/Linux) or same directory than awstats.pl (Windows, Mac, Unix/Linux...) # To include an environment variable in any parameter (AWStats will replace # it with its value when reading it), follow the example: # Parameter="__ENVNAME__" #----------------------------------------------------------------------------- # $Revision: 1.122 $ - $Author: eldy $ - $Date: 2002/09/28 21:07:52 $ #----------------------------------------------------------------------------- # MAIN SETUP SECTION (Required to make AWStats work) #----------------------------------------------------------------------------- # "LogFile" contains the web server logfile to analyze. # Possible values: A full path, or a relative path from awstats.pl directory. # Example: "/var/log/apache/access.log" # Example: "../logs/mycombinedlog.log" # You can also use tags in this filename if you need a dynamic file name # depending on date or time (Replacement is made by AWStats at the beginning # of its execution). This is available tags : # %YYYY-n is replaced with 4 digits year we were n hours ago # %YY-n is replaced with 2 digits year we were n hours ago # %MM-n is replaced with month we were n hours ago # %DD-n is replaced with day we were n hours ago # %HH-n is replaced with hour we were n hours ago # %NS-n is replaced with number of seconds at 00:00 since 1970 # %WM-n is replaced with the week number in month (1-5) # %WY-n is replaced with the week number in year (1-52) # %DW-n is replaced with the day number in week (1-7, 1=sunday) # use n=24 if you need (1-7, 1=monday) # Use 0 for n if you need current year, month, day, hour... # Example: "/var/log/access_log.%YYYY-0%MM-0%DD-0.log" # Example: "C:/WINNT/system32/LogFiles/W3SVC1/ex%YY-24%MM-24%DD-24.log" # You can also use a pipe if log file come from a pipe. # Example: "gzip -d outputpath/output.html"), enter # path of icon directory relative to the directory outputpath. # Example: "/icon" # Example: "../icon" # Default: "/icon" (means you must copy icon directories in "/mywwwroot/icon") # DirIcons="/icon" # "SiteDomain" must contain the main domain name or the main intranet web # server name used to reach the web site. # If you share the same log file for several virtual web servers, this # parameter is used to tell AWStats to filter record that contains records for # this virtual host name only (So check that this virtual hostname can be # found in your log file and use a personalized log format that include the # %virtualname tag). # But for multi hosting a better solution is to have one log file for each # virtual web server. In this case, this parameter is only used to generate # full URL's links when ShowLinksOnUrl option is set to 1. # Example: "www.mydomain.com" # Example: "user.mydomain.com" # Example: "myintranetserver" # SiteDomain="" # Enter here all other possible domain names, addresses or virtual host # aliases someone can use to access your site. Try to keep only the minimum # number of possible names/addresses to have the best performances. # You can repeat the "SiteDomain" value in this list. # Use space between each value. # This parameter is used to analyze referer field in log file and to help # AWStats to know if a referer URL is a local URL of same site or an URL of # another site. # Example: "www.myserver.com x.y.z.w localhost 127.0.0.1" # HostAliases="www.myserver.com x.y.z.w localhost 127.0.0.1" # When this parameter is set to 1, AWStats add a button on report page to # allow to "update" statistics from a web browser. Warning, when "update" is # made from a browser, AWStats is ran as a CGI by the web server user defined # in your web server (user "nobody" by default with Apache, "IUSR_XXX" with # IIS), so the "DirData" directory and all already existing history files # awstatsMMYYYY[.xxx].txt must be writable by this user. Change permissions if # necessary to "Read/Write" (and "Modify" for Windows NTFS file systems). # Warning: Update process can be long so you might experience "time out" # browser errors if you don't launch AWStats enough frequently. # When set to 0, update is only made when AWStats is ran from the command # line interface (or a task scheduler). # Possible values: 0 or 1 # Default: 0 # AllowToUpdateStatsFromBrowser=0 #----------------------------------------------------------------------------- # OPTIONAL SETUP SECTION (Not required but increase AWStats features) #----------------------------------------------------------------------------- # When the update process run, AWStats can set a lock file in TEMP or TMP # directory. This lock is to avoid to have 2 update processes running at the # same time to prevent unknown conflicts problems and avoid DoS attacks when # AllowToUpdateStatsFromBrowser is set to 1. # Because, when you use lock file, you can experience sometimes problems in # lock file not correctly removed (when process is killed for example that # require that you remove the file manualy), this option is not enabled by # default (Do not enable this option with no consol server access). # Possible values: 0 or 1 # Default: 0 # EnableLockForUpdate=0 # AWStats can do reverse DNS lookups through a static DNS cache file that was # previously created manually. If no path is gave in static DNS cache file # name, AWStats will search DirData directory. This file is never changed. # This option is not used if DNSLookup=0. # Note: DNS cache file format is 'minsince1970 ipaddress resolved_hostname' # or just 'ipaddress resolved_hostname' # Example: "/mydnscachedir/dnscache" # Default: "dnscache.txt" # DNSStaticCacheFile="dnscache.txt" # AWStats can do reverse DNS lookups through a DNS cache file that was created # by a previous run of AWStats. This file is erased and recreated after each # statistics update process. You don't need to create and/or edit it. # AWStats will read and save this file in DirData directory. # This option is not used if DNSLookup=0. # Example: "/mydnscachedir/dnscachelastupdate" # Default: "dnscachelastupdate.txt" # DNSLastUpdateCacheFile="dnscachelastupdate.txt" # You can specify specific IP addresses that should NOT be looked up in # the DNS. You may specify partial addresses (ie 163.85. for everything # behind the usual firewall setup, etc)... # This option is used only if DNSLookup=1. # Note: Use space between each value. # Example: "163.85. 201.101.51.2" # Default: "" # SkipDNSLookupFor="" # The following two parameters allow you to protect a config file from being # read by AWStats when called from a browser if web user has not been # authenticated. Your AWStats program must be in a web protected "realm" (With # Apache, you can use .htaccess files to do so. With other web servers, see # your server setup manual). # Possible values: 0 or 1 # Default: 0 # AllowAccessFromWebToAuthenticatedUsersOnly=0 # This parameter give the list of all authorized authenticated users to view # statistics for this domain/config file. This parameter is used only if # AllowAccessFromWebToAuthenticatedUsersOnly is set to 1. # Example: "user1 user2" # Example: "__REMOTE_USER__" # Default: "" # AllowAccessFromWebToFollowingAuthenticatedUsers="" # When this parameter is define to something, the IP address of the user that # read its statistics from a browser (when AWStats is used as a CGI) is # checked and must match the IP address range defined by this parameter. # Example: "123.123.123.10-123.123.123.255" # Default: "" # AllowAccessFromWebToFollowingIPAddresses="" # If the "DirData" directory (see above) does not exists, AWStats return an # error. However, you can ask AWStats to create it. # This option can be used by some Web Hosting Providers that has defined a # dynamic value for DirData (for example DirData="/home/__REMOTE_USER__") and # don't want to have to create a new directory each time they add a new user. # Possible values: 0 or 1 # Default: 0 # CreateDirDataIfNotExists=0 # In most case, AWStats is used as a cgi program. So AWStats process is ran # by default web server user (nobody for Unix, IUSR_xxx for IIS/Windows,...). # To make use easier and avoid permission's problems between update process # (run by an admin user) and CGI process (ran by a low level user), AWStats # save its database files with read and write for everyone. # If you have experience on managing security policies (Web Hosting Provider), # you should set this parameter to 0. AWStats will keep default process user # permissions on its files. # Possible values: 0 or 1 # Default: 1 # SaveDatabaseFilesWithPermissionsForEveryone=1 # AWStats can purge log after processing it. By this way, the next time you # launch AWStats, log file will be smaller and processing time will be better. # IMPORTANT !!! # AWStats is able to detect new lines in log file, to process only them, so # you can launch AWStats as soon as you want, even with this parameter to 0. # With 0, no purge is made, so you must use a scheduled task or a web server # that make this purge frequently. # With 1, the purge of the log file is made each time AWStats update is ran. # This parameter doesn't work with IIS (This web server doesn't let its log # file to be purged). # Possible values: 0 or 1 # Default: 0 # PurgeLogFile=0 # When PurgeLogFile is setup to 1, AWStats will clean your log file after # processing it. You can however keep an archive file (saved in "DirData") of # all processed log records by setting this to 1 (For example if you want to # use another log analyzer). # This parameter is not used if PurgeLogFile=0 # Possible values: 0 or 1 # Default: 0 # ArchiveLogRecords=0 # Each time you run the update process, AWStats overwrite the 'historic file' # for the month (awstatsMMYYYY[.*].txt) with the updated one. # When write errors occurs (IO, disk full,...), this historic file can be # corrupted and must be deleted. Because this file contains information of all # past processed log files, you will loose old stats if removed. So you can # ask AWStats to save last non corrupted file in a .bak file. This file is # stored in "DirData" directory with other 'historic files'. # Possible values: 0 or 1 # Default: 1 # KeepBackupOfHistoricFiles=0 # Default index page name for your web server. # Example: "default.htm default.html" # Default: "index.html" # DefaultFile="index.html" # Do not include access from clients that match following criteria. # If your log file contains IP adresses in host field, you must enter here # matching IP adresses criteria. # If DNS lookup is already done in your log file, you must enter here hostname # criteria. # Note: Use space between each value. # Example: "127.0.0.1 163.84. 201.101.51.1" # Example: "localhost abcxyz" # Default: "" # SkipHosts="" # Use SkipFiles to ignore access to URLs that match one of following entries. # You can, with this option, add a list of not important frame pages (like # menus, etc...) to exclude them from statistics. # For example, to ignore a whole directory tree, just add "directorytoignore", # to ignore "users" pages in your stats, you can add "/~". # The oposite parameter of "SkipFiles" is "OnlyFiles". # Note: This parameter is not case sensitive. # Note: Use space between each value and do not remove default values. # Note: xxx$ means URL ending with xxx. # Example: "robots.txt$ favicon.ico$ badpage.html /~" # Default: "robots.txt$ favicon.ico$" # SkipFiles="robots.txt$ favicon.ico$" # Include in stats, only accesses to URLs that match one of following entries. # For example, if you want AWStats to filter access to keep only stats that # match a particular string, like a particular directory, you can add this # directory name in this parameter. # The opposite parameter of "OnlyFiles" is "SkipFiles". # Note: This parameter is not case sensitive. # Note: Use space between each value and do not remove default values # Note: xxx$ means URL ending by xxx. # Example: "marketing_directory" # Default: "" # OnlyFiles="" # Add here a list of kind of url (file extension) that must be counted as # "Hit only" and not as a "Hit" and "Page/Download". You can set here all # images extensions as they are hit downloaded that must be counted but they # are not viewed pages. URLs with such extensions are not included in the TOP # Pages/URL report. # Note: If you want to exclude your own URLs from stats (No Pages and no Hits # reported), you should use SkipFiles parameter instead. # Example: "" # Example: "css js class gif jpg jpeg png bmp zip arj gz z wav mp3 wma mpg" # Default: "css js class gif jpg jpeg png bmp" # NotPageList="css js class gif jpg jpeg png bmp" # By default, AWStats considers that records found in log file are successful # hits if HTTP code returned by server is a valid HTTP code (200 and 304). # Any other code are reported in HTTP error chart. # However in some specific environment, with web server HTTP redirection, # you can choose to also accept other codes. # Example: "200 304 302 305" # Default: "200 304" # ValidHTTPCodes="200 304" # Keep or attach the query string to the URL in the statistics for individual # pages. This is primarily used to differentiate between the URLs of dynamic # pages. If set to 1, mypage.html?id=x and mypage.html?id=y are counted as two # different pages. # Warning, when set to 1, memory required to run AWStats is dramatically # increased if you have a lot of changing URLs (for example URLs with a random # id inside). Such web sites should not set this option to 1. # Possible values: # 0 - URLs are cleaned from the query string (ie: "/mypage.html") # 1 - Full URL with query string is used (ie: "/mypage.html?x=y") # Default: 0 # URLWithQuery=0 # AWStats can detect setup problems or show you important informations to have # a better use. Keep this to 1, except if AWStats says you can change it. # Possible values: 0 or 1 # Default: 1 # WarningMessages=1 # To help you to detect if your log format is good, AWStats report an error # if all the first NbOfLinesForCorruptedLog lines have a format that does not # match the LogFormat parameter. # However, some worm virus attack on your web server can result in a very high # number of corrupted lines in your log. So if you experience awstats stop # because of bad virus records at the beginning of your log file, you can # increase this parameter (very rare). # Default: 50 # NbOfLinesForCorruptedLog=50 # For some particular integration needs, you may want to have CGI links to # point to another script than awstats.pl. # Use the name of this script in WrapperScript parameter. # Example: "awstatslauncher.pl" # Default: "" # WrapperScript="" # DecodeUA must be set to 1 if you use Roxen web server. This server converts # all spaces in user agent field into %20. This make the AWStats robots, os # and browsers detection fail in some cases. Just change it to 1 if and only # if your web server is Roxen. # Possible values: 0 or 1 # Default: 0 # DecodeUA=0 #----------------------------------------------------------------------------- # OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features) #----------------------------------------------------------------------------- # Following values allows you to disable/enable some AWStats features. # Possible values: 0, 1 (or 2 for LevelForRobotsDetection) # Default: 1 (2 for LevelForRobotsDetection) # LevelForRobotsDetection=2 # 0 will increase AWStats speed by 1%. LevelForBrowsersDetection=1 # 0 disables Browsers detection. No speed gain. LevelForOSDetection=1 # 0 disables OS detection. No speed gain. LevelForRefererAnalyze=1 # 0 will increase AWStats speed by 5%. #----------------------------------------------------------------------------- # OPTIONAL APPEARANCE SETUP SECTION (Not required but increase AWStats features) #----------------------------------------------------------------------------- # When you use AWStats as a CGI, you can have the reports shown in HTML frames. # Frames are only available for report viewed dynamically. When you build # pages from command line, this option is not used and no frames are built. # Possible values: 0 or 1 # Default: 0 # UseFramesWhenCGI=0 # This parameter ask your browser to open detailed reports into a different # window than the main page. # Possible values: # 0 - Open all in same browser window # 1 - Open detailed reports in another window except if using frames # 2 - Open always in a different window even if reports are framed # Default: 1 # DetailedReportsOnNewWindows=1 # You can add in the HTML report page a delay to force browsers to not use cache # if page is loaded a second time after this delay (in seconds). # This parameter is not used when report are built with -staticlinks option. # Example: 3600 # Default: 0 # Expires=0 # To avoid too large web pages, you can ask AWStats to limit number of rows of # all reported charts to this number when no other limit apply. # Default: 1000 # MaxRowsInHTMLOutput=1000 # Set your primary language. # Possible value: # Bosnian=ba, Chinese (Taiwan)=tw, Chinese (Traditional)=cn, Czech=cz, # Danish=dk, Dutch=nl, English=en, Finnish=fi, French=fr, German=de, # Greek=gr, Hungarian=hu, Indonesian=id, Italian=it, Japanese=jp, Korean=kr, # Latvian=lv, Norwegian (Nynorsk)=nn, Norwegian (Bokmal)=nb, Polish=pl, # Portuguese=pt, Portuguese (Brazilian)=br, Romanian=ro, Russian=ru, # Slovak=sk, Spanish=es, Spanish (Catalan)=es_cat, Swedish=se, Turkish=tr, # Ukrainian=ua # Default: "en" # Lang="en" # Set the location of language files. # Example: "/opt/awstats/lang" # Default: "./lang" (means lang directory is in same location than awstats.pl) # DirLang="./lang" # You choose here which summary report you want to see in the main page. # Whatever is your setup here, all detailed reports are still available. # So if you setup ShowHeader, ShowMenu and ShowMonthDayStats to 1 and all # others to 0, all links in menu will still point to detailed views. # Possible values: 0 or 1 # ShowHeader=1 # Show AWStats head title and icon ShowMenu=1 # Show menu header with links on detailed reports ShowMonthDayStats=1 ShowDaysOfWeekStats=1 ShowHoursStats=1 ShowDomainsStats=1 ShowHostsStats=1 ShowAuthenticatedUsers=0 ShowRobotsStats=1 ShowSessionsStats=1 ShowPagesStats=1 ShowCompressionStats=0 # Show compression statistics when using mod_gzip ShowFileTypesStats=1 ShowFileSizesStats=0 # Not yet available ShowBrowsersStats=1 ShowOSStats=1 ShowOriginStats=1 ShowKeyphrasesStats=1 ShowKeywordsStats=1 ShowHTTPErrorsStats=1 ShowEMailSenders=0 # For use when analyzing mail log files. Not yet available ShowEMailReceivers=0 # For use when analyzing mail log files. Not yet available # This value can be used to choose maximum number of lines shown for each # particular reporting. # # Stats by domains MaxNbOfDomain = 20 # Stats by hosts MaxNbOfHostsShown = 20 MinHitHost = 1 # Stats by authenticated users MaxNbOfLoginShown = 10 MinHitLogin = 1 # Stats by robots MaxNbOfRobotShown = 10 MinHitRobot = 1 # Stats by pages MaxNbOfPageShown = 20 MinHitFile = 1 # Stats by referers MaxNbOfRefererShown = 10 MinHitRefer = 1 # Stats for keyphrases MaxNbOfKeyphrasesShown = 20 MinHitKeyphrase = 1 # Stats for keywords MaxNbOfKeywordsShown = 20 MinHitKeyword = 1 # Choose if you want the week report to start on sunday or monday # Possible values: # 0 - Week start on sunday # 1 - Week start on monday # Default: 1 # FirstDayOfWeek=1 # List of visible flags with link to other language translations. # See Lang parameter for list of allowed flag/language codes. # If you don't want any flag link, set ShowFlagLinks to "". # This parameter is used only if ShowHeader parameter is set to 1. # Possible values: "" or "language_codes_separated_by_space" # Default: "en es fr nl es" # ShowFlagLinks="en fr de nl es" # Each URL shown in stats report views are links you can click. # Possible values: 0 or 1 # Default: 1 # ShowLinksOnUrl=1 # Maximum length of URL shown on stats page (number of characters). This # affects only URL visible text, link still work. # Default: 72 # MaxLengthOfURL=72 # AWStats can include a link to WhoIs database on hostnames/ip. For this, you # must set ShowLinksToWhoIs to 1. Warning, a such feature depends on two next # parameters (LinksToWhoIs and LinksToIPWhoIs) and on WhoIs server # exhaustivity and availability. # For this reason, this feature can't be a reliable feature. # Possible values: 0 or 1 # Default: 0 # ShowLinksToWhoIs=0 # Set here the link used to point to Internet WhoIs database for hostnames. # This parameter is not used if ShowLinksToWhoIs is 0. # Default: "http://www.whois.net/search.cgi2?str=" # Example: "http://www.ripe.net/perl/whois?form_type=simple&searchtext=" # Example: "http://ws.arin.net/cgi-bin/whois.pl?queryinput=" # LinksToWhoIs="http://www.whois.net/search.cgi2?str=" # Set here the link used to point to Internet WhoIs database for ip addresses. # This parameter is not used if ShowLinksToWhoIs is 0. # Default: "http://ws.arin.net/cgi-bin/whois.pl?queryinput=" # Example: "http://ws.arin.net/cgi-bin/whois.pl?queryinput=" # LinksToIPWhoIs="http://ws.arin.net/cgi-bin/whois.pl?queryinput=" # You can enter HTML code that will be added at the top of AWStats reports. # Default: "" # HTMLHeadSection="" # You can enter HTML code that will be added at the end of AWStats reports. # Great to add advert ban. # Default: "" # HTMLEndSection="" # You can set Logo and LogoLink to use your own logo. # Logo must be the name of image file (must be in $DirIcons/other directory). # LogoLink is the expected URL when clicking on Logo. # Default: "awstats_logo1.png" # Logo="awstats_logo1.png" LogoLink="http://awstats.sourceforge.net" # Value of maximum bar width/height for horizontal/vertical graphics bar # Default: 260/180 # BarWidth = 260 BarHeight = 180 # You can ask AWStats to use a particular CSS (Cascading Style Sheet) to # change its look. # Example: "/css/awstats.css" # Default: "" # StyleSheet="" # Those colors parameters can be used (if StyleSheet parameter is not used) # to change AWStats look. # Example: color_name="RRGGBB" # RRGGBB is Red Green Blue components in Hex # color_Background="FFFFFF" # Background color for main page (Default = "FFFFFF") color_TableBGTitle="CCCCDD" # Background color for table title (Default = "CCCCDD") color_TableTitle="000000" # Table title font color (Default = "000000") color_TableBG="CCCCDD" # Background color for table (Default = "CCCCDD") color_TableRowTitle="FFFFFF" # Table row title font color (Default = "FFFFFF") color_TableBGRowTitle="ECECEC" # Background color for row title (Default = "ECECEC") color_TableBorder="ECECEC" # Table border color (Default = "ECECEC") color_text="000000" # Color of text (Default = "000000") color_textpercent="606060" # Color of text for percent values (Default = "606060") color_titletext="000000" # Color of text title within colored Title Rows (Default = "000000") color_weekend="EAEAEA" # Color for week-end days (Default = "EAEAEA") color_link="0011BB" # Color of HTML links (Default = "0011BB") color_hover="605040" # Color of HTML on-mouseover links (Default = "605040") color_u="FFB055" # Background color for number of unique visitors (Default = "FFB055") color_v="F8E880" # Background color for number of visites (Default = "F8E880") color_p="4477DD" # Background color for number of pages (Default = "4477DD") color_h="66F0FF" # Background color for number of hits (Default = "66F0FF") color_k="2EA495" # Background color for number of bytes (Default = "2EA495") color_s="8888DD" # Background color for number of search (Default = "8888DD") color_e="CEC2E8" # Background color for number of entry pages (Default = "CEC2E8") color_x="C1B2E2" # Background color for number of exit pages (Default = "C1B2E2") #----------------------------------------------------------------------------- # PLUGINS #----------------------------------------------------------------------------- # Add here all plugins file you want to load. # Plugin files must be .pm files stored in 'plugins' directory. # Uncomment LoadPlugin lines to enable a plugin after checking that perl # modules required by the plugin are installed. # # Plugin: Graph3D # Perl modules required: Graph3D # Some reported charts are nice 3D graphics. # #LoadPlugin="graph3d" # !!! NOT YET AVAILABLE !!! # Plugin: HashFiles # Perl modules required: Storable # AWStats data files as read/saved as native hash files. This increase # data file loading speed, above all for very large web sites. # #LoadPlugin="hashfiles" # Plugin: TimeHiRes # Perl modules required: Time::HiRes # Time reported by -showsteps option is in millisecond. For debug purpose. # #LoadPlugin="timehires" # Plugin: TimeZone # Perl modules required: Time::Local # Allow AWStats to correct a bad timezone for user of some IIS that use # GMT date in its log instead of local server time. # This module is useless for Apache and most IIS version. # This plugin reduces AWStats speed of 40% !!!!!!! # #LoadPlugin="timezone +2"