home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / sqmgr212.zip / README < prev    next >
Text File  |  2002-10-11  |  8KB  |  288 lines
  1. Sqmgrlog generate reports per user/ip/name from SQUID log file.
  2. The reports will be generated in HTML or email.
  3.  
  4. Support to SmartFilter added - 09/02/2000
  5.  
  6. Special thanks to:
  7. Matteo Colombo <matteo@calcol.it>             - Italian language
  8. Palamarchuk Eugen <eugen@cit.od.ukrtel.net>         - Russian language
  9. Csaba Kabai <ckabai@icnpharm.com>            - Hungarian language
  10. Evren Yurtesen <yurtesen@ispro.net.tr>              - Turkish language
  11. Andreas Piek <a.piesk@gmx.net>                - German language
  12. Fred Pacquier <fredp@dial.oleane.com>            - French language
  13. Leonardo A. D'Angelo <ldangelo@san-cayetano.com>    - Spanish language
  14. Seth Mos <stimpy@stimpy.multiweb.nl>            - Dutch language
  15. Milos Prudek <prudek@nembv.cz>                          - Czech language
  16. Dima I. Allaverdov <allav@ur.rags.ru>                   - Russian_windows1251 language
  17. V Gatut Harijiso <gatut@student.unpar.ac.id>        - Indonesian language
  18. Ivan Minchev <vanko@uni-svishtov.bg>            - Bulgarian_windows1251 language
  19. Akira Kitamura <click@anet.ne.jp>            - Japanese language
  20. Radovan Drobnjakovic <admin.rts@rts.co.yu>        - Serbian language
  21. Pieter Kooistra <pkooistra@hr.nl>            - Dutch language (fixed)
  22.  
  23. Translating
  24.    . Copy English.h to YourLanguage.h
  25.    . Translate YourLanguage.h
  26.    . Send YourLanguage.h to orso@onda.com.br
  27.  
  28.  
  29. If you use native squid log format, the spent time will be in reports (emulate_httpd_log off).
  30.  
  31. 1. run ./configure
  32.  
  33.    configure options: --enable-language=English, Bulgarian_windows1251, 
  34.                     Czech, Dutch, French, German, 
  35.                     Hungarian, Indonesian, Italian, 
  36.                     Japanese, Portuguese, Russian_Koi8, 
  37.                     Russian_windows1251, Serbian, Spanish, 
  38.                     Turkish
  39.                                 default: English
  40.  
  41.                       --enable-prefix=where the instalation dir is
  42.                                 default: /usr/local/bin
  43.  
  44.                       --without-gcc to use cc
  45.                                 default: gcc
  46.  
  47. 3. make
  48.  
  49. 4. make install
  50.  
  51. 5. Go to /usr/local/etc/sqmgrlog (or file entered with --prefix on configure)
  52.    and change sqmgrlog.conf as you need.
  53.  
  54. 6. Notes about sqmgrlog:
  55.  
  56.    Date/Time report:
  57.          Every minute that a request is logged your time is incremented by the smaller
  58.          of 1 minute or the total time for the requests.
  59.  
  60.  
  61. # sqmgrlog.conf
  62. #
  63.  
  64. # TAG:  access_log
  65. #       Where is the access.log file
  66. #       sqmgrlog -l file
  67. #
  68. #access_log /usr/local/squid/logs/access.log
  69. #access_log /var/log/squid/access.log # RedHat version
  70.  
  71. # TAG:    title
  72. #     Especify the title for html page.
  73. #
  74. #title "Squid User Access Reports"
  75.  
  76. # TAG:    font_face
  77. #     Especify the font for html page.
  78. #
  79. #font_face Arial
  80.  
  81. # TAG:    header_color
  82. #     Especify the header color
  83. #
  84. #header_color brown
  85.  
  86. # TAG:    header_bgcolor
  87. #     Especify the header bgcolor
  88. #
  89. #header_bgcolor blanchedalmond
  90.  
  91. # TAG:    font_size
  92. # TAG:    font_size
  93. #     Especify the font size
  94. #
  95. #header_font_size -1
  96.  
  97. # TAG:    background_color
  98. # TAG:    background_color
  99. #    Html page background color
  100. #
  101. #background_color white
  102.  
  103. # TAG:    text_color
  104. #    Html page text color
  105. #
  106. #text_color black
  107.  
  108. # TAG:    text_bgcolor
  109. #    Html page text background color
  110. #
  111. #text_bgcolor beige
  112.  
  113. # TAG:    title_color
  114. #    Html page title color
  115. #
  116. #title_color green
  117.  
  118. # TAG:    logo_image
  119. #    Html page logo.
  120. #
  121. #logo_image none
  122.  
  123. # TAG:    logo_text
  124. #    Html page logo text.
  125. #
  126. #logo_text ""
  127.  
  128. # TAG:    logo_text_color
  129. #    Html page logo texti color.
  130. #
  131. #logo_text_color black
  132.  
  133. # TAG:    logo_image_size
  134. #    Html page logo image size. 
  135. #       width height
  136. #
  137. #image_size 80 45
  138.  
  139. # TAG:    background_image
  140. #    Html page background image
  141. #
  142. #background_image none
  143.  
  144. # TAG:  password
  145. #       User password file used by authentication
  146. #       If you put here, reports will be generated only for users in.
  147. #
  148. #password none
  149.  
  150. # TAG:  temporary_dir
  151. #       Temporary directory name
  152. #       sqmgrlog -w dir
  153. #
  154. #temporary_dir /tmp
  155.  
  156. # TAG:  output_dir
  157. #       Where is the reports will ne stored.
  158. #       sqmgrlog -o dir
  159. #
  160. #output_dir /usr/local/etc/httpd/htdocs/squid-reports
  161. #output_dir /home/httpd/html/squid-reports # RedHat version
  162.  
  163. # TAG:  output_email
  164. #       Email address to send the reports
  165. #       sqmgrlog -e email
  166. #
  167. #output_email none
  168.  
  169. # TAG:  resolve_ip yes/no
  170. #       Convert ip address to dns name
  171. #       sqmgrlog -n
  172. #resolve_ip yes
  173.  
  174. # TAG:  user_ip yes/no
  175. #       Use Ip Address instead userid (reports)
  176. #       sqmgrlog -p
  177. #user_ip no
  178.  
  179. # TAG:  topuser_sort_field field normal/reverse
  180. #       Sort field for the Topuser Report.
  181. #       Allowed fields: USER CONNECT BYTES TIME
  182. #
  183. #topuser_sort_field BYTES reverse
  184.  
  185. # TAG:  user_sort_field field normal/reverse
  186. #       Sort field for the User Report.
  187. #       Allowed fields: SITE CONNECT BYTES TIME
  188. #
  189. #user_sort_field BYTES reverse
  190.  
  191. # TAG:  exclude_users file
  192. #       users within the file will be excluded from reports.
  193. #       you can use indexonly to have only index.html file.
  194. #
  195. #exclude_users none
  196.  
  197. # TAG:  exclude_hosts file
  198. #       Hosts, domains or subnets within the file will be excluded from reports. 
  199. #
  200. #       Eg.: 192.168.10.10 - exclude ip address only
  201. #            192.168.10.0  - exclude full C class
  202. #            s1.acme.foo   - exclude hostname only
  203. #            acme.foo      - exclude full domain name
  204. #
  205. #exclude_hosts none
  206.  
  207. # TAG:  useragent_log file
  208. #       Put here where is useragent.log to nable useragent report.
  209. #
  210. #useragent_log none
  211.  
  212. # TAG:  date_format
  213. #       Date format in reports: e (Europe=dd/mm/yy), u (USA=mm/dd/yy), w (Weekly=yy.ww)
  214. #date_format u
  215.  
  216. # TAG:  per_user_limit file MB
  217. #       Save userid on file if download exceed n MB.
  218. #       
  219. #       This option can be used to disable user access if user exceed a download limit.
  220. #per_user_limit none
  221.  
  222. # TAG: lastlog n
  223. #      How many reports files must be keept in reports directory.
  224. #      The oldest report file will be automatically removed.
  225. #      0 - no limit.
  226. #
  227. #lastlog 0
  228.  
  229. # TAG: remove_temp_files yes
  230. #      Remove temporary files: geral, usuarios, top, periodo from root report directory.
  231. #
  232. #remove_temp_files yes
  233.  
  234. # TAG: index yes|no|only
  235. #      Generate the main index.html.
  236. #      only - generate only the main index.html
  237. #
  238. #index yes
  239.  
  240. # TAG: overwrite_report yes|no
  241. #      yes - if report date already exist then will be overwrited.
  242. #       no - if report date already exist then will be renamed to filename.n, filename.n+1
  243. #
  244. #overwrite_report no
  245.  
  246. # TAG: records_without_userid ignore|ip|everybody
  247. #      What can I do with records without user id (no authentication) in access.log file ?
  248. #
  249. #      ignore - This record will be ignored.
  250. #          ip - Use ip address instead. (default)
  251. #   everybody - Use "everybody" instead.
  252. #
  253. #records_without_userid ip
  254.  
  255. # TAG: use_comma no|yes
  256. #      Use comma instead point in reports.
  257. #      Eg.: use_comma yes => 23,450,110
  258. #           use_comma no  => 23.450.110
  259. #
  260. #use_comma no
  261.  
  262. # TAG: mail_utility mail|mailx
  263. #      Mail command to use to send reports via SMTP
  264. #
  265. #mail_utility mailx
  266.  
  267. # TAG: topsites_num n
  268. #      How many sites in topsites report.
  269. #
  270. #topsites_num 100
  271.  
  272. # TAG: topsites_sort_order CONNECT|BYTES A|D
  273. #      Sort for topsites report, where A=Ascendent, D=Descendent
  274. #
  275. #topsites_sort_order CONNECT D
  276.  
  277. # TAG: exclude_codes file
  278. #      Ignore records with these codes. Eg.: NONE/400
  279. #
  280. #exclude_codes none
  281.  
  282.  
  283. Usage: sqmgrlog -h
  284.  
  285. Source: http://web.onda.com.br/orso/index.html
  286.  
  287. Any suggests and/or comments, plase: orso@onda.com.br
  288.