home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / sarg13p2.zip / doc / README < prev    next >
Text File  |  2003-01-06  |  11KB  |  426 lines
  1. Sarg is a Squid Analysis Report Generator that allow you to view "where" your users
  2. are going to on the Internet.
  3. Sarg generate reports in html, with many fields, like: users, IP Addresses, bytes, sites and times.
  4.  
  5. Support to SmartFilter added - 09/02/2000
  6.  
  7. Special thanks to:
  8. Matteo Colombo <matteo@calcol.it>             - Italian language
  9. Palamarchuk Eugen <eugen@cit.od.ukrtel.net>         - Russian language
  10. Csaba Kabai <ckabai@icnpharm.com>            - Hungarian language
  11. Evren Yurtesen <yurtesen@ispro.net.tr>              - Turkish language
  12. Andreas Piek <a.piesk@gmx.net>                - German language
  13. Fred Pacquier <fredp@dial.oleane.com>            - French language
  14. Leonardo A. D'Angelo <ldangelo@san-cayetano.com>    - Spanish language
  15. Seth Mos <stimpy@stimpy.multiweb.nl>            - Dutch language
  16. Milos Prudek <prudek@nembv.cz>                          - Czech language
  17. Dima I. Allaverdov <allav@ur.rags.ru>                   - Russian_windows1251 language
  18. V Gatut Harijiso <gatut@student.unpar.ac.id>        - Indonesian language
  19. Ivan Minchev <vanko@uni-svishtov.bg>            - Bulgarian_windows1251 language
  20. Akira Kitamura <click@anet.ne.jp>            - Japanese language
  21. Radovan Drobnjakovic <admin.rts@rts.co.yu>        - Serbian language
  22. Pieter Kooistra <pkooistra@hr.nl>            - Dutch language fix
  23. Andrew Okhmat <andy@crgu.com>                    - Russian Koi8 language fixed
  24. Nikolai V. Ivanyushin <koko@infocenter.bryansk.ru>    - Russian and Bulgarian language fix
  25. Juris Valdovskis <juris@auce.lv>            - Latvian language
  26. Jordan Kanev <dancho@globcom.net>            - Bulgarian language fix
  27. Wszebor Boksa <Wszebor_Boksa@koncept.pl>        - Polish language
  28. Adi Cretu <adi@usv.ro>                    - Romanian language
  29.  
  30. Translating
  31.    . Copy include/English to YourLanguage
  32.    . Translate YourLanguage
  33.    . Send YourLanguage to orso@brturbo.com to implement
  34.  
  35.  
  36. If you use native squid log format, the elapsed time will be in reports (emulate_httpd_log off).
  37.  
  38. 1. run ./configure
  39.  
  40.    configure options: --enable-bindir=where sarg binary will be saved
  41.                                 default: /usr/bin
  42.  
  43.                       --enable-sysconfdir - where the configuration directory is
  44.                                 default: /usr/local/sarg
  45.  
  46.                       --enable-mandir - where the sarg man page will be saved
  47.                                 default: /usr/local/man/man1
  48.  
  49.  
  50. 3. make
  51.  
  52. 4. make install
  53.  
  54. 5. Go to /usr/local/sarg (or file entered with --sysconfdir on configure)
  55.    and change sarg.conf as you need.
  56.  
  57. 6. Notes about sarg:
  58.  
  59.    Date/Time report:
  60.          Every minute that a request is logged your time is incremented by the smaller
  61.          of 1 minute or the total time for the requests.
  62.  
  63. Usage: sarg -h
  64.  
  65. Source: http://web.onda.com.br/orso/index.html
  66.  
  67. Any suggests and/or comments, plase: orso@brturbo.com
  68.  
  69.  
  70. # sarg.conf
  71. #
  72. # TAG:  language 
  73. #    Available languages:
  74. #        Bulgarian_windows1251
  75. #        Czech
  76. #        Dutch
  77. #        English
  78. #        French
  79. #        German
  80. #        Hungarian
  81. #        Indonesian
  82. #        Italian
  83. #        Japanese
  84. #        Latvian
  85. #        Polish
  86. #        Portuguese
  87. #        Romanian
  88. #        Russian_koi8
  89. #        Russian_windows1251
  90. #        Serbian
  91. #        Spanish
  92. #        Turkish
  93. #
  94. #language English
  95.  
  96. # TAG:  access_log file
  97. #       Where is the access.log file
  98. #       sarg -l file
  99. #
  100. #access_log /usr/local/squid/logs/access.log
  101. #access_log /var/log/squid/access.log # RedHat version
  102.  
  103. # TAG:    title
  104. #     Especify the title for html page.
  105. #
  106. #title "Squid User Access Reports"
  107.  
  108. # TAG:    font_face
  109. #     Especify the font for html page.
  110. #
  111. #font_face Arial
  112.  
  113. # TAG:    header_color
  114. #     Especify the header color
  115. #
  116. #header_color darkblue
  117.  
  118. # TAG:    header_bgcolor
  119. #     Especify the header bgcolor
  120. #
  121. #header_bgcolor blanchedalmond
  122.  
  123. # TAG:    font_size
  124. # TAG:    font_size
  125. #     Especify the font size
  126. #
  127. #header_font_size -1
  128.  
  129. # TAG:    background_color
  130. # TAG:    background_color
  131. #    Html page background color
  132. #
  133. #background_color white
  134.  
  135. # TAG:    text_color
  136. #    Html page text color
  137. #
  138. #text_color black
  139.  
  140. # TAG:    text_bgcolor
  141. #    Html page text background color
  142. #
  143. #text_bgcolor beige
  144.  
  145. # TAG:    title_color
  146. #    Html page title color
  147. #
  148. #title_color green
  149.  
  150. # TAG:    logo_image
  151. #    Html page logo.
  152. #
  153. #logo_image none
  154.  
  155. # TAG:    logo_text
  156. #    Html page logo text.
  157. #
  158. #logo_text ""
  159.  
  160. # TAG:    logo_text_color
  161. #    Html page logo texti color.
  162. #
  163. #logo_text_color black
  164.  
  165. # TAG:    logo_image_size
  166. #    Html page logo image size. 
  167. #       width height
  168. #
  169. #image_size 80 45
  170.  
  171. # TAG:    background_image
  172. #    Html page background image
  173. #
  174. #background_image none
  175.  
  176. # TAG:  password
  177. #       User password file used by authentication
  178. #       If you put here, reports will be generated only for users in.
  179. #
  180. #password none
  181.  
  182. # TAG:  temporary_dir
  183. #       Temporary directory name
  184. #       sarg -w dir
  185. #
  186. #temporary_dir /tmp
  187.  
  188. # TAG:  output_dir
  189. #       Where is the reports will ne stored.
  190. #       sarg -o dir
  191. #
  192. #output_dir /usr/local/etc/httpd/htdocs/squid-reports
  193. #output_dir /home/httpd/html/squid-reports # RedHat version
  194.  
  195. # TAG:  output_email
  196. #       Email address to send the reports
  197. #       sarg -e email
  198. #
  199. #output_email none
  200.  
  201. # TAG:  resolve_ip yes/no
  202. #       Convert ip address to dns name
  203. #       sarg -n
  204. #resolve_ip no
  205.  
  206. # TAG:  user_ip yes/no
  207. #       Use Ip Address instead userid (reports)
  208. #       sarg -p
  209. #user_ip no
  210.  
  211. # TAG:  topuser_sort_field field normal/reverse
  212. #       Sort field for the Topuser Report.
  213. #       Allowed fields: USER CONNECT BYTES TIME
  214. #
  215. #topuser_sort_field BYTES reverse
  216.  
  217. # TAG:  user_sort_field field normal/reverse
  218. #       Sort field for the User Report.
  219. #       Allowed fields: SITE CONNECT BYTES TIME
  220. #
  221. #user_sort_field BYTES reverse
  222.  
  223. # TAG:  exclude_users file
  224. #       users within the file will be excluded from reports.
  225. #       you can use indexonly to have only index.html file.
  226. #
  227. #exclude_users none
  228.  
  229. # TAG:  exclude_hosts file
  230. #       Hosts, domains or subnets will be excluded from reports.
  231. #
  232. #       Eg.: 192.168.10.10 - exclude ip address only
  233. #            192.168.10.0  - exclude full C class
  234. #            s1.acme.foo   - exclude hostname only
  235. #            acme.foo      - exclude full domain name
  236. #
  237. #exclude_hosts none
  238.  
  239. # TAG:  useragent_log file
  240. #       Put here where is useragent.log to nable useragent report.
  241. #
  242. #useragent_log none
  243.  
  244. # TAG:  date_format
  245. #       Date format in reports: e (Europe=dd/mm/yy), u (USA=mm/dd/yy), w (Weekly=yy.ww)
  246. #date_format u
  247.  
  248. # TAG:  per_user_limit file MB
  249. #       Save userid on file if download exceed n MB.
  250. #       
  251. #       This option can be used to disable user access if user exceed a download limit.
  252. #per_user_limit none
  253.  
  254. # TAG: lastlog n
  255. #      How many reports files must be keept in reports directory.
  256. #      The oldest report file will be automatically removed.
  257. #      0 - no limit.
  258. #
  259. #lastlog 0
  260.  
  261. # TAG: remove_temp_files yes
  262. #      Remove temporary files: geral, usuarios, top, periodo from root report directory.
  263. #
  264. #remove_temp_files yes
  265.  
  266. # TAG: index yes|no|only
  267. #      Generate the main index.html.
  268. #      only - generate only the main index.html
  269. #
  270. #index yes
  271.  
  272. # TAG: overwrite_report yes|no
  273. #      yes - if report date already exist then will be overwrited.
  274. #       no - if report date already exist then will be renamed to filename.n, filename.n+1
  275. #
  276. #overwrite_report no
  277.  
  278. # TAG: records_without_userid ignore|ip|everybody
  279. #      What can I do with records without user id (no authentication) in access.log file ?
  280. #
  281. #      ignore - This record will be ignored.
  282. #          ip - Use ip address instead. (default)
  283. #   everybody - Use "everybody" instead.
  284. #
  285. #records_without_userid ip
  286.  
  287. # TAG: use_comma no|yes
  288. #      Use comma instead point in reports.
  289. #      Eg.: use_comma yes => 23,450,110
  290. #           use_comma no  => 23.450.110
  291. #
  292. #use_comma no
  293.  
  294. # TAG: mail_utility mail|mailx
  295. #      Mail command to use to send reports via SMTP
  296. #
  297. #mail_utility mailx
  298.  
  299. # TAG: topsites_num n
  300. #      How many sites in topsites report.
  301. #
  302. #topsites_num 100
  303.  
  304. # TAG: topsites_sort_order CONNECT|BYTES A|D
  305. #      Sort for topsites report, where A=Ascendent, D=Descendent
  306. #
  307. #topsites_sort_order CONNECT D
  308.  
  309. # TAG: exclude_codes file
  310. #      Ignore records with these codes. Eg.: NONE/400
  311. #
  312. #exclude_codes /usr/local/sarg/exclude_codes
  313.  
  314. # TAG: replace_index string
  315. #      Replace "index.html" in the main index file with this string
  316. #      If null "index.html" is used 
  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.
  322. #      Use 0 for no checking 
  323. #
  324. #max_elapsed 0
  325. # 8 Hours
  326. max_elapsed 28800000
  327.  
  328. # TAG: report_type type
  329. #      What kind of reports to generate.
  330. #      topsites        - shows the site, connect and bytes
  331. #      sites_users    - shows which users were accessing a site
  332. #      users_sites    - shows sites accessed by the user
  333. #      date_time    - shows the amount of bytes used by day and hour
  334. #      denied        - show all denied sites with full URL
  335. #      auth_failures    - show autentication failures
  336. #
  337. #      Eg.: report_type topsites denied 
  338. #
  339. #report_type topsites users_sites sites_users date_time denied auth_failures site_user_time_date
  340.  
  341. # TAG: usertab filename
  342. #      You can change the "userid" or the "ip address" to be a real user name on the rpeorts.
  343. #      Table syntax:
  344. #         userid name   or   ip address name
  345. #      Eg:
  346. #        SirIsaac Isaac Newton
  347. #        vinci Leonardo da Vinci
  348. #        192.168.10.1 Karol Wojtyla
  349. #      
  350. #      Each line must be terminated with '\n'
  351. #
  352. #usertab none
  353.  
  354. # TAG: long_url yes|no
  355. #      If yes, the full url is showed in report.
  356. #      If no, only the site will be showed
  357. #
  358. #      YES option generate very big sort files and reports.
  359. #
  360. #long_url no
  361.  
  362. # TAG: date_time_by bytes|elap
  363. #      Date/Time reports will use bytes or elapsed time?
  364. #
  365. #date_time_by bytes
  366.  
  367. # TAG: charset name
  368. #      ISO 8859 is a full series of 10 standardized multilingual single-byte coded (8bit)
  369. #      graphic character sets for writing in alphabetic languages
  370. #      You can use the following charsets:
  371. #        Latin1         - West European
  372. #        Latin2         - East European 
  373. #        Latin3         - South European 
  374. #        Latin4         - North European 
  375. #        Cyrillic 
  376. #        Arabic 
  377. #        Greek 
  378. #        Hebrew 
  379. #        Latin5         - Turkish 
  380. #        Latin6
  381. #        Windows-1251
  382. #        Koi8-r
  383. #
  384. #charset Latin1
  385.  
  386. # TAG: user_invalid_char "&/"
  387. #      Records that contain invalid characters in userid will be ignored by Sarg.
  388. #
  389. #user_invalid_char "&/"
  390.  
  391. # TAG: privacy yes|no
  392. #      privacy_string "***.***.***.***"
  393. #      privacy_string_color blue
  394. #      In some countries the sysadm cannot see the visited sites by a restrictive law.
  395. #      Using privacy yes the visited url will be changes by privacy_string and the link
  396. #      will be removed from reports.
  397. #
  398. #privacy no
  399. #privacy_string "***.***.***.***"
  400. #privacy_string_color blue
  401.  
  402. # TAG: include_users "user1:user2:...:usern"
  403. #      Reports will be generated only for listed users.
  404. #
  405. #include_users none
  406.  
  407. # TAG: exclude_string "string1:string2:...:stringn"
  408. #      Records from access.log file that contain one of listed strings will be ignored.
  409. #
  410. #exclude_string none
  411.  
  412. # TAG: show_successful_message yes|no
  413. #      Show "Successful report generated on dir" at end of process.
  414. #
  415. # show_successful_message yes
  416.  
  417. # TAG: topuser_fields
  418. #      Which fields must be in Topuser report.
  419. #
  420. #topuser_fields NUM DATE_TIME USERID CONNECT BYTES %BYTES IN-CACHE-OUT USED_TIME MILISEC %TIME TOTAL AVERAGE
  421.  
  422. # TAG: topuser_num n
  423. #      How many users in topsites report. 0 = no limit
  424. #
  425. #topuser_num 0
  426.