README

   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 generates reports in html, with many fields, like: users, IP Addresses, bytes, sites and times.
   4
   5 Source: http://sourceforge.net/projects/sarg/
   6
   7
   8 Installation
   9 ------------
  10
  11 1. run ./configure
  12
  13    Useful configure options:
  14      --prefix - The root directory of the installation
  15                default: /usr/local
  16
  17      --bindir - where sarg binary will be saved
  18                default: /usr/local/bin
  19
  20      --sysconfdir - where the configuration directory is
  21                default: /usr/local/etc
  22
  23      --mandir - where the sarg man page will be saved
  24                default: /usr/local/share/man
  25
  26      --enable-sargphp - where to install sarg-php (--disable-sargphp don't install sarg-php)
  27                default: /var/www/html
  28
  29      --enable-fontdir - where to find the fonts for the reports (--diable-fontdir don't install the fonts)
  30                default: /usr/local/share/sarg/fonts
  31
  32      --enable-imagedir - where sarg take the images to include in the reports
  33                default: /usr/local/share/sarg/images
  34
  35      --enable-extraprotection - compile sarg with extra GCC options for increased security
  36                default: use standard compilation warnings and no protection
  37
  38    For a complete list of all the options, run ./configure --help.
  39
  40 3. make
  41
  42 4. make install
  43
  44 5. Go to /usr/local/sarg (or file entered with --sysconfdir on configure)
  45    and change sarg.conf as you need.
  46
  47 6. Notes about sarg:
  48
  49    Date/Time report:
  50          Every minute that a request is logged your time is incremented by the smaller
  51          of 1 minute or the total time for the requests.
  52
  53 Usage: sarg -h
  54
  55
  56 Translations
  57 ------------
  58
  59 As of March 14th, 2010 (sarg 2.3), the translations have been ported to gettext. This makes it easier
  60 to translate all the messages (the number of translated messages went from 144 to 448). Therefore, the
  61 old language files are obsolete. The old translated message have been converted automatically to
  62 gettext but due to the changes made to the strings in the program after the automatic conversion,
  63 it is likely that the old messages are, at best, meaningless.
  64
  65 Translations are handled at http://translationproject.org/domain/sarg.html. If your language is
  66 not yet supported or the current translation is obsolete, please check with the team working
  67 on your language at the Translation Project to be sure nobody is assigned to sarg. If necessary,
  68 contact the coordinator of that team to join the team and be assigned to sarg.
  69
  70 If no po file exists for you language, download the latest sarg.pot on this page
  71 http://translationproject.org/domain/sarg.html and rename it as YourLanguageCode.po. See
  72 http://www.gnu.org/software/gettext/manual/gettext.html#Language-Codes for the list of the
  73 valid languages codes.
  74
  75 Translate YourLanguageCode.po (see http://www.gnu.org/software/gettext/manual/gettext.html for more informations).
  76
  77 Submit the translated po file to robot@translationproject.org. You must be a member of the team
  78 working on the language for which you are submitting the po file or the robot will reject
  79 your file. It is not necessary to fill the disclaimer to translate sarg.
  80
  81
  82 Special thanks to:
  83 Matteo Colombo <matteo@calcol.it>                       - Italian language
  84 Palamarchuk Eugen <eugen@cit.od.ukrtel.net>             - Russian language
  85 Csaba Kabai <ckabai@icnpharm.com>                       - Hungarian language
  86 Evren Yurtesen <yurtesen@ispro.net.tr>                  - Turkish language
  87 Andreas Piek <a.piesk@gmx.net>                          - German language
  88 Fred Pacquier <fredp@dial.oleane.com>                   - French language
  89 Leonardo A. D'Angelo <ldangelo@san-cayetano.com>        - Spanish language
  90 Seth Mos <stimpy@stimpy.multiweb.nl>                    - Dutch language
  91 Milos Prudek <prudek@nembv.cz>                          - Czech language
  92 Dima I. Allaverdov <allav@ur.rags.ru>                   - Russian_windows1251 language
  93 V Gatut Harijiso <gatut@student.unpar.ac.id>            - Indonesian language
  94 Ivan Minchev <vanko@uni-svishtov.bg>                    - Bulgarian_windows1251 language
  95 Akira Kitamura <click@anet.ne.jp>                       - Japanese language
  96 Radovan Drobnjakovic <admin.rts@rts.co.yu>              - Serbian language
  97 Pieter Kooistra <pkooistra@hr.nl>                       - Dutch language fix
  98 Andrew Okhmat <andy@crgu.com>                           - Russian Koi8 language fixed
  99 Nikolai V. Ivanyushin <koko@infocenter.bryansk.ru>      - Russian and Bulgarian language fix
 100 Juris Valdovskis <juris@auce.lv>                        - Latvian language
 101 Jordan Kanev <dancho@globcom.net>                       - Bulgarian language fix
 102 Wszebor Boksa <Wszebor_Boksa@koncept.pl>                - Polish language
 103 Adi Cretu <adi@usv.ro>                                  - Romanian language
 104 Roman Vynar <rvynar@icqmail.com>                        - Ukrainian_windows1251 language
 105 Andreu Sanchez <tanis@lleida.com>                       - Catalan language
 106 Antonis Maglaras <vegos@magla.gr>                       - Greek language
 107 Dusan Woletz <Dusan.WOLETZ@orange.sk>                   - Slovak Language
 108 Jose Luis Hernandez <jhdz@simbiotica.net>               - Spanish language fix
 109 Theo kastermans <t.kastermans@zandvoort.nl>             - Dutch language fix
 110 Alex Deiter <tiamat@komi.mts.ru>                        - Russian UTF-8 language
 111 Josef Karliak <karliak@ajetaci.cz>                      - Czech UTF-8
 112 Igor Ageikin <iageikin@lipen.elektra.ru>                - Russian UTF-8 fix
 113
 114
 115 Suggestions or remarks
 116 ----------------------
 117
 118 Any suggests or comments may be posted on the forum
 119 http://sourceforge.net/projects/sarg/forums/forum/363374 or sent to Frederic Marchal
 120 (fmarchal@users.sourceforge.net)