5 # Bulgarian_windows1251
30 # TAG: access_log file
31 # Where is the access.log file
34 #access_log /usr/local/squid/var/logs/access.log
37 # Use graphics where is possible.
38 # graph_days_bytes_bar_color blue|green|yellow|orange|brown|red
41 #graph_days_bytes_bar_color orange
44 # Especify the title for html page.
46 #title "Squid User Access Reports"
49 # Especify the font for html page.
51 #font_face Tahoma,Verdana,Arial
54 # Especify the header color
56 #header_color darkblue
59 # Especify the header bgcolor
61 #header_bgcolor blanchedalmond
64 # Especify the text font size
68 # TAG: header_font_size
69 # Especify the header font size
73 # TAG: title_font_size
74 # Especify the title font size
78 # TAG: background_color
79 # TAG: background_color
80 # Html page background color
82 # background_color white
85 # Html page text color
90 # Html page text background color
92 #text_bgcolor lavender
95 # Html page title color
105 # Html page logo text.
109 # TAG: logo_text_color
110 # Html page logo texti color.
112 #logo_text_color #000000
114 # TAG: logo_image_size
115 # Html page logo image size.
120 # TAG: background_image
121 # Html page background image
123 #background_image none
126 # User password file used by authentication
127 # If used here, reports will be generated only for that users.
132 # Temporary directory name for work files
138 # The reports will be saved in that directory
141 #output_dir /var/www/html/squid-reports
144 # Email address to send the reports. If you use this tag, no html reports will be generated.
149 # TAG: resolve_ip yes/no
150 # Convert ip address to dns name
154 # TAG: user_ip yes/no
155 # Use Ip Address instead userid in reports.
159 # TAG: topuser_sort_field field normal/reverse
160 # Sort field for the Topuser Report.
161 # Allowed fields: USER CONNECT BYTES TIME
163 #topuser_sort_field BYTES reverse
165 # TAG: user_sort_field field normal/reverse
166 # Sort field for the User Report.
167 # Allowed fields: SITE CONNECT BYTES TIME
169 #user_sort_field BYTES reverse
171 # TAG: exclude_users file
172 # users within the file will be excluded from reports.
173 # you can use indexonly to have only index.html file.
177 # TAG: exclude_hosts file
178 # Hosts, domains or subnets will be excluded from reports.
180 # Eg.: 192.168.10.10 - exclude ip address only
181 # 192.168.10.0 - exclude full C class
182 # s1.acme.foo - exclude hostname only
183 # acme.foo - exclude full domain name
187 # TAG: useragent_log file
188 # Put here where is useragent.log to nable useragent report.
193 # Date format in reports: e (European=dd/mm/yy), u (American=mm/dd/yy), w (Weekly=yy.ww)
197 # TAG: per_user_limit file MB
198 # Saves userid on file if download exceed n MB.
199 # This option allow you to disable user access if user exceed a download limit.
204 # How many reports files must be keept in reports directory.
205 # The oldest report file will be automatically removed.
210 # TAG: remove_temp_files yes
211 # Remove temporary files: geral, usuarios, top, periodo from root report directory.
213 #remove_temp_files yes
215 # TAG: index yes|no|only
216 # Generate the main index.html.
217 # only - generate only the main index.html
221 # TAG: overwrite_report yes|no
222 # yes - if report date already exist then will be overwrited.
223 # no - if report date already exist then will be renamed to filename.n, filename.n+1
227 # TAG: records_without_userid ignore|ip|everybody
228 # What can I do with records without user id (no authentication) in access.log file ?
230 # ignore - This record will be ignored.
231 # ip - Use ip address instead. (default)
232 # everybody - Use "everybody" instead.
234 #records_without_userid ip
236 # TAG: use_comma no|yes
237 # Use comma instead point in reports.
238 # Eg.: use_comma yes => 23,450,110
239 # use_comma no => 23.450.110
243 # TAG: mail_utility mail|mailx
244 # Mail command to use to send reports via SMTP
248 # TAG: topsites_num n
249 # How many sites in topsites report.
253 # TAG: topsites_sort_order CONNECT|BYTES A|D
254 # Sort for topsites report, where A=Ascendent, D=Descendent
256 #topsites_sort_order CONNECT D
258 # TAG: index_sort_order A/D
259 # Sort for index.html, where A=Ascendent, D=Descendent
263 # TAG: exclude_codes file
264 # Ignore records with these codes. Eg.: NONE/400
266 #exclude_codes /usr/local/sarg/exclude_codes
268 # TAG: replace_index string
269 # Replace "index.html" in the main index file with this string
270 # If null "index.html" is used
272 #replace_index <?php echo str_replace(".", "_", $REMOTE_ADDR); echo ".html"; ?>
274 # TAG: max_elapsed milliseconds
275 # If elapsed time is recorded in log is greater than max_elapsed use 0 for elapsed time.
276 # Use 0 for no checking
282 # TAG: report_type type
283 # What kind of reports to generate.
284 # topsites - shows the site, connect and bytes
285 # sites_users - shows which users were accessing a site
286 # users_sites - shows sites accessed by the user
287 # date_time - shows the amount of bytes used by day and hour
288 # denied - shows all denied sites with full URL
289 # auth_failures - shows autentication failures
290 # site_user_time_date - shows sites, dates, times and bytes
292 # Eg.: report_type topsites denied
294 #report_type topsites sites_users users_sites date_time denied auth_failures site_user_time_date
296 # TAG: usertab filename
297 # You can change the "userid" or the "ip address" to be a real user name on the reports.
299 # userid name or ip address name
301 # SirIsaac Isaac Newton
302 # vinci Leonardo da Vinci
303 # 192.168.10.1 Karol Wojtyla
305 # Each line must be terminated with '\n'
309 # TAG: long_url yes|no
310 # If yes, the full url is showed in report.
311 # If no, only the site will be showed
313 # YES option generate very big sort files and reports.
317 # TAG: date_time_by bytes|elap
318 # Date/Time reports will use bytes or elapsed time?
323 # ISO 8859 is a full series of 10 standardized multilingual single-byte coded (8bit)
324 # graphic character sets for writing in alphabetic languages
325 # You can use the following charsets:
326 # Latin1 - West European
327 # Latin2 - East European
328 # Latin3 - South European
329 # Latin4 - North European
341 # TAG: user_invalid_char "&/"
342 # Records that contain invalid characters in userid will be ignored by Sarg.
344 #user_invalid_char "&/"
346 # TAG: privacy yes|no
347 # privacy_string "***.***.***.***"
348 # privacy_string_color blue
349 # In some countries the sysadm cannot see the visited sites by a restrictive law.
350 # Using privacy yes the visited url will be changes by privacy_string and the link
351 # will be removed from reports.
354 #privacy_string "***.***.***.***"
355 #privacy_string_color blue
357 # TAG: include_users "user1:user2:...:usern"
358 # Reports will be generated only for listed users.
362 # TAG: exclude_string "string1:string2:...:stringn"
363 # Records from access.log file that contain one of listed strings will be ignored.
367 # TAG: show_successful_message yes|no
368 # Shows "Successful report generated on dir" at end of process.
370 #show_successful_message yes
372 # TAG: show_read_statistics yes|no
373 # Shows some reading statistics.
375 #show_read_statistics yes
377 # TAG: topuser_fields
378 # Which fields must be in Topuser report.
380 #topuser_fields NUM DATE_TIME USERID CONNECT BYTES %BYTES IN-CACHE-OUT USED_TIME MILISEC %TIME TOTAL AVERAGE
382 # TAG: user_report_fields
383 # Which fields must be in User report.
385 #user_report_fields CONNECT BYTES %BYTES IN-CACHE-OUT USED_TIME MILISEC %TIME TOTAL AVERAGE
388 # How many users in topsites report. 0 = no limit
392 # TAG: site_user_time_date_type list|table
393 # generate reports for site_user_time_date in list or table format
395 #site_user_time_date_type table
398 # Save the report results in a file to populate some database
403 # TAG: datafile_delimiter ";"
404 # ascii character to use as a field separator in datafile
406 #datafile_delimiter ";"
408 # TAG: datafile_fields all
409 # Which data fields must be in datafile
410 # user;date;time;url;connect;bytes;in_cache;out_cache;elapsed
412 #datafile_fields user;date;time;url;connect;bytes;in_cache;out_cache;elapsed
415 # The weekdays to take account ( Sunday->0, Saturday->6 )
422 # The hours to take account
424 #hours 7-12,14,16,18-20
428 # TAG: dansguardian_conf file
429 # DansGuardian.conf file path
430 # Generate reports from DansGuardian logs.
431 # Use 'none' to disable it.
432 # dansguardian_conf /usr/dansguardian/dansguardian.conf
434 #dansguardian_conf none
436 # TAG: squidguard_conf file
437 # path to squidGuard.conf file
438 # Generate reports from SquidGuard logs.
439 # Use 'none' to disable.
440 # squidguard_conf /usr/local/squidGuard/squidGuard.conf
442 #squidguard_conf none
444 # TAG: squidguard_log_format
445 # Format string SquidGuard logs.
446 # REJIK #year#-#mon#-#day# #hour# #list#:#tmp# #ip# #user# #tmp#/#tmp#/#url#/#end#
447 # SQUIDGUARD #year#-#mon#-#day# #hour# #tmp#/#list#/#tmp#/#tmp#/#url#/#tmp# #ip#/#tmp# #user# #end#
448 #squidguard_log_format #year#-#mon#-#day# #hour# #tmp#/#list#/#tmp#/#tmp#/#url#/#tmp# #ip#/#tmp# #user# #end#
450 # TAG: show_sarg_info yes|no
451 # shows sarg information and site path on each report bottom
455 # TAG: show_sarg_logo yes|no
460 # TAG: parsed_output_log directory
461 # Saves the processed log in a sarg format after parsing the squid log file.
462 # This is a way to dump all of the data structures out, after parsing from
463 # the logs (presumably this data will be much smaller than the log files themselves),
464 # and pull them back in for later processing and merging with data from previous logs.
466 #parsed_output_log none
468 # TAG parsed_output_log_compress /bin/gzip|/usr/bin/bzip2|nocompress
469 # sarg logs compress util
471 #parsed_output_log_compress /bin/gzip
473 # TAG displayed_values bytes|abbreviation
474 # how the values will be displayed in reports.
475 # eg. bytes - 209.526
476 # abbreviation - 210K
478 #displayed_values bytes
481 # TAG authfail_report_limit n
482 # TAG denied_report_limit n
483 # TAG siteusers_report_limit n
484 # TAG squidguard_report_limit n
485 # TAG user_report_limit n
486 # TAG dansguardian_report_limit n
487 # TAG download_report_limit n
488 # report limits (lines).
491 #authfail_report_limit 10
492 #denied_report_limit 10
493 #siteusers_report_limit 0
494 #squidguard_report_limit 10
495 #dansguardian_report_limit 10
496 #user_report_limit 10
497 #user_report_limit 50
499 # TAG www_document_root dir
500 # Where is your Web DocumentRoot
501 # Sarg will create sarg-php directory with some PHP modules:
502 # - sarg-squidguard-block.php - add urls from user reports to squidGuard DB
504 #www_document_root /var/www/html
506 # TAG block_it module_url
507 # This tag allow you to pass urls from user reports to a cgi or php module,
508 # to be blocked by some Squid acl
510 # Eg.: block_it /sarg-php/sarg-block-it.php
511 # sarg-block-it is a php that will append a url to a flat file.
512 # You must change /var/www/html/sarg-php/sarg-block-it to point to your file
513 # in $filename variable, and chown to a httpd owner.
515 # sarg will pass http://module_url?url=url
519 # TAG external_css_file path
520 # This tag allow internal sarg css override.
521 # Sarg use theses style classes:
523 # .info sarg information class, align=center
524 # .title title class, align=center
525 # .header header class, align:left
526 # .header2 header class, align:right
527 # .header3 header class, align:right
528 # .text text class, align:left
529 # .data table text class, align:right
530 # .data2 table text class, align:right, border colors
533 # There is a sample in /usr/local/sarg/etc/css.tpl
535 #external_css_file none
537 # TAG user_authentication yes|no
538 # Allow user authentication in User Reports using .htaccess
540 # AuthUserFile - where the user password file is
541 # AuthName - authentication realm. Eg "Members Only"
542 # AuthType - authenticaion type - basic
543 # Require - authorized users to see the report.
546 # user_authentication no
547 # AuthUserFile /usr/local/sarg/passwd
548 # AuthName "SARG, Restricted Access"
550 # Require user admin %u
552 # TAG download_suffix "suffix,suffix,...,suffix"
553 # file suffix to be considered as "download" in Download report.
554 # Use 'none' to disable.
556 #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"
559 # The maximum number of open file descriptors to avoid "Too many open files" error message.
560 # You need to run sarg as root to use ulimit tag.
564 # TAG: ntlm_user_format username|domainname+username
567 #ntlm_user_format domainname+username