Where SquidAnalyzer should dump all HTML, data and images files. You should give a path that can be read by a Web browser.

The URL of the SquidAnalyzer javascript, HTML and images files. Default: /squidreport

This directive allow you to replace the SquidAnalyze logo by your custom logo. The default value is defined as follow:

        <a href="$self->{WebUrl}">
        <img src="$self->{WebUrl}images/logo-squidanalyzer.png" title="SquidAnalyzer $VERSION" border="0">
        </a> SquidAnalyzer

Feel free to define your own header but take care to not break current design. For example:

        CustomHeader   <a href="http://my.isp.dom/"><img src="http://my.isp.dom/logo.png" title="My ISP link" border="0" width="100" height="110"></a> My ISP Company
                                                                                           126,1         Bas

Set the path to the Squid log file. This can be a comma separated list of files to process several files at the same time. If the files comes from differents Squid servers, they will be merges in a single reports. You can also add to the list a SquidGuard log file, SquidAnalyzer will automatically detect the format.

If you want to use DNS name instead of client Ip address as username enable this directive. When you don't have authentication, the username is set to the client ip address, this allow you to use the DNS name instead. Note that you must have a working DNS resolution and that it can really slow down the generation of reports.

If you have enabled UseClientDNSName and have lot of ip addresses that do not resolve you may want to increase the DNS lookup timeout. By default SquidAnalyzer will stop to lookup a DNS name after 0.0001 second (100 ms).

Set path to the file containing network alias name. Network are show as Ip addresses so if you want to display name instead create a file with this format:

    LOCATION_NAME IP_NETWORK_ADDRESS

Separator must be a tabulation this allow the use of space character in the network alias name.

You can use regex to match and group some network addresses. See network-aliases file for examples.

Set path to the file containing user alias name. If you don't have auth_proxy enable users are seen as ip addresses. So if you want to show username or computer name instead, create a file with this format:

    FULL_USERNAME IP_ADDRESS

When 'UseClientDNSName' is ebabled you can replace ip address by a DNS name.

If you have auth_proxy enable but want to replace login name by full user name for example, create a file with this format:

    FULL_USERNAME LOGIN_NAME

Separator for both must be a tabulation this allow the use of space character in the user alias name.

You can use regex to match and group some user login or ip addresses. See user-aliases file for examples.

Set this to 1 if you want to anonymize all user login. The username will be replaced by an unique id that change at each squid-analyzer run. Default disable.

Used to set how SquidAnalyzer sort Network, User and User detailed Urls reports screen. Value can be: bytes, hits or duration. Default is bytes. Note that OrderUrl is limited to User detailed Urls reports and does not apply to Top Url and Top domain report where there is three reports each already ordered.

Used to set how SquidAnalyzer sort Mime types report screen Value can be: bytes or hits. Default is bytes.

Should SquidAnalyzer display user url details. This will show all URL read by user. Take care to have enougth space disk for large user. Default is 0, no url detail report.

Should SquidAnalyzer display user details. This will show statistics about user. Default is 1, show user detail report. Disable it to be able to remove any user related reports, statistics about URL and domains will remain.

Enable this directive if you don't want the tree Top URL and Domain tables. You will just have the table of Url/Domain ordered per hits then you can still sort the URL/Domain order by clicking on each column. This is useful when you have set a high value to TopNumber.

Run in quiet mode for batch processing or print debug information. Default is 0, verbose mode.

Used to set a cost of the bandwidth per Mb. If you want to generate invoice per Mb for bandwidth traffic this can help you. Value 0 mean no cost, this is the default value, the "Cost" column is not displayed

Used to set the currency of the bandwidth cost. Preferably the html special character. Default is €

Used to set the number of top url and second level domain to show. Default is top 100.

Top number of url to preserve on each data file sorted by OrderUrl. On huge access log it will improve a lot the performances but you will have less precision in the top url. Default to 0, all url will be stored.

Use this directive to show the top N users that look at an URL or a domain. Set it to 0 to disable this feature. Default is top 10.

Used to set client ip addresses, network addresses, auth login or uri to exclude from report.

You can define one by line exclusion by specifying first the type of the exclusion (USER, CLIENT or URI) and a space separated list of valid regex.

You can also use the NETWORK type to define network address with netmask using the CIDR notation: xxx.xxx.xxx.xxx/n

See example below:

        NETWORK        192.168.1.0/24 10.10.0.0/16
        CLIENT         192\.168\.1\.2 
        CLIENT         10\.169\.1\.\d+ 192\.168\.10\..*
        USER           myloginstr
        USER           guestlogin\d+ guestdemo
        URI            http:\/\/myinternetdomain.dom.*
        URI            .*\.webmail\.com\/.*\/login\.php.*

you can have multiple line of the same exclusion type.

Used to set client ip addresses, network addresses or auth login to include into the report. All others will not be included. It works as the opposite of the Include parameter.

You can define one by line inclusion by specifying first the type of the inclusion (USER or CLIENT) and a space separated list of valid regex.

You can also use the NETWORK type to define network address with netmask using the CIDR notation: xxx.xxx.xxx.xxx/n

See example below:

        NETWORK        192.168.1.0/24 10.10.0.0/16
        CLIENT         192\.168\.1\.2 
        CLIENT         10\.169\.1\.\d+ 192\.168\.10\..*
        USER           myloginstr
        USER           guestlogin\d+ guestdemo
        URI            http:\/\/myinternetdomain.dom.*
        URI            .*\.webmail\.com\/.*\/login\.php.*

you can have multiple line of the same inclusion type.

This directive allow exclusion of some unwanted methods in report statistics like HEAD, POST, CONNECT, etc. Can be a comma separated list of methods.

This directive allow exclusion of some unwanted mimetypes in report statistics like text/html, text/plain, or more generally text/*, etc. Can be a comma separated list of perl regular expression. Ex:

        ExcludedMimes   text/.*,image/.*

Used to set the translation file to be used. Value must be set to a file containing all string translated. See the lang directory for translation files. Default is defined internally in English.

This directive allow exclusion of some unwanted codes in report statistics like TCP_DENIED/403 which are generated when a user accesses a page the first time without authentication. Can be a comma separated list of methods. Default is none, all codes will be parsed.

Date format used to display date (year = %y, month = %m and day = %d) You can also use %M to replace month by its 3 letters abbreviation. Default: %y-%m-%d

Adds peer cache hit (CD_SIBLING_HIT) to be taken has local cache hit. Enabled by default, you must disabled it if you don't want to report peer cache hit onto your stats.

Allow one to change the default unit used to display transfert size. Default is BYTES, other possible values are KB, MB and GB.

Minimum percentage of data in pie's graphs to not be placed in the others item. Lower values will be summarized into the others item.

Set this to your locale to display generated date in your language. Default is to use the current locale of the system. If you want date in German for example, set it to de_DE.

        Rapport genere le mardi 11 decembre 2012, 15:13:09 (UTC+0100).

with a Locale set to fr_FR.

When SquidAnalyzer find a corrupted line in his data file, it exit immedialtly. You can force him to wait for a certain amount of errors before exiting. Of course you might want to remove the corrupted line before the next run. This can be useful if you have special characters in some fields like mime type.

Set timezone to use when SquidAnalyzer is used in a different server than the one running squid and there is a different timezone between these two machines. The value must follow format: +/-HH. Default is to use local time. For example:

        TimeZone        +01

for a log file generated on zone Europe/Paris with UTC+0100 and parsed on a computer with different timezone.

Enable this directive if you want to include port number into Url statistics. Default is to remove the port information from the Url.

Enable this directive if you want to apply immedialtly the changes made in aliases files to avoid duplicates. You still have to use --rebuild to recreate previous reports with new aliases. Enabling this will imply a lost of performances with huges log files.

These two configuration directive allow you to specify a start and stop time. Log line out of this time range will not be parsed. The format of the value is HH:MM