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