]> git.ipfire.org Git - thirdparty/sarg.git/blame - sarg.conf
Create multiple per_user_limit files
[thirdparty/sarg.git] / sarg.conf
CommitLineData
25697a35
GS
1# sarg.conf
2#
25697a35
GS
3# TAG: access_log file
4# Where is the access.log file
f74970b1
FM
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.
25697a35
GS
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
3becf85c
FM
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
25697a35
GS
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
129e6ea5 103# Html page logo image size.
25697a35
GS
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
491b862f
GS
114# User password file used by Squid authentication scheme
115# If used, generate reports just for that users.
25697a35
GS
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
829a53c2
FM
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
25697a35
GS
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
51b166d4
FM
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.
1e312c82 157# exec Call an external program with the IP address as argument.
51b166d4
FM
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.
25697a35
GS
162#resolve_ip no
163
1e312c82
FM
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
25697a35
GS
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#
43f18f45
FM
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
25697a35
GS
214#
215#exclude_hosts none
216
217# TAG: useragent_log file
491b862f 218# useragent.log file patch to generate useragent report.
25697a35
GS
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)
129e6ea5 224#
25697a35
GS
225#date_format u
226
2e29ae23
FM
227# TAG: per_user_limit file MB flag
228# Saves userid (if flag is 1) or userip (if flag is 0) in file if download exceed n MB.
25697a35 229# This option allow you to disable user access if user exceed a download limit.
2e29ae23
FM
230# The option may be repeated up to 16 times to generate several files with
231# different content type or limit.
129e6ea5 232#
25697a35
GS
233#per_user_limit none
234
235# TAG: lastlog n
236# How many reports files must be keept in reports directory.
237# The oldest report file will be automatically removed.
238# 0 - no limit.
239#
240#lastlog 0
241
242# TAG: remove_temp_files yes
243# Remove temporary files: geral, usuarios, top, periodo from root report directory.
244#
245#remove_temp_files yes
246
247# TAG: index yes|no|only
248# Generate the main index.html.
249# only - generate only the main index.html
250#
251#index yes
252
491b862f
GS
253# TAG: index_tree date|file
254# How to generate the index.
255#
256#index_tree file
257
9aaa3361
FM
258# TAG: index_fields
259# The columns to show in the index of the reports
260# Columns are: dirsize
261#
262#index_fields dirsize
263
25697a35
GS
264# TAG: overwrite_report yes|no
265# yes - if report date already exist then will be overwrited.
266# no - if report date already exist then will be renamed to filename.n, filename.n+1
267#
268#overwrite_report no
269
270# TAG: records_without_userid ignore|ip|everybody
271# What can I do with records without user id (no authentication) in access.log file ?
272#
273# ignore - This record will be ignored.
274# ip - Use ip address instead. (default)
275# everybody - Use "everybody" instead.
276#
277#records_without_userid ip
278
279# TAG: use_comma no|yes
280# Use comma instead point in reports.
281# Eg.: use_comma yes => 23,450,110
282# use_comma no => 23.450.110
283#
284#use_comma no
285
66d35350
FM
286# TAG: mail_utility
287# Mail command to use to send reports via SMTP. Sarg calls it like this:
288# mail_utility -s "SARG report, date" "output_email" <"mail_content"
289#
290# Therefore, it is possible to add more arguments to the command by specifying them
291# here.
292#
293# If you need too, you can use a shell script to process the content of /dev/stdin
294# (/dev/stdin is the mail_content passed by sarg to the script) and call whatever
295# command you like. It is not limited to mailing the report via SMTP.
296#
297# Don't forget to quote the command if necessary (i.e. if the path contains
298# characters that must be quoted).
25697a35
GS
299#
300#mail_utility mailx
301
302# TAG: topsites_num n
303# How many sites in topsites report.
304#
305#topsites_num 100
306
7d82ea1a 307# TAG: topsites_sort_order CONNECT|BYTES|TIME|USER A|D
25697a35
GS
308# Sort for topsites report, where A=Ascendent, D=Descendent
309#
310#topsites_sort_order CONNECT D
311
312# TAG: index_sort_order A/D
313# Sort for index.html, where A=Ascendent, D=Descendent
314#
315#index_sort_order D
316
317# TAG: exclude_codes file
318# Ignore records with these codes. Eg.: NONE/400
6cdbb02f
FM
319# Write one code per line. Lines starting with a # are ignored.
320# Only codes matching exactly one of the line is rejected. The
321# comparison is not case sensitive.
25697a35
GS
322#
323#exclude_codes /usr/local/sarg/exclude_codes
324
325# TAG: replace_index string
326# Replace "index.html" in the main index file with this string
129e6ea5 327# If null "index.html" is used
25697a35
GS
328#
329#replace_index <?php echo str_replace(".", "_", $REMOTE_ADDR); echo ".html"; ?>
330
331# TAG: max_elapsed milliseconds
332# If elapsed time is recorded in log is greater than max_elapsed use 0 for elapsed time.
129e6ea5 333# Use 0 for no checking
25697a35 334#
d6e703cc 335#max_elapsed 28800000
25697a35 336# 8 Hours
25697a35
GS
337
338# TAG: report_type type
339# What kind of reports to generate.
491b862f
GS
340# topusers - users, sites, times, bytes, connects, links to accessed sites, etc
341# topsites - site, connect and bytes report
342# sites_users - users and sites report
343# users_sites - accessed sites by the user report
344# date_time - bytes used per day and hour report
345# denied - denied sites with full URL report
346# auth_failures - autentication failures report
347# site_user_time_date - sites, dates, times and bytes report
348# downloads - downloads per user report
25697a35 349#
129e6ea5 350# Eg.: report_type topsites denied
25697a35 351#
491b862f 352#report_type topusers topsites sites_users users_sites date_time denied auth_failures site_user_time_date downloads
25697a35
GS
353
354# TAG: usertab filename
355# You can change the "userid" or the "ip address" to be a real user name on the reports.
d8a1e9f3
FM
356# If resolve_ip is active, the ip address is resolved before being looked up into this
357# file. That is, if you want to map the ip address, be sure to set resolv_ip to no or
358# the resolved name will be looked into the file instead of the ip address. Note that
359# it can be used to resolve any ip address known to the dns and then map the unresolved
360# ip addresses to a name found in the usertab file.
25697a35
GS
361# Table syntax:
362# userid name or ip address name
363# Eg:
364# SirIsaac Isaac Newton
365# vinci Leonardo da Vinci
366# 192.168.10.1 Karol Wojtyla
d8a1e9f3 367#
25697a35 368# Each line must be terminated with '\n'
e3af0ae9
PO
369# If usertab have value "ldap" (case ignoring), user names
370# will be taken from LDAP server. This method as approaches for reception
371# of usernames from Active Didectory
d8a1e9f3 372#
25697a35 373#usertab none
d8a1e9f3 374
e3af0ae9
PO
375# TAG: LDAPHost hostname
376# FQDN or IP address of host with LDAP service or AD DC
377# default is '127.0.0.1'
378#LDAPHost 127.0.0.1
379
380# TAG: LDAPPort port
381# LDAP service port number
382# default is '389'
383#LDAPPort 389
384
385# TAG: LDAPBindDN CN=username,OU=group,DC=mydomain,DC=com
386# DN of LDAP user, who is authorized to read user's names from LDAP base
387# default is empty line
388#LDAPBindDN cn=proxy,dc=mydomain,dc=local
389
390# TAG: LDAPBindPW secret
391# Password of DN, who is authorized to read user's names from LDAP base
392# default is empty line
393#LDAPBindPW secret
394
395# TAG: LDAPBaseSearch OU=users,DC=mydomain,DC=com
396# LDAP search base
397# default is empty line
398#LDAPBaseSearch ou=users,dc=mydomain,dc=local
399
1b048c43 400# TAG: LDAPFilterSearch (uid=%s)
e3af0ae9
PO
401# User search filter by user's logins in LDAP
402# First founded record will be used
403# %s - will be changed to userlogins from access.log file
1b048c43
FM
404# filter string can have up to 5 '%s' tags
405# default value is '(uid=%s)'
406#LDAPFilterSearch (uid=%s)
e3af0ae9
PO
407
408# TAG: LDAPTargetAttr attributename
409# Name of the attribute containing a name of the user
410# default value is 'cn'
411#LDAPTargetAttr cn
25697a35 412
fd75cd90
FM
413# TAG: LDAPNativeCharset charset-iconv-style
414# Character set to convert the LDAP string to.
415# For the list of some available charsets use: "iconv -l".
416# This option requires libiconv and sarg must have been built with --with-iconv.
417# default is empty line (UTF-8)
418#LDAPNativeCharset ISO-8859-1
419
25697a35
GS
420# TAG: long_url yes|no
421# If yes, the full url is showed in report.
422# If no, only the site will be showed
423#
424# YES option generate very big sort files and reports.
425#
426#long_url no
427
428# TAG: date_time_by bytes|elap
84c9679c 429# Date/Time reports show the downloaded volume or the elapsed time or both.
25697a35 430#
1752e8f8 431#date_time_by bytes
25697a35
GS
432
433# TAG: charset name
434# ISO 8859 is a full series of 10 standardized multilingual single-byte coded (8bit)
435# graphic character sets for writing in alphabetic languages
436# You can use the following charsets:
437# Latin1 - West European
129e6ea5
FM
438# Latin2 - East European
439# Latin3 - South European
440# Latin4 - North European
441# Cyrillic
442# Arabic
443# Greek
444# Hebrew
445# Latin5 - Turkish
25697a35
GS
446# Latin6
447# Windows-1251
d6e703cc 448# Japan
25697a35 449# Koi8-r
d6e703cc 450# UTF-8
25697a35
GS
451#
452#charset Latin1
453
454# TAG: user_invalid_char "&/"
455# Records that contain invalid characters in userid will be ignored by Sarg.
456#
457#user_invalid_char "&/"
458
459# TAG: privacy yes|no
460# privacy_string "***.***.***.***"
461# privacy_string_color blue
462# In some countries the sysadm cannot see the visited sites by a restrictive law.
463# Using privacy yes the visited url will be changes by privacy_string and the link
464# will be removed from reports.
465#
466#privacy no
467#privacy_string "***.***.***.***"
468#privacy_string_color blue
469
470# TAG: include_users "user1:user2:...:usern"
471# Reports will be generated only for listed users.
472#
473#include_users none
474
475# TAG: exclude_string "string1:string2:...:stringn"
476# Records from access.log file that contain one of listed strings will be ignored.
477#
478#exclude_string none
479
480# TAG: show_successful_message yes|no
481# Shows "Successful report generated on dir" at end of process.
482#
483#show_successful_message yes
484
485# TAG: show_read_statistics yes|no
2f4787e6 486# Shows how many lines have been read from the current input log file.
25697a35 487#
2f4787e6
FM
488#show_read_statistics no
489
490# TAG: show_read_percent yes|no
491# Shows how many percents have been read from the current input log file.
492#
493# Beware that this feature requires to read the input log file once to
494# count the number of lines and then a second time to actually parse it.
495# You can save some time by disabling it.
496#
497#show_read_percent no
25697a35
GS
498
499# TAG: topuser_fields
500# Which fields must be in Topuser report.
501#
502#topuser_fields NUM DATE_TIME USERID CONNECT BYTES %BYTES IN-CACHE-OUT USED_TIME MILISEC %TIME TOTAL AVERAGE
503
504# TAG: user_report_fields
505# Which fields must be in User report.
506#
507#user_report_fields CONNECT BYTES %BYTES IN-CACHE-OUT USED_TIME MILISEC %TIME TOTAL AVERAGE
508
d6e703cc
FM
509# TAG: bytes_in_sites_users_report yes|no
510# Bytes field must be in Site & Users Report ?
511#
512#bytes_in_sites_users_report no
513
25697a35
GS
514# TAG: topuser_num n
515# How many users in topsites report. 0 = no limit
516#
517#topuser_num 0
518
25697a35
GS
519# TAG: datafile file
520# Save the report results in a file to populate some database
521#
522#datafile none
25697a35
GS
523
524# TAG: datafile_delimiter ";"
525# ascii character to use as a field separator in datafile
526#
527#datafile_delimiter ";"
528
529# TAG: datafile_fields all
530# Which data fields must be in datafile
531# user;date;time;url;connect;bytes;in_cache;out_cache;elapsed
532#
533#datafile_fields user;date;time;url;connect;bytes;in_cache;out_cache;elapsed
534
491b862f
GS
535# TAG: datafile_url ip|name
536# Saves the URL as ip or name in datafile
537#
f84a35a3 538#datafile_url ip
491b862f 539
25697a35 540# TAG: weekdays
3bd75b91 541# The weekdays to take into account ( Sunday->0, Saturday->6 )
25697a35
GS
542# Example:
543#weekdays 1-3,5
544# Default:
545#weekdays 0-6
546
547# TAG: hours
3bd75b91 548# The hours to take into account
25697a35
GS
549# Example:
550#hours 7-12,14,16,18-20
551# Default:
552#hours 0-23
553
554# TAG: dansguardian_conf file
555# DansGuardian.conf file path
556# Generate reports from DansGuardian logs.
557# Use 'none' to disable it.
558# dansguardian_conf /usr/dansguardian/dansguardian.conf
559#
560#dansguardian_conf none
561
64dfb824
FM
562# TAG: dansguardian_filter_out_date on|off
563# This option replaces dansguardian_ignore_date whose name was not appropriate with respect to its action.
564# Note the change of parameter value compared with the old option.
565# 'off' use the record even if its date is outside of the range found in the input log file.
566# 'on' use the record only if its date is in the range found in the input log file.
491b862f 567#
64dfb824 568#dansguardian_filter_out_date on
491b862f 569
25697a35
GS
570# TAG: squidguard_conf file
571# path to squidGuard.conf file
572# Generate reports from SquidGuard logs.
573# Use 'none' to disable.
491b862f 574# You can use sarg -L filename to use an alternate squidGuard log.
25697a35
GS
575# squidguard_conf /usr/local/squidGuard/squidGuard.conf
576#
577#squidguard_conf none
578
1f482a8d
FM
579# TAG: redirector_log file
580# the location of the web proxy redirector log such as one created by squidGuard or Rejik. The option
581# may be repeated up to 64 times to read multiple files.
582# If this option is specified, it takes precedence over squidguard_conf.
583# The command line option -L override this option.
584#
585#redirector_log /usr/local/squidGuard/var/logs/urls.log
586
64dfb824
FM
587# TAG: redirector_filter_out_date on|off
588# This option replaces squidguard_ignore_date and redirector_ignore_date whose names were not
589# appropriate with respect to their action.
590# Note the change of parameter value compared with the old options.
591# 'off' use the record even if its date is outside of the range found in the input log file.
592# 'on' use the record only if its date is in the range found in the input log file.
491b862f 593#
64dfb824 594#redirector_filter_out_date on
491b862f 595
1f482a8d
FM
596# TAG: redirector_log_format
597# Format string for web proxy redirector logs.
598# This option was named squidguard_log_format before sarg 2.3.
25697a35 599# REJIK #year#-#mon#-#day# #hour# #list#:#tmp# #ip# #user# #tmp#/#tmp#/#url#/#end#
d19124ac
FM
600# SQUIDGUARD #year#-#mon#-#day# #hour# #tmp#/#list#/#tmp# #url# #ip#/#tmp# #user# #end#
601#redirector_log_format #year#-#mon#-#day# #hour# #tmp#/#list#/#tmp# #url# #ip#/#tmp# #user# #end#
25697a35
GS
602
603# TAG: show_sarg_info yes|no
604# shows sarg information and site path on each report bottom
605#
606#show_sarg_info yes
607
608# TAG: show_sarg_logo yes|no
609# shows sarg logo
610#
611#show_sarg_logo yes
612
613# TAG: parsed_output_log directory
614# Saves the processed log in a sarg format after parsing the squid log file.
129e6ea5 615# This is a way to dump all of the data structures out, after parsing from
25697a35
GS
616# the logs (presumably this data will be much smaller than the log files themselves),
617# and pull them back in for later processing and merging with data from previous logs.
618#
619#parsed_output_log none
620
491b862f 621# TAG: parsed_output_log_compress /bin/gzip|/usr/bin/bzip2|nocompress
ff8d5836
FM
622# Command to run to compress sarg parsed output log. It may contain
623# options (such as -f to overwrite existing target file). The name of
624# the file to compresse is provided at the end of this
625# command line. Don't forget to quote things appropriately.
25697a35
GS
626#
627#parsed_output_log_compress /bin/gzip
628
491b862f 629# TAG: displayed_values bytes|abbreviation
25697a35
GS
630# how the values will be displayed in reports.
631# eg. bytes - 209.526
632# abbreviation - 210K
633#
634#displayed_values bytes
635
636# Report limits
491b862f
GS
637# TAG: authfail_report_limit n
638# TAG: denied_report_limit n
639# TAG: siteusers_report_limit n
640# TAG: squidguard_report_limit n
641# TAG: user_report_limit n
642# TAG: dansguardian_report_limit n
643# TAG: download_report_limit n
25697a35
GS
644# report limits (lines).
645# '0' no limit
646#
647#authfail_report_limit 10
648#denied_report_limit 10
649#siteusers_report_limit 0
650#squidguard_report_limit 10
94ff9470
GS
651#dansguardian_report_limit 10
652#user_report_limit 10
653#user_report_limit 50
25697a35 654
491b862f 655# TAG: www_document_root dir
25697a35
GS
656# Where is your Web DocumentRoot
657# Sarg will create sarg-php directory with some PHP modules:
658# - sarg-squidguard-block.php - add urls from user reports to squidGuard DB
659#
660#www_document_root /var/www/html
661
491b862f 662# TAG: block_it module_url
25697a35
GS
663# This tag allow you to pass urls from user reports to a cgi or php module,
664# to be blocked by some Squid acl
665#
666# Eg.: block_it /sarg-php/sarg-block-it.php
667# sarg-block-it is a php that will append a url to a flat file.
668# You must change /var/www/html/sarg-php/sarg-block-it to point to your file
669# in $filename variable, and chown to a httpd owner.
670#
671# sarg will pass http://module_url?url=url
672#
673#block_it none
674
491b862f 675# TAG: external_css_file path
d183fb7f
FM
676# Provide the path to an external css file to link into the HTML reports instead of
677# the inline css written by sarg when this option is not set.
33dc7dec
FM
678#
679# In versions prior to 2.3, this used to be an absolute file name to
d183fb7f
FM
680# a file to include verbatim in each HTML page but, as it takes a lot of
681# space, version 2.3 switched to a link to an external css file.
682# Therefore, this option must contain the HTTP server path on which a client
683# browser may find the css file.
33dc7dec 684#
25697a35 685# Sarg use theses style classes:
3a422572 686# .logo logo class
25697a35 687# .info sarg information class, align=center
3a422572
FM
688# .title_c title class, align=center
689# .header_c header class, align:center
690# .header_l header class, align:left
691# .header_r header class, align:right
692# .text text class, align:right
25697a35 693# .data table text class, align:right
3a422572
FM
694# .data2 table text class, align:left
695# .data3 table text class, align:center
25697a35
GS
696# .link link class
697#
d183fb7f
FM
698# Sarg can be instructed to output the internal css it inline
699# into the reports with this command:
700#
701# sarg --css
702#
703# You can redirect the output to a file of your choice and edit
704# it to your liking.
25697a35
GS
705#
706#external_css_file none
707
491b862f 708# TAG: user_authentication yes|no
25697a35 709# Allow user authentication in User Reports using .htaccess
129e6ea5 710# Parameters:
d5d021c5
FM
711# AuthUserTemplateFile - The template to use to create the
712# .htaccess file. In the template, %u is replaced by the
713# user's ID for which the report is generated. The path of the
714# template is relative to the directory containing sarg
715# configuration file.
25697a35
GS
716#
717# user_authentication no
d5d021c5 718# AuthUserTemplateFile sarg_htaccess
25697a35 719
491b862f 720# TAG: download_suffix "suffix,suffix,...,suffix"
25697a35 721# file suffix to be considered as "download" in Download report.
129e6ea5 722# Use 'none' to disable.
25697a35 723#
94ff9470 724#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"
25697a35 725
491b862f 726# TAG: ulimit n
25697a35
GS
727# The maximum number of open file descriptors to avoid "Too many open files" error message.
728# You need to run sarg as root to use ulimit tag.
d6e703cc 729# If you run sarg with a low privilege user, set to 'none' to disable ulimit
25697a35
GS
730#
731#ulimit 20000
732
d3d1bf9c 733# TAG: ntlm_user_format user|domainname+username
491b862f 734# NTLM users format.
25697a35
GS
735#
736#ntlm_user_format domainname+username
491b862f
GS
737
738# TAG: realtime_refresh_time num sec
739# How many time to auto refresh the realtime report
740# 0 = disable
741#
742# realtime_refresh_time 3
743
744# TAG: realtime_access_log_lines num
129e6ea5 745# How many last lines to get from access.log file
491b862f
GS
746#
747# realtime_access_log_lines 1000
748
749# TAG: realtime_types: GET,PUT,CONNECT,ICP_QUERY,POST
750# Which records must be in realtime report.
751#
129e6ea5 752# realtime_types GET,PUT,CONNECT
491b862f
GS
753
754# TAG: realtime_unauthenticated_records: ignore|show
755# What to do with unauthenticated records in realtime report.
756#
d6e703cc 757# realtime_unauthenticated_records: show
491b862f
GS
758
759# TAG: byte_cost value no_cost_limit
760# Cost per byte.
761# Eg. byte_cost 0.01 100000000
762# per byte cost = 0.01
763# bytes with no cost = 100 Mb
764# 0 = disable
765#
766# byte_cost 0.01 50000000
d6e703cc
FM
767
768# TAG: squid24 on|off
769# Compatilibity with squid version <= 2.4 when using emulate_http_log on
770#
771# squid24 off
ea275279
FM
772
773# TAG: sorttable path
418cd63d
FM
774# The path to a javascript script to dynamically sort the tables.
775# The path is the link a browser must follow to find the script. For instance,
776# it may be http://www.myproxy.org/sorttable.js or just /sorttable.js if the script
777# is at the root of your web site.
2e96438d
FM
778#
779# If the path starts with "../" then it is assumed to be a relative
780# path and sarg adds as many "../" as necessary to locate the js script from
418cd63d 781# the output directory. Therefore, ../../sorttable.js links to the javascript
2e96438d
FM
782# one level above output_dir.
783#
ea275279
FM
784# If this entry is set, each sortable table will have the "sortable" class set.
785# You may have a look at http://www.kryogenix.org/code/browser/sorttable/
2e96438d 786# for the implementation on which sarg is based.
ea275279
FM
787#
788# sorttable /sorttable.js
22715352
FM
789
790# TAG: hostalias
791# The name of a text file containing the host names one per line and the
792# optional alias to use in the report instead of that host name.
793# Host names may contain up to one wildcard denoted by a *. The wildcard
794# must not end the host name.
795# The host name may be followed by an optional alias but if no alias is
796# provided, the host name, including the wildcard, replaces any matching
797# host name found in the log.
798# Host names replaced by identical aliases are grouped together in the
799# reports.
d0e9cc2c
FM
800# IP addresses are supported and accept the CIDR notation both for IPv4 and
801# IPv6 addresses.
6e24f222
FM
802# Regular expressions can also be used if sarg was compiled with libpcre.
803# A regular expression is formated as re:/regexp/ alias
a16cb22a
FM
804# The regexp is a perl regular expression (see man perlre).
805# Subpatterns are allowed in the alias. Sarg recognizes sed (\1) or perl ($1)
806# subpatterns. Only 9 subpatterns are allowed in the replacement string.
22715352
FM
807#
808# Example:
809# *.gstatic.com
810# mt*.google.com
811# *.myphone.microsoft.com
812# *.myphone.microsoft.com:443 *.myphone.microsoft.com:secure
813# *.freeav.net antivirus:freeav
814# *.mail.live.com
d0e9cc2c 815# 65.52.00.00/14 *.mail.live.com
6e24f222 816# re:/\.dropbox\.com(:443)?/ dropbox
a16cb22a 817# re:/([\w-]+)\.(\w*[a-zA-Z]\w*)(?::\d+)?$/\1.\2
22715352 818#hostalias /usr/local/sarg/hostalias
11767c6a 819
c4f0ea8f
FM
820# TAG: useralias
821# The name of a text file containing the user names one per line and the
822# optional alias to use in the report instead of that user name.
823# User names may contain wildcards denoted by a *.
824# The user name may be followed by an optional alias but if no alias is
825# provided, the user name, including the wildcard, replaces any matching
826# user name found in the log.
827# User names replaced by identical aliases are grouped together in the
828# reports.
829# IP addresses are supported and accept the CIDR notation both for IPv4 and
830# IPv6 addresses.
831# Regular expressions can also be used if sarg was compiled with libpcre.
832# A regular expression is formated as re:/regexp/ alias
833# The regexp is a perl regular expression (see man perlre).
834# Subpatterns are allowed in the alias. Sarg recognizes sed (\1) or perl ($1)
835# subpatterns. Only 9 subpatterns are allowed in the replacement string.
836#useralias /usr/local/sarg/useralias
837
11767c6a
FM
838# TAG: keep_temp_log yes|no
839# Keep temporary files created by sarg to produce its reports. The normal
840# operation mode is to delete those files when they are not necessary any more.
841#
842# Never leave that option to "yes" for normal operation as temporary files
843# left over by previous run can be included in subsequent reports.
844#
845# Use this option only to diagnose a problem with your reports. A better
846# alternative is to run sarg from the command line with optino -k.
847#keep_temp_log no
4d62cb0a
FM
848
849# TAG: max_successive_log_errors n
850# Set the number of consecutive errors allowed in the input log file before
851# the reading is aborted with an error.
852#max_successive_log_errors 3
853
854# TAG: max_total_log_errors n
855# The reading of the input log file is interrupted if too many errors are found
856# in the log file. This parameter set the number of errors before the reading
857# is aborted. Set it to -1 to keep reading the logs irrespective of the
858# errors found.
859#
860# Note that the max_successive_log_errors is still taken into account and
861# cannot be disabled.
862#max_total_log_errors 50