sarg Wiki

output_dir DIRECTORY

The reports will be saved in that directory

www_document_root DIRECTORY

Where is your Web DocumentRoot. Sarg will create sarg-php directory with some PHP modules:
- sarg-squidguard-block.php - add urls from user reports to squidGuard DB
- sarg-realtime.php - displays
- sarg-block-it.php - add urls to text file. This file can be the list of urls to be blocked by squid

block_it module_url PATH

This tag allow you to pass urls from user reports to a cgi or php module, to be blocked by some Squid acl

Eg.: block_it /sarg-php/sarg-block-it.php

sarg-block-it is a php that will append a url to a flat file.

You must change /usr/local/squid/etc/block.txt to point to your file in $DefaultSquidBlock variable, and chown to a httpd owner.

Example:

http://proxy/sarg-php/sarg-block-it.php?url=http://freeonlinegames.com

realtime_refresh_time SECONDS

How many time to auto refresh the realtime report. 0 = disable.

Default is 3.

realtime_access_log_lines NUMBER

How many last lines to get from access.log file. Default is 1000.

realtime_types TEXT

Which records must be in realtime report. Default value is: GET,PUT,CONNECT,POST

realtime_unauthenticated_records ( ignore | show )

What to do with unauthenticated records in realtime report.

Default is show.

external_css_file PATH

Provide the path to an external css file to link into the HTML reports instead of the inline css written by sarg when this option is not set.

In versions prior to 2.3, this used to be an absolute file name to a file to include verbatim in each HTML page but, as it takes a lot of space, version 2.3 switched to a link to an external css file.

Therefore, this option must contain the HTTP server path on which a client browser may find the css file.

Sarg use theses style classes:

  .logo           logo class
  .info           sarg information class, align=center
  .title_c        title class, align=center
  .header_c       header class, align:center
  .header_l       header class, align:left
  .header_r       header class, align:right
  .text           text class, align:right
  .data           table text class, align:right
  .data2          table text class, align:left
  .data3          table text class, align:center
  .link           link class

Sarg can be instructed to output the internal css it inline into the reports with this command:

sarg --css

You can redirect the output to a file of your choice and edit it to your liking.

Default value is none.

user_authentication ( yes | no )
Allow user authentication in User Reports using .htaccess.

Default:
#user_authentication no

AuthUserTemplateFile FILE

AuthUserTemplateFile - The template to use to create the .htaccess file. In the template, %u is replaced by the user's ID for which the report is generated. The path of the template is relative to the directory containing sarg configuration file.

Default:
# AuthUserTemplateFile sarg_htaccess

See more detailed information at [htaccess configuration] page.

sorttable FILE

The path to a javascript script to dynamically sort the tables. The path is the link a browser must follow to find the script. For instance, it may be http://www.myproxy.org/sorttable.js or just /sorttable.js if the script is at the root of your web site.

If the path starts with "../" then it is assumed to be a relative path and sarg adds as many "../" as necessary to locate the js script from the output directory. Therefore, ../../sorttable.js links to the javascript one level above output_dir.

If this entry is set, each sortable table will have the "sortable" class set. You may have a look at http://www.kryogenix.org/code/browser/sorttable/ for the implementation on which sarg is based.

Default value is /sorttable.js