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