5 # Bulgarian_windows1251
32 # TAG: access_log file
33 # Where is the access.log file
36 #access_log /usr/local/squid/var/logs/access.log
39 # Use graphics where is possible.
40 # graph_days_bytes_bar_color blue|green|yellow|orange|brown|red
43 #graph_days_bytes_bar_color orange
46 # Especify the title for html page.
48 #title "Squid User Access Reports"
51 # Especify the font for html page.
53 #font_face Tahoma,Verdana,Arial
56 # Especify the header color
58 #header_color darkblue
61 # Especify the header bgcolor
63 #header_bgcolor blanchedalmond
66 # Especify the text font size
70 # TAG: header_font_size
71 # Especify the header font size
75 # TAG: title_font_size
76 # Especify the title font size
80 # TAG: background_color
81 # TAG: background_color
82 # Html page background color
84 # background_color white
87 # Html page text color
92 # Html page text background color
94 #text_bgcolor lavender
97 # Html page title color
107 # Html page logo text.
111 # TAG: logo_text_color
112 # Html page logo texti color.
114 #logo_text_color #000000
116 # TAG: logo_image_size
117 # Html page logo image size.
122 # TAG: background_image
123 # Html page background image
125 #background_image none
128 # User password file used by Squid authentication scheme
129 # If used, generate reports just for that users.
134 # Temporary directory name for work files
140 # The reports will be saved in that directory
143 #output_dir /var/www/html/squid-reports
146 # Email address to send the reports. If you use this tag, no html reports will be generated.
151 # TAG: resolve_ip yes/no
152 # Convert ip address to dns name
156 # TAG: user_ip yes/no
157 # Use Ip Address instead userid in reports.
161 # TAG: topuser_sort_field field normal/reverse
162 # Sort field for the Topuser Report.
163 # Allowed fields: USER CONNECT BYTES TIME
165 #topuser_sort_field BYTES reverse
167 # TAG: user_sort_field field normal/reverse
168 # Sort field for the User Report.
169 # Allowed fields: SITE CONNECT BYTES TIME
171 #user_sort_field BYTES reverse
173 # TAG: exclude_users file
174 # users within the file will be excluded from reports.
175 # you can use indexonly to have only index.html file.
179 # TAG: exclude_hosts file
180 # Hosts, domains or subnets will be excluded from reports.
182 # Eg.: 192.168.10.10 - exclude ip address only
183 # 192.168.10.0/24 - exclude full C class
184 # s1.acme.foo - exclude hostname only
185 # *.acme.foo - exclude full domain name
189 # TAG: useragent_log file
190 # useragent.log file patch to generate useragent report.
195 # Date format in reports: e (European=dd/mm/yy), u (American=mm/dd/yy), w (Weekly=yy.ww)
199 # TAG: per_user_limit file MB
200 # Saves userid on file if download exceed n MB.
201 # This option allow you to disable user access if user exceed a download limit.
206 # How many reports files must be keept in reports directory.
207 # The oldest report file will be automatically removed.
212 # TAG: remove_temp_files yes
213 # Remove temporary files: geral, usuarios, top, periodo from root report directory.
215 #remove_temp_files yes
217 # TAG: index yes|no|only
218 # Generate the main index.html.
219 # only - generate only the main index.html
223 # TAG: index_tree date|file
224 # How to generate the index.
228 # TAG: overwrite_report yes|no
229 # yes - if report date already exist then will be overwrited.
230 # no - if report date already exist then will be renamed to filename.n, filename.n+1
234 # TAG: records_without_userid ignore|ip|everybody
235 # What can I do with records without user id (no authentication) in access.log file ?
237 # ignore - This record will be ignored.
238 # ip - Use ip address instead. (default)
239 # everybody - Use "everybody" instead.
241 #records_without_userid ip
243 # TAG: use_comma no|yes
244 # Use comma instead point in reports.
245 # Eg.: use_comma yes => 23,450,110
246 # use_comma no => 23.450.110
250 # TAG: mail_utility mail|mailx
251 # Mail command to use to send reports via SMTP
255 # TAG: topsites_num n
256 # How many sites in topsites report.
260 # TAG: topsites_sort_order CONNECT|BYTES A|D
261 # Sort for topsites report, where A=Ascendent, D=Descendent
263 #topsites_sort_order CONNECT D
265 # TAG: index_sort_order A/D
266 # Sort for index.html, where A=Ascendent, D=Descendent
270 # TAG: exclude_codes file
271 # Ignore records with these codes. Eg.: NONE/400
273 #exclude_codes /usr/local/sarg/exclude_codes
275 # TAG: replace_index string
276 # Replace "index.html" in the main index file with this string
277 # If null "index.html" is used
279 #replace_index <?php echo str_replace(".", "_", $REMOTE_ADDR); echo ".html"; ?>
281 # TAG: max_elapsed milliseconds
282 # If elapsed time is recorded in log is greater than max_elapsed use 0 for elapsed time.
283 # Use 0 for no checking
285 #max_elapsed 28800000
288 # TAG: report_type type
289 # What kind of reports to generate.
290 # topusers - users, sites, times, bytes, connects, links to accessed sites, etc
291 # topsites - site, connect and bytes report
292 # sites_users - users and sites report
293 # users_sites - accessed sites by the user report
294 # date_time - bytes used per day and hour report
295 # denied - denied sites with full URL report
296 # auth_failures - autentication failures report
297 # site_user_time_date - sites, dates, times and bytes report
298 # downloads - downloads per user report
300 # Eg.: report_type topsites denied
302 #report_type topusers topsites sites_users users_sites date_time denied auth_failures site_user_time_date downloads
304 # TAG: usertab filename
305 # You can change the "userid" or the "ip address" to be a real user name on the reports.
307 # userid name or ip address name
309 # SirIsaac Isaac Newton
310 # vinci Leonardo da Vinci
311 # 192.168.10.1 Karol Wojtyla
313 # Each line must be terminated with '\n'
317 # TAG: long_url yes|no
318 # If yes, the full url is showed in report.
319 # If no, only the site will be showed
321 # YES option generate very big sort files and reports.
325 # TAG: date_time_by bytes|elap
326 # Date/Time reports will use bytes or elapsed time?
331 # ISO 8859 is a full series of 10 standardized multilingual single-byte coded (8bit)
332 # graphic character sets for writing in alphabetic languages
333 # You can use the following charsets:
334 # Latin1 - West European
335 # Latin2 - East European
336 # Latin3 - South European
337 # Latin4 - North European
351 # TAG: user_invalid_char "&/"
352 # Records that contain invalid characters in userid will be ignored by Sarg.
354 #user_invalid_char "&/"
356 # TAG: privacy yes|no
357 # privacy_string "***.***.***.***"
358 # privacy_string_color blue
359 # In some countries the sysadm cannot see the visited sites by a restrictive law.
360 # Using privacy yes the visited url will be changes by privacy_string and the link
361 # will be removed from reports.
364 #privacy_string "***.***.***.***"
365 #privacy_string_color blue
367 # TAG: include_users "user1:user2:...:usern"
368 # Reports will be generated only for listed users.
372 # TAG: exclude_string "string1:string2:...:stringn"
373 # Records from access.log file that contain one of listed strings will be ignored.
377 # TAG: show_successful_message yes|no
378 # Shows "Successful report generated on dir" at end of process.
380 #show_successful_message yes
382 # TAG: show_read_statistics yes|no
383 # Shows some reading statistics.
385 #show_read_statistics yes
387 # TAG: topuser_fields
388 # Which fields must be in Topuser report.
390 #topuser_fields NUM DATE_TIME USERID CONNECT BYTES %BYTES IN-CACHE-OUT USED_TIME MILISEC %TIME TOTAL AVERAGE
392 # TAG: user_report_fields
393 # Which fields must be in User report.
395 #user_report_fields CONNECT BYTES %BYTES IN-CACHE-OUT USED_TIME MILISEC %TIME TOTAL AVERAGE
397 # TAG: bytes_in_sites_users_report yes|no
398 # Bytes field must be in Site & Users Report ?
400 #bytes_in_sites_users_report no
403 # How many users in topsites report. 0 = no limit
407 # TAG: site_user_time_date_type list|table
408 # generate reports for site_user_time_date in list or table format
410 #site_user_time_date_type table
413 # Save the report results in a file to populate some database
417 # TAG: datafile_delimiter ";"
418 # ascii character to use as a field separator in datafile
420 #datafile_delimiter ";"
422 # TAG: datafile_fields all
423 # Which data fields must be in datafile
424 # user;date;time;url;connect;bytes;in_cache;out_cache;elapsed
426 #datafile_fields user;date;time;url;connect;bytes;in_cache;out_cache;elapsed
428 # TAG: datafile_url ip|name
429 # Saves the URL as ip or name in datafile
434 # The weekdays to take account ( Sunday->0, Saturday->6 )
441 # The hours to take account
443 #hours 7-12,14,16,18-20
447 # TAG: dansguardian_conf file
448 # DansGuardian.conf file path
449 # Generate reports from DansGuardian logs.
450 # Use 'none' to disable it.
451 # dansguardian_conf /usr/dansguardian/dansguardian.conf
453 #dansguardian_conf none
455 # TAG: dansguardian_ignore_date on|off
456 # 'on' must use the record even the date range is different from the used in squid access.log file.
457 # 'off' must use the record only if the date range is in the irange used in squid access.log file.
459 #dansguardian_ignore_date off
461 # TAG: squidguard_conf file
462 # path to squidGuard.conf file
463 # Generate reports from SquidGuard logs.
464 # Use 'none' to disable.
465 # You can use sarg -L filename to use an alternate squidGuard log.
466 # squidguard_conf /usr/local/squidGuard/squidGuard.conf
468 #squidguard_conf none
470 # TAG: squidguard_ignore_date on|off
471 # Use 'on' use the record even the date range is different from the used squid access.log file.
472 # Use 'off' use the record only if the date range is in the used squid access.log file.
474 #squidguard_ignore_date off
476 # TAG: squidguard_log_format
477 # Format string SquidGuard logs.
478 # REJIK #year#-#mon#-#day# #hour# #list#:#tmp# #ip# #user# #tmp#/#tmp#/#url#/#end#
479 # SQUIDGUARD #year#-#mon#-#day# #hour# #tmp#/#list#/#tmp#/#tmp#/#url#/#tmp# #ip#/#tmp# #user# #end#
480 #squidguard_log_format #year#-#mon#-#day# #hour# #tmp#/#list#/#tmp#/#tmp#/#url#/#tmp# #ip#/#tmp# #user# #end#
482 # TAG: show_sarg_info yes|no
483 # shows sarg information and site path on each report bottom
487 # TAG: show_sarg_logo yes|no
492 # TAG: parsed_output_log directory
493 # Saves the processed log in a sarg format after parsing the squid log file.
494 # This is a way to dump all of the data structures out, after parsing from
495 # the logs (presumably this data will be much smaller than the log files themselves),
496 # and pull them back in for later processing and merging with data from previous logs.
498 #parsed_output_log none
500 # TAG: parsed_output_log_compress /bin/gzip|/usr/bin/bzip2|nocompress
501 # Command to run to compress sarg parsed output log. It may contain
502 # options (such as -f to overwrite existing target file). The name of
503 # the file to compresse is provided at the end of this
504 # command line. Don't forget to quote things appropriately.
506 #parsed_output_log_compress /bin/gzip
508 # TAG: displayed_values bytes|abbreviation
509 # how the values will be displayed in reports.
510 # eg. bytes - 209.526
511 # abbreviation - 210K
513 #displayed_values bytes
516 # TAG: authfail_report_limit n
517 # TAG: denied_report_limit n
518 # TAG: siteusers_report_limit n
519 # TAG: squidguard_report_limit n
520 # TAG: user_report_limit n
521 # TAG: dansguardian_report_limit n
522 # TAG: download_report_limit n
523 # report limits (lines).
526 #authfail_report_limit 10
527 #denied_report_limit 10
528 #siteusers_report_limit 0
529 #squidguard_report_limit 10
530 #dansguardian_report_limit 10
531 #user_report_limit 10
532 #user_report_limit 50
534 # TAG: www_document_root dir
535 # Where is your Web DocumentRoot
536 # Sarg will create sarg-php directory with some PHP modules:
537 # - sarg-squidguard-block.php - add urls from user reports to squidGuard DB
539 #www_document_root /var/www/html
541 # TAG: block_it module_url
542 # This tag allow you to pass urls from user reports to a cgi or php module,
543 # to be blocked by some Squid acl
545 # Eg.: block_it /sarg-php/sarg-block-it.php
546 # sarg-block-it is a php that will append a url to a flat file.
547 # You must change /var/www/html/sarg-php/sarg-block-it to point to your file
548 # in $filename variable, and chown to a httpd owner.
550 # sarg will pass http://module_url?url=url
554 # TAG: external_css_file path
555 # This tag allow internal sarg css override.
556 # Sarg use theses style classes:
558 # .info sarg information class, align=center
559 # .title title class, align=center
560 # .header header class, align:left
561 # .header2 header class, align:right
562 # .header3 header class, align:right
563 # .text text class, align:left
564 # .data table text class, align:right
565 # .data2 table text class, align:right, border colors
568 # There is a sample in /usr/local/sarg/etc/css.tpl
570 #external_css_file none
572 # TAG: user_authentication yes|no
573 # Allow user authentication in User Reports using .htaccess
575 # AuthUserFile - where the user password file is
576 # AuthName - authentication realm. Eg "Members Only"
577 # AuthType - authenticaion type - basic
578 # Require - authorized users to see the report.
581 # user_authentication no
582 # AuthUserFile /usr/local/sarg/passwd
583 # AuthName "SARG, Restricted Access"
585 # Require user admin %u
587 # TAG: download_suffix "suffix,suffix,...,suffix"
588 # file suffix to be considered as "download" in Download report.
589 # Use 'none' to disable.
591 #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"
594 # The maximum number of open file descriptors to avoid "Too many open files" error message.
595 # You need to run sarg as root to use ulimit tag.
596 # If you run sarg with a low privilege user, set to 'none' to disable ulimit
600 # TAG: ntlm_user_format username|domainname+username
603 #ntlm_user_format domainname+username
605 # TAG: realtime_refresh_time num sec
606 # How many time to auto refresh the realtime report
609 # realtime_refresh_time 3
611 # TAG: realtime_access_log_lines num
612 # How many last lines to get from access.log file
614 # realtime_access_log_lines 1000
616 # TAG: realtime_types: GET,PUT,CONNECT,ICP_QUERY,POST
617 # Which records must be in realtime report.
619 # realtime_types GET,PUT,CONNECT
621 # TAG: realtime_unauthenticated_records: ignore|show
622 # What to do with unauthenticated records in realtime report.
624 # realtime_unauthenticated_records: show
626 # TAG: byte_cost value no_cost_limit
628 # Eg. byte_cost 0.01 100000000
629 # per byte cost = 0.01
630 # bytes with no cost = 100 Mb
633 # byte_cost 0.01 50000000
635 # TAG: squid24 on|off
636 # Compatilibity with squid version <= 2.4 when using emulate_http_log on