]> git.ipfire.org Git - thirdparty/sarg.git/blob - sarg.conf
Display the source of the message displayed on stderr
[thirdparty/sarg.git] / sarg.conf
1 # sarg.conf
2 #
3 # TAG: access_log file
4 # Where is the access.log file
5 #
6 # This option can be repeated up to 256 times to list rotated files or
7 # files from different sources.
8 #
9 # The files named here must exists or sarg aborts. It is intended as a
10 # safety against incomplete reporting due to problems occuring with the
11 # logs.
12 #
13 # If some files are passed on the command line with "sarg -l file" or
14 # "sarg file", the files listed here are ignored.
15 #
16 #access_log /usr/local/squid/var/logs/access.log
17
18 # TAG: graphs yes|no
19 # Use graphics where is possible.
20 # graph_days_bytes_bar_color blue|green|yellow|orange|brown|red
21 #
22 #graphs yes
23 #graph_days_bytes_bar_color orange
24
25 # TAG: graph_font
26 # The full path to the TTF font file to use to create the graphs. It is required
27 # if graphs is set to yes.
28 #
29 #graph_font /usr/share/fonts/truetype/ttf-dejavu/DejaVuSans.ttf
30
31 # TAG: title
32 # Especify the title for html page.
33 #
34 #title "Squid User Access Reports"
35
36 # TAG: font_face
37 # Especify the font for html page.
38 #
39 #font_face Tahoma,Verdana,Arial
40
41 # TAG: header_color
42 # Especify the header color
43 #
44 #header_color darkblue
45
46 # TAG: header_bgcolor
47 # Especify the header bgcolor
48 #
49 #header_bgcolor blanchedalmond
50
51 # TAG: font_size
52 # Especify the text font size
53 #
54 #font_size 9px
55
56 # TAG: header_font_size
57 # Especify the header font size
58 #
59 #header_font_size 9px
60
61 # TAG: title_font_size
62 # Especify the title font size
63 #
64 #title_font_size 11px
65
66 # TAG: background_color
67 # TAG: background_color
68 # Html page background color
69 #
70 # background_color white
71
72 # TAG: text_color
73 # Html page text color
74 #
75 #text_color #000000
76
77 # TAG: text_bgcolor
78 # Html page text background color
79 #
80 #text_bgcolor lavender
81
82 # TAG: title_color
83 # Html page title color
84 #
85 #title_color green
86
87 # TAG: logo_image
88 # Html page logo.
89 #
90 #logo_image none
91
92 # TAG: logo_text
93 # Html page logo text.
94 #
95 #logo_text ""
96
97 # TAG: logo_text_color
98 # Html page logo texti color.
99 #
100 #logo_text_color #000000
101
102 # TAG: logo_image_size
103 # Html page logo image size.
104 # width height
105 #
106 #image_size 80 45
107
108 # TAG: background_image
109 # Html page background image
110 #
111 #background_image none
112
113 # TAG: password
114 # User password file used by Squid authentication scheme
115 # If used, generate reports just for that users.
116 #
117 #password none
118
119 # TAG: temporary_dir
120 # Temporary directory name for work files
121 # sarg -w dir
122 #
123 #temporary_dir /tmp
124
125 # TAG: output_dir
126 # The reports will be saved in that directory
127 # sarg -o dir
128 #
129 #output_dir /var/www/html/squid-reports
130
131 # TAG: anonymous_output_files yes/no
132 # Use anonymous file and directory names in the report. If it is set to
133 # no (the default), the user id/ip/name is slightly mangled to create a
134 # suitable file name to store the report of the user but the user's
135 # identity can easily be guessed from the mangled name. If this option is
136 # set, any file or directory belonging to the user is replaced by a short
137 # number. The purpose is to hide the identity of the user when looking
138 # at the report file names but it may serve to shorten the path too.
139 #
140 #anonymous_output_files no
141
142 # TAG: output_email
143 # Email address to send the reports. If you use this tag, no html reports will be generated.
144 # sarg -e email
145 #
146 #output_email none
147
148 # TAG: resolve_ip modulelist
149 # List the modules to use to convert IP addresses into names.
150 # Each named module is tried in sequence until one returns a result. Therefore
151 # the order of the modules is relevant.
152 # The modules must be listed on one line each separated from the previous one with
153 # a space.
154 #
155 # The possible modules are
156 # dns Use the DNS.
157 # exec Call an external program with the IP address as argument.
158 #
159 # For compatibility with previous versions, yes is a synonymous for dns and
160 # no does nothing.
161 # sarg -n forces the use of the dns module.
162 #resolve_ip no
163
164 # TAG: resolve_ip_exec command
165 # If resolve_ip selects the exec module, this is the command to run to
166 # resolve an IP address. The command must contain a placeholder where the
167 # IP address is inserted. The placeholder must be %IP in uppercases. The
168 # placeholder may be repeated multiple times if necessary.
169 #
170 # The command is expected to return the host name without frills on its
171 # standard output. If the command returns nothing, it is assumed that the
172 # command could not resolve the IP address and the next module in the
173 # chain is given a try with the same address.
174 #
175 # This option can only be used once. Therefore there is only one command
176 # available to resolve an IP address but the program can do anything it
177 # deems fit including attempting several strategies.
178 #
179 # Beware that running an external program is exceedingly slow. So you
180 # should try the DNS first and only call an external program if the DNS
181 # fails.
182 #resolve_ip_exec nmblookup -A %IP | sed -n -e 's/^ *\(.*\) *<00> - *B.*/\1/p'
183
184 # TAG: user_ip yes/no
185 # Use Ip Address instead userid in reports.
186 # sarg -p
187 #user_ip no
188
189 # TAG: topuser_sort_field field normal/reverse
190 # Sort field for the Topuser Report.
191 # Allowed fields: USER CONNECT BYTES TIME
192 #
193 #topuser_sort_field BYTES reverse
194
195 # TAG: user_sort_field field normal/reverse
196 # Sort field for the User Report.
197 # Allowed fields: SITE CONNECT BYTES TIME
198 #
199 #user_sort_field BYTES reverse
200
201 # TAG: exclude_users file
202 # users within the file will be excluded from reports.
203 # you can use indexonly to have only index.html file.
204 #
205 #exclude_users none
206
207 # TAG: exclude_hosts file
208 # Hosts, domains or subnets will be excluded from reports.
209 #
210 # Eg.: 192.168.10.10 - exclude ip address only
211 # 192.168.10.0/24 - exclude full C class
212 # s1.acme.foo - exclude hostname only
213 # *.acme.foo - exclude full domain name
214 #
215 #exclude_hosts none
216
217 # TAG: useragent_log file
218 # useragent.log file patch to generate useragent report.
219 #
220 #useragent_log none
221
222 # TAG: date_format
223 # Date format in reports: e (European=dd/mm/yy), u (American=mm/dd/yy), w (Weekly=yy.ww)
224 #
225 #date_format u
226
227 # TAG: per_user_limit file MB ip/id
228 # Write the user's ID (if last flag is 'id') or the user's IP address (if last flag is 'ip')
229 # in file if download exceed n MB.
230 # This option allows you to disable user access if users exceed a download limit.
231 # The option may be repeated up to 16 times to generate several files with
232 # different content type or limit.
233 #
234 # Examples:
235 # per_user_limit userlimit_1G.txt 1000 ip
236 # per_user_limit /var/log/sarg/userlimit_500M.log 500 id
237 #
238 #per_user_limit none
239
240 # TAG: per_user_limit_file_create always/as_required
241 # When to create a per_user_limit file.
242 #
243 # Use 'always' to always create the file requested by per_user_limit
244 # even if it is empty.
245 #
246 # Use 'as_required' to create a per_user_limit file only if at least
247 # one user crosses the limit.
248 #
249 #per_user_limit_file_create purge
250
251 # TAG: lastlog n
252 # How many reports files must be keept in reports directory.
253 # The oldest report file will be automatically removed.
254 # 0 - no limit.
255 #
256 #lastlog 0
257
258 # TAG: remove_temp_files yes
259 # Remove temporary files: geral, usuarios, top, periodo from root report directory.
260 #
261 #remove_temp_files yes
262
263 # TAG: index yes|no|only
264 # Generate the main index.html.
265 # only - generate only the main index.html
266 #
267 #index yes
268
269 # TAG: index_tree date|file
270 # How to generate the index.
271 #
272 #index_tree file
273
274 # TAG: index_fields
275 # The columns to show in the index of the reports
276 # Columns are: dirsize
277 #
278 #index_fields dirsize
279
280 # TAG: overwrite_report yes|no
281 # yes - if report date already exist then will be overwrited.
282 # no - if report date already exist then will be renamed to filename.n, filename.n+1
283 #
284 #overwrite_report no
285
286 # TAG: records_without_userid ignore|ip|everybody
287 # What can I do with records without user id (no authentication) in access.log file ?
288 #
289 # ignore - This record will be ignored.
290 # ip - Use ip address instead. (default)
291 # everybody - Use "everybody" instead.
292 #
293 #records_without_userid ip
294
295 # TAG: use_comma no|yes
296 # Use comma instead point in reports.
297 # Eg.: use_comma yes => 23,450,110
298 # use_comma no => 23.450.110
299 #
300 #use_comma no
301
302 # TAG: mail_utility
303 # Mail command to use to send reports via SMTP. Sarg calls it like this:
304 # mail_utility -s "SARG report, date" "output_email" <"mail_content"
305 #
306 # Therefore, it is possible to add more arguments to the command by specifying them
307 # here.
308 #
309 # If you need too, you can use a shell script to process the content of /dev/stdin
310 # (/dev/stdin is the mail_content passed by sarg to the script) and call whatever
311 # command you like. It is not limited to mailing the report via SMTP.
312 #
313 # Don't forget to quote the command if necessary (i.e. if the path contains
314 # characters that must be quoted).
315 #
316 #mail_utility mailx
317
318 # TAG: topsites_num n
319 # How many sites in topsites report.
320 #
321 #topsites_num 100
322
323 # TAG: topsites_sort_order CONNECT|BYTES|TIME|USER A|D
324 # Sort for topsites report, where A=Ascendent, D=Descendent
325 #
326 #topsites_sort_order CONNECT D
327
328 # TAG: index_sort_order A/D
329 # Sort for index.html, where A=Ascendent, D=Descendent
330 #
331 #index_sort_order D
332
333 # TAG: exclude_codes file
334 # Ignore records with these codes. Eg.: NONE/400
335 # Write one code per line. Lines starting with a # are ignored.
336 # Only codes matching exactly one of the line is rejected. The
337 # comparison is not case sensitive.
338 #
339 #exclude_codes /usr/local/sarg/etc/exclude_codes
340
341 # TAG: replace_index string
342 # Replace "index.html" in the main index file with this string
343 # If null "index.html" is used
344 #
345 #replace_index <?php echo str_replace(".", "_", $REMOTE_ADDR); echo ".html"; ?>
346
347 # TAG: max_elapsed milliseconds
348 # If elapsed time is recorded in log is greater than max_elapsed use 0 for elapsed time.
349 # Use 0 for no checking
350 #
351 #max_elapsed 28800000
352 # 8 Hours
353
354 # TAG: report_type type
355 # What kind of reports to generate.
356 # topusers - users, sites, times, bytes, connects, links to accessed sites, etc
357 # topsites - site, connect and bytes report
358 # sites_users - users and sites report
359 # users_sites - accessed sites by the user report
360 # date_time - bytes used per day and hour report
361 # denied - denied sites with full URL report
362 # auth_failures - autentication failures report
363 # site_user_time_date - sites, dates, times and bytes report
364 # downloads - downloads per user report
365 #
366 # Eg.: report_type topsites denied
367 #
368 #report_type topusers topsites sites_users users_sites date_time denied auth_failures site_user_time_date downloads
369
370 # TAG: usertab filename
371 # You can change the "userid" or the "ip address" to be a real user name on the reports.
372 # If resolve_ip is active, the ip address is resolved before being looked up into this
373 # file. That is, if you want to map the ip address, be sure to set resolv_ip to no or
374 # the resolved name will be looked into the file instead of the ip address. Note that
375 # it can be used to resolve any ip address known to the dns and then map the unresolved
376 # ip addresses to a name found in the usertab file.
377 # Table syntax:
378 # userid name or ip address name
379 # Eg:
380 # SirIsaac Isaac Newton
381 # vinci Leonardo da Vinci
382 # 192.168.10.1 Karol Wojtyla
383 #
384 # Each line must be terminated with '\n'
385 # If usertab have value "ldap" (case ignoring), user names
386 # will be taken from LDAP server. This method as approaches for reception
387 # of usernames from Active Didectory
388 #
389 #usertab none
390
391 # TAG: LDAPHost hostname
392 # FQDN or IP address of host with LDAP service or AD DC
393 # default is '127.0.0.1'
394 #LDAPHost 127.0.0.1
395
396 # TAG: LDAPPort port
397 # LDAP service port number
398 # default is '389'
399 #LDAPPort 389
400
401 # TAG: LDAPBindDN CN=username,OU=group,DC=mydomain,DC=com
402 # DN of LDAP user, who is authorized to read user's names from LDAP base
403 # default is empty line
404 #LDAPBindDN cn=proxy,dc=mydomain,dc=local
405
406 # TAG: LDAPBindPW secret
407 # Password of DN, who is authorized to read user's names from LDAP base
408 # default is empty line
409 #LDAPBindPW secret
410
411 # TAG: LDAPBaseSearch OU=users,DC=mydomain,DC=com
412 # LDAP search base
413 # default is empty line
414 #LDAPBaseSearch ou=users,dc=mydomain,dc=local
415
416 # TAG: LDAPFilterSearch (uid=%s)
417 # User search filter by user's logins in LDAP
418 # First founded record will be used
419 # %s - will be changed to userlogins from access.log file
420 # filter string can have up to 5 '%s' tags
421 # default value is '(uid=%s)'
422 #LDAPFilterSearch (uid=%s)
423
424 # TAG: LDAPTargetAttr attributename
425 # Name of the attribute containing a name of the user
426 # default value is 'cn'
427 #LDAPTargetAttr cn
428
429 # TAG: LDAPNativeCharset charset-iconv-style
430 # Character set to convert the LDAP string to.
431 # For the list of some available charsets use: "iconv -l".
432 # This option requires libiconv and sarg must have been built with --with-iconv.
433 # default is empty line (UTF-8)
434 #LDAPNativeCharset ISO-8859-1
435
436 # TAG: long_url yes|no
437 # If yes, the full url is showed in report.
438 # If no, only the site will be showed
439 #
440 # YES option generate very big sort files and reports.
441 #
442 #long_url no
443
444 # TAG: date_time_by bytes|elap
445 # Date/Time reports show the downloaded volume or the elapsed time or both.
446 #
447 #date_time_by bytes
448
449 # TAG: charset name
450 # ISO 8859 is a full series of 10 standardized multilingual single-byte coded (8bit)
451 # graphic character sets for writing in alphabetic languages
452 # You can use the following charsets:
453 # Latin1 - West European
454 # Latin2 - East European
455 # Latin3 - South European
456 # Latin4 - North European
457 # Cyrillic
458 # Arabic
459 # Greek
460 # Hebrew
461 # Latin5 - Turkish
462 # Latin6
463 # Windows-1251
464 # Japan
465 # Koi8-r
466 # UTF-8
467 #
468 #charset Latin1
469
470 # TAG: user_invalid_char "&/"
471 # Records that contain invalid characters in userid will be ignored by Sarg.
472 #
473 #user_invalid_char "&/"
474
475 # TAG: privacy yes|no
476 # privacy_string "***.***.***.***"
477 # privacy_string_color blue
478 # In some countries the sysadm cannot see the visited sites by a restrictive law.
479 # Using privacy yes the visited url will be changes by privacy_string and the link
480 # will be removed from reports.
481 #
482 #privacy no
483 #privacy_string "***.***.***.***"
484 #privacy_string_color blue
485
486 # TAG: include_users "user1:user2:...:usern"
487 # Reports will be generated only for listed users.
488 #
489 #include_users none
490
491 # TAG: exclude_string "string1:string2:...:stringn"
492 # Records from access.log file that contain one of listed strings will be ignored.
493 #
494 #exclude_string none
495
496 # TAG: show_successful_message yes|no
497 # Shows "Successful report generated on dir" at end of process.
498 #
499 #show_successful_message yes
500
501 # TAG: show_read_statistics yes|no
502 # Shows how many lines have been read from the current input log file.
503 #
504 #show_read_statistics no
505
506 # TAG: show_read_percent yes|no
507 # Shows how many percents have been read from the current input log file.
508 #
509 # Beware that this feature requires to read the input log file once to
510 # count the number of lines and then a second time to actually parse it.
511 # You can save some time by disabling it.
512 #
513 #show_read_percent no
514
515 # TAG: topuser_fields
516 # Which fields must be in Topuser report.
517 #
518 # Valid columns are
519 # NUM Report line number.
520 # DATE_TIME Icons to display the date and time reports.
521 # USERID Display the user's ID. It may be a name or the IP address depending on other settings.
522 # USERIP Display the user's IP address.
523 # CONNECT Number of connections made by the user.
524 # BYTES Number of bytes downloaded by the user.
525 # %BYTES Percent of the total downloaded volume.
526 # IN-CACHE-OUT Percent of cache hit and miss.
527 # USED_TIME How long it took to process the requests from that user.
528 # MILISEC The same in milliseconds
529 # %TIME Percent of the total processing time of the reported users.
530 # TOTAL Add a line to the report with the total of every column.
531 # AVERAGE Add a line to the report with the average of every column.
532 #topuser_fields NUM DATE_TIME USERID CONNECT BYTES %BYTES IN-CACHE-OUT USED_TIME MILISEC %TIME TOTAL AVERAGE
533
534 # TAG: user_report_fields
535 # Which fields must be in User report.
536 #
537 #user_report_fields CONNECT BYTES %BYTES IN-CACHE-OUT USED_TIME MILISEC %TIME TOTAL AVERAGE
538
539 # TAG: bytes_in_sites_users_report yes|no
540 # Bytes field must be in Site & Users Report ?
541 #
542 #bytes_in_sites_users_report no
543
544 # TAG: topuser_num n
545 # How many users in topsites report. 0 = no limit
546 #
547 #topuser_num 0
548
549 # TAG: datafile file
550 # Save the report results in a file to populate some database
551 #
552 #datafile none
553
554 # TAG: datafile_delimiter ";"
555 # ascii character to use as a field separator in datafile
556 #
557 #datafile_delimiter ";"
558
559 # TAG: datafile_fields all
560 # Which data fields must be in datafile
561 # user;date;time;url;connect;bytes;in_cache;out_cache;elapsed
562 #
563 #datafile_fields user;date;time;url;connect;bytes;in_cache;out_cache;elapsed
564
565 # TAG: datafile_url ip|name
566 # Saves the URL as ip or name in datafile
567 #
568 #datafile_url ip
569
570 # TAG: weekdays
571 # The weekdays to take into account ( Sunday->0, Saturday->6 )
572 # Example:
573 #weekdays 1-3,5
574 # Default:
575 #weekdays 0-6
576
577 # TAG: hours
578 # The hours to take into account
579 # Example:
580 #hours 7-12,14,16,18-20
581 # Default:
582 #hours 0-23
583
584 # TAG: dansguardian_conf file
585 # DansGuardian.conf file path
586 # Generate reports from DansGuardian logs.
587 # Use 'none' to disable it.
588 # dansguardian_conf /usr/dansguardian/dansguardian.conf
589 #
590 #dansguardian_conf none
591
592 # TAG: dansguardian_filter_out_date on|off
593 # This option replaces dansguardian_ignore_date whose name was not appropriate with respect to its action.
594 # Note the change of parameter value compared with the old option.
595 # 'off' use the record even if its date is outside of the range found in the input log file.
596 # 'on' use the record only if its date is in the range found in the input log file.
597 #
598 #dansguardian_filter_out_date on
599
600 # TAG: squidguard_conf file
601 # path to squidGuard.conf file
602 # Generate reports from SquidGuard logs.
603 # Use 'none' to disable.
604 # You can use sarg -L filename to use an alternate squidGuard log.
605 # squidguard_conf /usr/local/squidGuard/squidGuard.conf
606 #
607 #squidguard_conf none
608
609 # TAG: redirector_log file
610 # the location of the web proxy redirector log such as one created by squidGuard or Rejik. The option
611 # may be repeated up to 64 times to read multiple files.
612 # If this option is specified, it takes precedence over squidguard_conf.
613 # The command line option -L override this option.
614 #
615 #redirector_log /usr/local/squidGuard/var/logs/urls.log
616
617 # TAG: redirector_filter_out_date on|off
618 # This option replaces squidguard_ignore_date and redirector_ignore_date whose names were not
619 # appropriate with respect to their action.
620 # Note the change of parameter value compared with the old options.
621 # 'off' use the record even if its date is outside of the range found in the input log file.
622 # 'on' use the record only if its date is in the range found in the input log file.
623 #
624 #redirector_filter_out_date on
625
626 # TAG: redirector_log_format
627 # Format string for web proxy redirector logs.
628 # This option was named squidguard_log_format before sarg 2.3.
629 # REJIK #year#-#mon#-#day# #hour# #list#:#tmp# #ip# #user# #tmp#/#tmp#/#url#/#end#
630 # SQUIDGUARD #year#-#mon#-#day# #hour# #tmp#/#list#/#tmp# #url# #ip#/#tmp# #user# #end#
631 #redirector_log_format #year#-#mon#-#day# #hour# #tmp#/#list#/#tmp# #url# #ip#/#tmp# #user# #end#
632
633 # TAG: show_sarg_info yes|no
634 # shows sarg information and site path on each report bottom
635 #
636 #show_sarg_info yes
637
638 # TAG: show_sarg_logo yes|no
639 # shows sarg logo
640 #
641 #show_sarg_logo yes
642
643 # TAG: parsed_output_log directory
644 # Saves the processed log in a sarg format after parsing the squid log file.
645 # This is a way to dump all of the data structures out, after parsing from
646 # the logs (presumably this data will be much smaller than the log files themselves),
647 # and pull them back in for later processing and merging with data from previous logs.
648 #
649 #parsed_output_log none
650
651 # TAG: parsed_output_log_compress /bin/gzip|/usr/bin/bzip2|nocompress
652 # Command to run to compress sarg parsed output log. It may contain
653 # options (such as -f to overwrite existing target file). The name of
654 # the file to compresse is provided at the end of this
655 # command line. Don't forget to quote things appropriately.
656 #
657 #parsed_output_log_compress /bin/gzip
658
659 # TAG: displayed_values bytes|abbreviation
660 # how the values will be displayed in reports.
661 # eg. bytes - 209.526
662 # abbreviation - 210K
663 #
664 #displayed_values bytes
665
666 # Report limits
667 # TAG: authfail_report_limit n
668 # TAG: denied_report_limit n
669 # TAG: siteusers_report_limit n
670 # TAG: squidguard_report_limit n
671 # TAG: user_report_limit n
672 # TAG: dansguardian_report_limit n
673 # TAG: download_report_limit n
674 # report limits (lines).
675 # '0' no limit
676 #
677 #authfail_report_limit 10
678 #denied_report_limit 10
679 #siteusers_report_limit 0
680 #squidguard_report_limit 10
681 #dansguardian_report_limit 10
682 #user_report_limit 10
683 #user_report_limit 50
684
685 # TAG: www_document_root dir
686 # Where is your Web DocumentRoot
687 # Sarg will create sarg-php directory with some PHP modules:
688 # - sarg-squidguard-block.php - add urls from user reports to squidGuard DB
689 #
690 #www_document_root /var/www/html
691
692 # TAG: block_it module_url
693 # This tag allow you to pass urls from user reports to a cgi or php module,
694 # to be blocked by some Squid acl
695 #
696 # Eg.: block_it /sarg-php/sarg-block-it.php
697 # sarg-block-it is a php that will append a url to a flat file.
698 # You must change /var/www/html/sarg-php/sarg-block-it to point to your file
699 # in $filename variable, and chown to a httpd owner.
700 #
701 # sarg will pass http://module_url?url=url
702 #
703 #block_it none
704
705 # TAG: external_css_file path
706 # Provide the path to an external css file to link into the HTML reports instead of
707 # the inline css written by sarg when this option is not set.
708 #
709 # In versions prior to 2.3, this used to be an absolute file name to
710 # a file to include verbatim in each HTML page but, as it takes a lot of
711 # space, version 2.3 switched to a link to an external css file.
712 # Therefore, this option must contain the HTTP server path on which a client
713 # browser may find the css file.
714 #
715 # Sarg use theses style classes:
716 # .logo logo class
717 # .info sarg information class, align=center
718 # .title_c title class, align=center
719 # .header_c header class, align:center
720 # .header_l header class, align:left
721 # .header_r header class, align:right
722 # .text text class, align:right
723 # .data table text class, align:right
724 # .data2 table text class, align:left
725 # .data3 table text class, align:center
726 # .link link class
727 #
728 # Sarg can be instructed to output the internal css it inline
729 # into the reports with this command:
730 #
731 # sarg --css
732 #
733 # You can redirect the output to a file of your choice and edit
734 # it to your liking.
735 #
736 #external_css_file none
737
738 # TAG: user_authentication yes|no
739 # Allow user authentication in User Reports using .htaccess
740 # Parameters:
741 # AuthUserTemplateFile - The template to use to create the
742 # .htaccess file. In the template, %u is replaced by the
743 # user's ID for which the report is generated. The path of the
744 # template is relative to the directory containing sarg
745 # configuration file.
746 #
747 # user_authentication no
748 # AuthUserTemplateFile sarg_htaccess
749
750 # TAG: download_suffix "suffix,suffix,...,suffix"
751 # file suffix to be considered as "download" in Download report.
752 # Use 'none' to disable.
753 #
754 #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"
755
756 # TAG: ulimit n
757 # The maximum number of open file descriptors to avoid "Too many open files" error message.
758 # You need to run sarg as root to use ulimit tag.
759 # If you run sarg with a low privilege user, set to 'none' to disable ulimit
760 #
761 #ulimit 20000
762
763 # TAG: ntlm_user_format user|domainname+username
764 # NTLM users format.
765 #
766 #ntlm_user_format domainname+username
767
768 # TAG: realtime_refresh_time num sec
769 # How many time to auto refresh the realtime report
770 # 0 = disable
771 #
772 # realtime_refresh_time 3
773
774 # TAG: realtime_access_log_lines num
775 # How many last lines to get from access.log file
776 #
777 # realtime_access_log_lines 1000
778
779 # TAG: realtime_types: GET,PUT,CONNECT,ICP_QUERY,POST
780 # Which records must be in realtime report.
781 #
782 # realtime_types GET,PUT,CONNECT,POST
783
784 # TAG: realtime_unauthenticated_records: ignore|show
785 # What to do with unauthenticated records in realtime report.
786 #
787 # realtime_unauthenticated_records: show
788
789 # TAG: byte_cost value no_cost_limit
790 # Cost per byte.
791 # Eg. byte_cost 0.01 100000000
792 # per byte cost = 0.01
793 # bytes with no cost = 100 Mb
794 # 0 = disable
795 #
796 # byte_cost 0.01 50000000
797
798 # TAG: squid24 on|off
799 # Compatilibity with squid version <= 2.4 when using emulate_http_log on
800 #
801 # squid24 off
802
803 # TAG: sorttable path
804 # The path to a javascript script to dynamically sort the tables.
805 # The path is the link a browser must follow to find the script. For instance,
806 # it may be http://www.myproxy.org/sorttable.js or just /sorttable.js if the script
807 # is at the root of your web site.
808 #
809 # If the path starts with "../" then it is assumed to be a relative
810 # path and sarg adds as many "../" as necessary to locate the js script from
811 # the output directory. Therefore, ../../sorttable.js links to the javascript
812 # one level above output_dir.
813 #
814 # If this entry is set, each sortable table will have the "sortable" class set.
815 # You may have a look at http://www.kryogenix.org/code/browser/sorttable/
816 # for the implementation on which sarg is based.
817 #
818 # sorttable /sorttable.js
819
820 # TAG: hostalias
821 # The name of a text file containing the host names one per line and the
822 # optional alias to use in the report instead of that host name.
823 # Host names may contain up to one wildcard denoted by a *. The wildcard
824 # must not end the host name.
825 # The host name may be followed by an optional alias but if no alias is
826 # provided, the host name, including the wildcard, replaces any matching
827 # host name found in the log.
828 # Host names replaced by identical aliases are grouped together in the
829 # reports.
830 # IP addresses are supported and accept the CIDR notation both for IPv4 and
831 # IPv6 addresses.
832 # Regular expressions can also be used if sarg was compiled with libpcre.
833 # A regular expression is formated as re:/regexp/ alias
834 # The regexp is a perl regular expression (see man perlre).
835 # Subpatterns are allowed in the alias. Sarg recognizes sed (\1) or perl ($1)
836 # subpatterns. Only 9 subpatterns are allowed in the replacement string.
837 #
838 # Example:
839 # *.gstatic.com
840 # mt*.google.com
841 # *.myphone.microsoft.com
842 # *.myphone.microsoft.com:443 *.myphone.microsoft.com:secure
843 # *.freeav.net antivirus:freeav
844 # *.mail.live.com
845 # 65.52.00.00/14 *.mail.live.com
846 # re:/\.dropbox\.com(:443)?/ dropbox
847 # re:/([\w-]+)\.(\w*[a-zA-Z]\w*)(?::\d+)?$/\1.\2
848 #hostalias /usr/local/sarg/hostalias
849
850 # TAG: useralias
851 # The name of a text file containing the user names one per line and the
852 # optional alias to use in the report instead of that user name.
853 # User names may contain wildcards denoted by a *.
854 # The user name may be followed by an optional alias but if no alias is
855 # provided, the user name, including the wildcard, replaces any matching
856 # user name found in the log.
857 # User names replaced by identical aliases are grouped together in the
858 # reports.
859 # IP addresses are supported and accept the CIDR notation both for IPv4 and
860 # IPv6 addresses.
861 # Regular expressions can also be used if sarg was compiled with libpcre.
862 # A regular expression is formated as re:/regexp/ alias
863 # The regexp is a perl regular expression (see man perlre).
864 # Subpatterns are allowed in the alias. Sarg recognizes sed (\1) or perl ($1)
865 # subpatterns. Only 9 subpatterns are allowed in the replacement string.
866 #useralias /usr/local/sarg/useralias
867
868 # TAG: keep_temp_log yes|no
869 # Keep temporary files created by sarg to produce its reports. The normal
870 # operation mode is to delete those files when they are not necessary any more.
871 #
872 # Never leave that option to "yes" for normal operation as temporary files
873 # left over by previous run can be included in subsequent reports.
874 #
875 # Use this option only to diagnose a problem with your reports. A better
876 # alternative is to run sarg from the command line with optino -k.
877 #keep_temp_log no
878
879 # TAG: max_successive_log_errors n
880 # Set the number of consecutive errors allowed in the input log file before
881 # the reading is aborted with an error.
882 #max_successive_log_errors 3
883
884 # TAG: max_total_log_errors n
885 # The reading of the input log file is interrupted if too many errors are found
886 # in the log file. This parameter set the number of errors before the reading
887 # is aborted. Set it to -1 to keep reading the logs irrespective of the
888 # errors found.
889 #
890 # Note that the max_successive_log_errors is still taken into account and
891 # cannot be disabled.
892 #max_total_log_errors 50