"Fossies" - the Fresh Open Source Software Archive

Member "sarg-2.4.0/sarg.conf" (24 Dec 2019, 32766 Bytes) of package /linux/privat/sarg-2.4.0.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) Generic config files source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "sarg.conf": 2.3.11_vs_2.4.0.

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