]> git.ipfire.org Git - thirdparty/sarg.git/blobdiff - sarg.conf
Imported Sarg 2.1.0
[thirdparty/sarg.git] / sarg.conf
index e56bee7d8608e9348efad4c95df600061281de8d..316a4ecdea3c090e0d047e13ca8d64c13bdd89b4 100644 (file)
--- a/sarg.conf
+++ b/sarg.conf
@@ -19,6 +19,7 @@
 #              Portuguese
 #              Romanian
 #              Russian_koi8
+#              Russian_UFT-8
 #              Russian_windows1251
 #              Serbian
 #              Slovak
 #background_image none
 
 # TAG:  password
-#       User password file used by authentication
-#       If used here, reports will be generated only for that users.
+#       User password file used by Squid authentication scheme
+#       If used, generate reports just for that users.
 #
 #password none
 
 #exclude_hosts none
 
 # TAG:  useragent_log file
-#       Put here where is useragent.log to nable useragent report.
+#       useragent.log file patch to generate useragent report.
 #
 #useragent_log none
 
 #
 #index yes
 
+# TAG: index_tree date|file
+#      How to generate the index.
+#
+#index_tree file
+
 # TAG: overwrite_report yes|no
 #      yes - if report date already exist then will be overwrited.
 #       no - if report date already exist then will be renamed to filename.n, filename.n+1
@@ -281,17 +287,19 @@ max_elapsed 28800000
 
 # TAG: report_type type
 #      What kind of reports to generate.
-#      topsites                   - shows the site, connect and bytes
-#      sites_users        - shows which users were accessing a site
-#      users_sites        - shows sites accessed by the user
-#      date_time          - shows the amount of bytes used by day and hour
-#      denied             - shows all denied sites with full URL
-#      auth_failures       - shows autentication failures
-#      site_user_time_date - shows sites, dates, times and bytes
+#      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
+#      auth_failures       - autentication failures report
+#      site_user_time_date - sites, dates, times and bytes report
+#      downloads           - downloads per user report
 #
 #      Eg.: report_type topsites denied 
 #
-#report_type topsites sites_users users_sites date_time denied auth_failures site_user_time_date
+#report_type topusers topsites sites_users users_sites date_time denied auth_failures site_user_time_date downloads
 
 # TAG: usertab filename
 #      You can change the "userid" or the "ip address" to be a real user name on the reports.
@@ -398,7 +406,6 @@ max_elapsed 28800000
 #      Save the report results in a file to populate some database
 #
 #datafile none
-#datafile /tmp/p8
 
 # TAG: datafile_delimiter ";"
 #      ascii character to use as a field separator in datafile
@@ -411,6 +418,11 @@ max_elapsed 28800000
 #
 #datafile_fields user;date;time;url;connect;bytes;in_cache;out_cache;elapsed
 
+# TAG: datafile_url ip|name
+#      Saves the URL as ip or name in datafile
+#
+#datafile ip
+
 # TAG: weekdays
 #      The weekdays to take account ( Sunday->0, Saturday->6 )
 # Example:
@@ -433,14 +445,27 @@ max_elapsed 28800000
 #
 #dansguardian_conf none
 
+# TAG: dansguardian_ignore_date on|off
+#      Use 'on'  use the record even the date range is different from the used squid access.log file.
+#      Use 'off' use the record only if the date range is in the used squid access.log file.
+#
+#dansguardian_ignore_date off
+
 # TAG: squidguard_conf file
 #      path to squidGuard.conf file
 #      Generate reports from SquidGuard logs.
 #      Use 'none' to disable.
+#      You can use sarg -L filename to use an alternate squidGuard log.
 #      squidguard_conf /usr/local/squidGuard/squidGuard.conf
 #
 #squidguard_conf none
 
+# TAG: squidguard_ignore_date on|off
+#      Use 'on'  use the record even the date range is different from the used squid access.log file.
+#      Use 'off' use the record only if the date range is in the used squid access.log file.
+#
+#squidguard_ignore_date off
+
 # TAG: squidguard_log_format
 #      Format string SquidGuard logs.
 #      REJIK       #year#-#mon#-#day# #hour# #list#:#tmp# #ip# #user# #tmp#/#tmp#/#url#/#end#
@@ -465,12 +490,12 @@ max_elapsed 28800000
 #
 #parsed_output_log none
 
-# TAG parsed_output_log_compress /bin/gzip|/usr/bin/bzip2|nocompress
+# TAG: parsed_output_log_compress /bin/gzip|/usr/bin/bzip2|nocompress
 #      sarg logs compress util
 #
 #parsed_output_log_compress /bin/gzip
 
-# TAG displayed_values bytes|abbreviation
+# TAG: displayed_values bytes|abbreviation
 #      how the values will be displayed in reports.
 #      eg. bytes       -  209.526
 #          abbreviation -  210K
@@ -478,13 +503,13 @@ max_elapsed 28800000
 #displayed_values bytes
 
 # Report limits
-# TAG authfail_report_limit n
-# TAG denied_report_limit n
-# TAG siteusers_report_limit n
-# TAG squidguard_report_limit n
-# TAG user_report_limit n
-# TAG dansguardian_report_limit n
-# TAG download_report_limit n
+# TAG: authfail_report_limit n
+# TAG: denied_report_limit n
+# TAG: siteusers_report_limit n
+# TAG: squidguard_report_limit n
+# TAG: user_report_limit n
+# TAG: dansguardian_report_limit n
+# TAG: download_report_limit n
 #      report limits (lines).
 #      '0' no limit
 #
@@ -496,14 +521,14 @@ max_elapsed 28800000
 #user_report_limit 10
 #user_report_limit 50
 
-# TAG www_document_root dir
+# TAG: www_document_root dir
 #     Where is your Web DocumentRoot
 #     Sarg will create sarg-php directory with some PHP modules:
 #     - sarg-squidguard-block.php - add urls from user reports to squidGuard DB
 #
 #www_document_root /var/www/html
 
-# TAG block_it module_url
+# TAG: block_it module_url
 #     This tag allow you to pass urls from user reports to a cgi or php module,
 #     to be blocked by some Squid acl
 #
@@ -516,7 +541,7 @@ max_elapsed 28800000
 #
 #block_it none
 
-# TAG external_css_file path
+# TAG: external_css_file path
 #     This tag allow internal sarg css override.
 #     Sarg use theses style classes:
 #      .body           body class
@@ -534,7 +559,7 @@ max_elapsed 28800000
 #
 #external_css_file none
 
-# TAG user_authentication yes|no
+# TAG: user_authentication yes|no
 #     Allow user authentication in User Reports using .htaccess
 #     Parameters:  
 #      AuthUserFile    - where the user password file is
@@ -549,19 +574,49 @@ max_elapsed 28800000
 # AuthType Basic
 # Require user admin %u
 
-# TAG download_suffix "suffix,suffix,...,suffix"
+# TAG: download_suffix "suffix,suffix,...,suffix"
 #    file suffix to be considered as "download" in Download report.
 #    Use 'none' to disable.    
 #
 #download_suffix "zip,arj,bzip,gz,ace,doc,iso,adt,bin,cab,com,dot,drv$,lha,lzh,mdb,mso,ppt,rtf,src,shs,sys,exe,dll,mp3,avi,mpg,mpeg"
 
-# ulimit n
+# TAG: ulimit n
 #    The maximum number of open file descriptors to avoid "Too many open files" error message.
 #    You need to run sarg as root to use ulimit tag.
 #
 #ulimit 20000
 
-# TAG:  ntlm_user_format username|domainname+username
-#       NTLM users format.
+# TAG: ntlm_user_format username|domainname+username
+#      NTLM users format.
 #
 #ntlm_user_format domainname+username
+
+# TAG: realtime_refresh_time num sec
+#      How many time to auto refresh the realtime report
+#      0 = disable
+#
+# realtime_refresh_time 3
+
+# TAG: realtime_access_log_lines num
+#      How many last lines to get from access.log file 
+#
+# realtime_access_log_lines 1000
+
+# TAG: realtime_types: GET,PUT,CONNECT,ICP_QUERY,POST
+#      Which records must be in realtime report.
+#
+# realtime_types GET,PUT,CONNECT  
+
+# TAG: realtime_unauthenticated_records: ignore|show
+#      What to do with unauthenticated records in realtime report.
+#
+# realtime_unauthenticated_records: ignore
+
+# TAG: byte_cost value no_cost_limit
+#      Cost per byte.
+#      Eg. byte_cost 0.01 100000000
+#           per byte cost      = 0.01
+#           bytes with no cost = 100 Mb
+#      0 = disable
+#
+# byte_cost 0.01 50000000