
scr_ipfm (C) Copyright 2003 Krzysztof Gibas <sdas (at) gibas org>
                                - current maintainer
                       2001 Gonthar <gonthar (at) moon net pl>
                                - developed scr_ipfm-0.1


1. Co to jest scr_ipfm?
    a) zalety
    b) pobieranie
2. Instalacja ipfm
3. Instalacja scr_ipfm
4. Konfiguracja
5. Tworzenie wasnych tematw

1. Co to jest scr_ipfm?

scr_ipfm jest skryptem napisanym w php, suy do graficznego przedstawiania 
iloci ciganych danych przez uytkownikw sieci lokalnej na podstawie
logw wygenerowanych przez program ipfm (ipfm dostpny jest pod adresem: 
http://robert.cheramy.net/ipfm/) w formie strony internetowej.

Strona domowa projektu znajduje si na http://scripfm.sf.net/

scr_ipfm testowane byo na serwerze z:
    - systemem linux
    - apache - zarwno 1.3.x jak i 2.0.x
    - php-4.3.x oraz php-5.0.x
	- dla bezpieczesta zalecam wczy opcj safe_mode oraz ustawi
	  register_globals = Off. Nowsze wersje php maj takie ustawienia
	  domylnie.
	- rownie polecam zainstalowanie genialnego moduu do apache -
	  mod_security, wspaniale zabezpiecza on przed czsci atakw XSS.
    - ipfm v0.12.0pre1

jednak powinno dziaa bez wikszych zmian, rwnie na innych platformach 
obsugujcych php. Znane s problemy z dziaaniem scr_ipfm w poczeniu z 
php w wersji 4.0.6.

a) Zalety:
Oto niektre jego zalety:
    - sortowanie po polach in, out, host oraz total
    - sumaryczne wyniki iloci cignitych danych
    - statystyki dzienne, miesieczne, roczne, globalne oraz wg. hosta

b) Pobieranie:
Najnowsz wersj zawsze mona pobra ze strony domowej projektu: 
http://gibas.org/sdas/scr_ipfm/

lub bezporednio z respozytorium cvs:

    cvs -d :pserver:anonymous@gibas.org:/home/cvs login
    [haso jest puste]
    cvs -d :pserver:anonymous@gibas.org:/home/cvs get scr_ipfm

2. Instalacja programu ipfm:

    $ wget http://robert.cheramy.net/ipfm/archive/devel/0.12/ipfm-0.12.0pre1.tgz
    $ tar -xzvf ipfm-0.12.0pre1.tgz
    $ cd ipfm-0.12.0pre1
    $ ./configure
    
	W razie gdyby wyskoczy bd:
	
	[...]
	configure: error: You need libpcap in order to use ipfm
	
	naley jeszcze scign oraz zainstalowa bibliotek libpcap. Mona j 
	znale na http://www.tcpdump.org
    
    $ make
    $ su root
    # make install

    Jeeli nie masz katalogu /var/log/ipfm naley go stworzy:
    # mkdir /var/log/ipfm
    
    Jeeli Twj apache jest w chrootowanym rodowisku, powiniene t ciek 
    zmieni na inn, ktra bdzie wewntrz chroot-a.
     
3. Instalacja scr_ipfm:
    Zakadam, e ju ipfm ju zainstalowane w systemie, oraz s generowane
    statystyki. Powiniene mie rwnie ju scignity oraz rozpakowany 
    skrypt scr_ipfm (jak to czytasz najprawdopodobniej wanie tak jest)

    a) Na pocztku naley podmieni plik konfiguracyjny ipfm ( u mnie by w
       /usr/local/etc/ipfm.conf) , na ten, ktry jest dostarczony razem z 
       scr_ipfm (ipfm.conf-sample).
       
       #mv /usr/local/etc/ipfm.conf /usr/local/etc/ipfm.conf-orig
       #cp ipfm.conf-sample /usr/local/etc/ipfm.conf
    
    b) Restartujemy ipfm, aby ponownie wczyta plik konfiguracyjny.
       
       #killall -HUP ipfm
    
    c) Przegrywamy pliki z pakietu do katalogu, ktry jest widoczny z 
       internetu, np.:
       
       #cp scr_ipfm-0.45/ /usr/local/apache/htdocs/scr_ipfm/

    d) Od tego momentu, jeeli wszystko dobrze zrobie, statystyki powinny 
       by widoczne z internetu.

    WANE: W przypadku, gdyby statystyki wyliczay nieprawidowe dane, lub 
	   pokazyway niewaciwe linki, sprawd czy w katalogu z logami
	   ipfm (/var/log/ipfm/) wszystkie pliki maj taki sam format nazwy.
	   scr_ipfm dobrze dziaa przy formatach typu (ipfm-global-[rok]-[miesic]-[dzie].log): 
	   ipfm-global-2003-04-03.log oraz ipfm-global-03-04-03.log. Przy 
	   innych raczej bd problemy.

4. Konfiguracja:

Konfiguracja scr_ipfm polega gwnie na edycji pliku conf.php.

    a) $version
	Zmienna $version okrela wersj scr_ipfm. Jej warto jest wywietlana
	na stronie - w dolnej tabeli.

    b) $hosts_allow
	Zmienna $hosts_allow przechowuje adresy ip hostw/sieci z ktrych bdzie
	dostp do statystyk. Adresy mog byc oddzielone od sieci przecinkiem, 
	rednikiem lub spacj. 

	przykad: 
	$hosts_allow = "192.168.1.9 223.80.45.0,80.80.80.15"

    c) $ipfm_log_dir
	Zmienna $ipfm_log_dir pokazuje w jakim katalogu scr_ipfm ma szuka logw 
	wygenerowanych przez ipfm. W tym katalogu nie powinno byc innych katalogw,
	lub plikw o innej nazwie ni ta, zdefiniowana w pliku ipfm.conf
    
	przykad:
	$ipfm_log_dir = "/var/log/ipfm"

    d) $default_stats
	Ta zmienna ustawia ktre statystyki maj si pokazywa przy pierwszym wejciu
	na stron. Moe przyjmowa jedn z wartoci: daily, dayinmonth, monthly, 
	monthinyear, yearly, yearinglobal, global.
	
	przykad:
	$default_stats = "monthly";
    
    e) $default_theme
	Zmienna ta, okrela plik stylu, ktry bdzie adowany podczas otwierania strony.
	Jest to plik style.css z jednego z katalogw themes/

    f) $auto_refresh
	Pokazuje czy, i jak czsto ma sie odwierza strona ze statystykami. Powinna
	zawiera ilo sekund po ktrych nastpi odwierzenie. 
	
5. Tworzenie wasnych tematw

Wikszo ustawie dotyczcych wygenerowanych stron mona ustawi w pliku style.css w
jednym z podkatalogw w katalogu themes/.

Jest to zwyky plik tekstowy i jeeli znasz choby w minimalnym stopniu CSS z pewnoci
sobie poradzisz. Jeeli napiszesz swj wany temat i bdziesz chcia si podzieli
nim z innymi uytkownikami z chci dodam go do paczki scr_ipfm.


$Id: README_pl,v 1.22 2003/11/08 01:04:46 gibas Exp $
