]> git.ipfire.org Git - thirdparty/sarg.git/blobdiff - sarg.conf
Add support to decompress xz files
[thirdparty/sarg.git] / sarg.conf
index 18c8eb58a0965bae018be473b030a74b71c93114..c579beafe0eca34df1e1d2dc07ecd9ab811da1f6 100644 (file)
--- a/sarg.conf
+++ b/sarg.conf
 #user_sort_field BYTES reverse
 
 # TAG:  exclude_users file
-#       users within the file will be excluded from reports.
-#       you can use indexonly to have only index.html file.
+#       Users within the file will be excluded from reports.
+#       Write one user per line. Lines beginning with # are ignored.
 #
 #exclude_users none
 
 #
 #       Wildcards are allowed (see access_log).
 #
+#       When this option is used the user_agent report is implicitly
+#       selected in report_type.
+#
 #useragent_log none
 
 # TAG:  date_format
 #       Use 'as_required' to create a per_user_limit file only if at least
 #       one user crosses the limit.
 #
-#per_user_limit_file_create purge
+#per_user_limit_file_create always
 
 # TAG: lastlog n
 #      How many reports files must be keept in reports directory.
 # TAG: report_type type
 #      What kind of reports to generate.
 #      topusers            - users, sites, times, bytes, connects, links to accessed sites, etc
-#      topsites                   - site, connect and bytes report
-#      sites_users        - users and sites report
-#      users_sites        - accessed sites by the user report
-#      date_time          - bytes used per day and hour report
-#      denied             - denied sites with full URL report
+#      topsites            - site, connect and bytes report
+#      sites_users         - users and sites report
+#      users_sites         - accessed sites by the user report
+#      date_time           - bytes used per day and hour report
+#      denied              - denied sites with full URL report
 #      auth_failures       - autentication failures report
 #      site_user_time_date - sites, dates, times and bytes report
 #      downloads           - downloads per user report
+#      user_agent          - user agent identification strings report (this report is always selected
+#                            if at least one file is provided with useragent option)
 #
 #      Eg.: report_type topsites denied
 #
-#report_type topusers topsites sites_users users_sites date_time denied auth_failures site_user_time_date downloads
+#report_type topusers topsites sites_users users_sites date_time denied auth_failures site_user_time_date downloads user_agent
 
 # TAG: usertab filename
 #      You can change the "userid" or the "ip address" to be a real user name on the reports.
 #siteusers_report_limit 0
 #squidguard_report_limit 10
 #dansguardian_report_limit 10
-#user_report_limit 10
-#user_report_limit 50
+#user_report_limit 0
+#download_report_limit 50
 
 # TAG: www_document_root dir
 #     Where is your Web DocumentRoot
 
 # TAG: hostalias
 #      The name of a text file containing the host names one per line and the
-#      optional alias to use in the report instead of that host name.
+#      optional alias to use in the report instead of that host name. If the
+#      alias is missing, the host name is replaced by the matching pattern
+#      (that is, including the wildcard). For instance, in the example below,
+#      any host matching *.gstatic.com is grouped, in the report, under the
+#      text "*.gstatic.com".
+#
 #      Host names may contain up to one wildcard denoted by a *. The wildcard
 #      must not end the host name.
+#
 #      The host name may be followed by an optional alias but if no alias is
 #      provided, the host name, including the wildcard, replaces any matching
 #      host name found in the log.
+#
 #      Host names replaced by identical aliases are grouped together in the
 #      reports.
+#
 #      IP addresses are supported and accept the CIDR notation both for IPv4 and
 #      IPv6 addresses.
+#
 #      Regular expressions can also be used if sarg was compiled with libpcre.
 #      A regular expression is formated as re:/regexp/ alias
 #      The regexp is a perl regular expression (see man perlre).
 #      Subpatterns are allowed in the alias. Sarg recognizes sed (\1) or perl ($1)
 #      subpatterns. Only 9 subpatterns are allowed in the replacement string.
+#      Regex are case sensitive by default. To have a case insensitive regex,
+#      defined it like this: re:/regexp/i alias
+#      The option "i" must be written with a lower case.
 #
 #      Example:
 #      *.gstatic.com
 #      *.mail.live.com
 #      65.52.00.00/14 *.mail.live.com
 #      re:/\.dropbox\.com(:443)?/ dropbox
-#      re:/([\w-]+)\.(\w*[a-zA-Z]\w*)(?::\d+)?$/\1.\2
+#      re:/([\w-]+)\.(\w*[a-zA-Z]\w*)(?::\d+)?$/ \1.\2
 #hostalias /usr/local/sarg/hostalias
 
 # TAG: useralias
 #      The name of a text file containing the user names one per line and the
 #      optional alias to use in the report instead of that user name.
-#      User names may contain wildcards denoted by a *.
-#      The user name may be followed by an optional alias but if no alias is
-#      provided, the user name, including the wildcard, replaces any matching
-#      user name found in the log.
-#      User names replaced by identical aliases are grouped together in the
-#      reports.
-#      IP addresses are supported and accept the CIDR notation both for IPv4 and
-#      IPv6 addresses.
-#      Regular expressions can also be used if sarg was compiled with libpcre.
-#      A regular expression is formated as re:/regexp/ alias
-#      The regexp is a perl regular expression (see man perlre).
-#      Subpatterns are allowed in the alias. Sarg recognizes sed (\1) or perl ($1)
-#      subpatterns. Only 9 subpatterns are allowed in the replacement string.
+#      See the description of hostalias. It uses the same file format as the
+#      useralias option.
+#
+#      Example:
+#      user454 John
+#      admin* Administrator
+#      re:/^(.*)@example.com$/i \1
 #useralias /usr/local/sarg/useralias
 
 # TAG: keep_temp_log yes|no