FIDSERW Instrukcja użytkownika Wersja 1.02 Warszawa, 10.07.2005 1
1. Wprowadzenie Program FIDSERW jest narzędziem umożliwiającym wykorzystanie protokolu Z39.50 do przeszukiwania baz pakietu bibliotecznego MAK. Standard Z39.50 określa usługę opartą na architekturze klient-serwer oraz protokół do pozyskiwania informacji. Standard definiuje metody i formaty, aby klient mógł przeszukiwać bazy udostępnione poprzez serwer, pobierać rekordy a także wykonywać inne funkcje związane z pozyskiwaniem informacji. Szczegółowe informacje można znaleźć w Internecie na stronie http://www.loc.gov/z3950/agency/. FIDSERW pełni rolę serwera, czyli udostępnia dane użytkownikom nie mającym bezpośredniego dostępu do naszej bazy. Dzięki temu możliwe jest przegladanie baz danych lub uzyskiwanie opisów bibliotecznych sporządzonych przez inne biblioteki, skłonne udostępnić swoje zasoby. W chwili obecnej można, dzięki zastosowaniu FIDSERWa przegladać bazy MAK w mutliwyszukiwarkach FIDKAR na stronach Biblioteki Narodowej lub Federacji FIDES. Można też np. pobierać opisy wzorcowe z Przewodnika Bibliograficznego - Bibliografii Narodowej tworzonej przez Bibliotekę Narodową jeżeli posiadamy aplikację do tworzenia baz danych z wbudowanym klientem protokołu Z 39.50. 2. Zalecenia bezpieczeństwa Program FIDSERW jest aplikacją pełniącą usługę serwera w sieci, czy to lokalnej czy też Internecie. W przypadku sieci lokalnej można założyć, że wiemy kto korzysta z komputerów do tej sieci podłączonych i że mamy pewne zaufanie do tych osób. Ryzyko jest wtedy stosunkowo małe, nie mniej zalecamy stosowanie oprogramowania antywirusowego. W przypadku udostępniania danych w Internecie należy zwrócić uwagę na pewne dodatkowe niebezpieczeństwa z tym związane. Mianowicie komputer z zainstalowanym FIDSERW-em musi mieć stały adres IP. W związku z tym jest widoczny w sieci i może stać się celem ataków z zewnątrz. Warto zwrócić uwagę, że wykorzystanie FIDSERWa nie zwiększa ryzyka ataku dla maszyny już podłączonej do sieci, ponieważ program nasłuchuje na jednym konkretnym porcie i tylko do niego powinnien być zapewniony dostęp z zewnątrz. Użytkowanie aplikacji FIDSERW wymaga jednak stosowania pewnych podstawowych elementów zabezpieczeń. Po pierwsze warto pamiętać o stosowaniu oprogramowania antywirusowego i typu firewall w przypadku systemów rodziny Microsoft Windows. W przypadku systemów Linux/UNIX należy zwrócić uwagę na poprawną konfigurację zabezpieczeń, oraz sprawdzanie aktualizacji systemu. Drugą istotną kwestią jest blokowanie wszystkich nieużywanych portów (dla FIDSERWa tylko jeden wybrany przez Państwa port musi być dostępny). Można tego dokonać poprzez konfigurację firewall-a sprzętowego, poprzez konfigurację firewall-a programowego (Windows) lub też bezpośrednio w systemie (Unix/Lunux). Zalecanym rozwiązaniem jest wykorzystanie sprzętowych zapór typu firewall filtrujących cały ruch wchodzący do danej sieci. Dobrym rozwiązaniem stosowanym w wielu bibliotekach jest dopuszczanie ruchu tylko z określonych adresów IP (znanych Państwu instytucji, zaufanych serwerów, które powinny mieć dostęp do baz poprzez FIDSERW). Zmniejsza to ryzyko dostępu osób niepowołanych. 2
Można w ten sposób port dedykowany dla programu FIDSERW otworzyć na tylko jeden adres IP konkretnej wyszukiwarki typu FIDKAR lub KARO. Konfiguracja zabezpieczeń jest ściśle zależna od specyfiki dostępu do Internetu w bibliotece. W tej sprawie zalecamy kontakt z administratorem Państwa sieci (w szczególności jeżeli ruch do sieci jest blokowany na zewnętrznym firewallu, taki kontakt będzie niezbędny, aby ustalić port, na którym będzie można uruchomić FIDSERW). Informacje dla administratora: FIDSERW może nasłuchiwać połączeń na dowolnym porcie (jest to konfigurowalne). Należy przepuszczać połączenia TCP/IP. 3. Instalacja Program FIDSERW należy zainstalować na komputerze mającym dostęp do baz danych, albo lokalnie albo poprzez sieć lokalną. 3.1. Wersja dla Windows 1. Po włożeniu płyty do napędu instalacja powinna rozpocząć się samoczynnie. Jeżeli się nie rozpocznie to należy uruchomić plik setup.exe znajdujący się w katalogu głównym płyty CD. 2. Po uruchomieniu instalatora i zaakceptowaniu warunków licencji należy postępować zgodnie z instrukcjami pojawiającymi się na ekranie. Można wybrać miejsce instalacji oraz niektóre komponenty opcjonalne, takie jak dokumentacja. 3. Po zakończeniu działania kreatora instalacji w Menu Start systemu powinien pojawić się folder FIDSERW, w którym powinny znajdować się dwa programy: Konfiguracja Start Fidserw 4. Oznacza to, że instalacja została zakończona pomyślnie i można przystąpić do konfiguracji Fidserwa, która została opisana w następnym punkcie. 3.2. Wersja dla Unix/Linux 1. Przed rozpoczęciem instalacji prosimy zapoznać się z plikiem licencji licencja.pdf/licencja.txt. Dalsze działania instalacyjne oznaczają zaakceptowanie warunkow licencji. 2. FIDSERW dostarczany jest wraz ze skryptem instal, którego zadaniem jest przeprowadzenie instalacji. Skrypt ten przyjmuje dwa parametry. Pierwszym jest bezwzględny katalog instalacji, a drugim jest port na którym FIDSERW będzie nasłuchiwał żądań udostępnienia informacji poprzez protokół Z39.50. Wobec tego po nadaniu uprawnień wykonywalności (np. chmod o+x instal) należy wywołać skrypt: instal katalog_docelowy_instalacji numer_portu 3
3. Po pomyślnym wykonaniu się skryptu w docelowym katalogu instalacji znajdą się pliki: bazy.mm - plik konfiguracyjny blowfish.dat - plik licencyjny fidserw - wersja binarna programu Fidserw license.mm - plik licencyjny start - skrypt pomocniczy (szerzej w następnym punkcie) starttest - skrypt pomocniczy stop - skrypt pomocniczy 4. Skrypty start, starttest oraz stop są skryptami pomoczniczymi, bowiem sam program można uruchomić wydając polecenie fidserw. Zaleca się jednak korzystanie z wymienionych skryptów w celu łatwiejszego użytkowania programu. start jest skryptem uruchamiającym program FIDSERW. Powoduje on utworzenie pliku logu fidserwnn.log (gdzie NN jest kolejną liczbą) i ustawia port nasłuchu zgodnie z tym co podał użytkownik w trakcie instalacji. starttest jest skryptem, który w założeniu ma być wywoływany poprzez demona zegarowego CRON. Jego rola sprowadza się do sprawdzenia, czy aktualnie w systemie jest działający FIDSERW na danym porcie. Jeżeli FIDSERW działa to skrypt nie podejmuje żadnej akcji, jeżeli zaś nie to wywołuje skrypt start. Sugerujemy dodanie następującej lub podobnej linii w pliku /etc/crontab: 0,30 * * * * root docelowy_katalog_instalacji/starttest aby co pół godziny system samoczynnie sprawdzał, czy proces FIDSERW jest obecny w systemie, czy też z jakichś przyczyn zakończył się. Niestety w niektórych konfiguracjach program FIDSERW potrafi się zakończyć samoczynnie po pewnym czasie. stop jest skryptem zatrzymującym proces FIDSERW i wszystkie jego procesy potomne dzialające na porcie wskazanym w instalacji. UWAGA: Wszystkie skrypty można swobodnie modyfikować, w szczególności numer portu i katalog instalacji są zapisane w zmiennych port i directory ustawianych na początku skryptu. 4. Konfiguracja 4.1. Wersja dla Windows Konfiguracja FIDSERW'a w systemie Windows może zostać dokonana na 2 sposoby. Można ręcznie edytować plik bazy.mm zawierający ustawienia baz, które mają być udostępniane bądź też skorzystać z narzędzia z interfejsem graficznym dostępnego poprzez Menu Start o nazwie Konfiguracja. W tym miejscu zostanie opisana konfiguracja z 4
wykorzystaniem interfejsu graficznego. Osoby zainteresowane konfiguracją w trybie edycji pliku tekstowego mogą przeczytać niezbędne informacje w opisie konfiguracji dla Linux/Unix, która jest identyczna. Wracając do konfiguracji z wykorzystaniem narzędzia Konfiguracja. Po uruchomieniu programu możemy zobaczyć okno zbliżone wyglądem do rysunku 1. Rys. 1. Okno programu konfiguracyjnego Po lewej stronie widoczny jest spis zdefiniowanych baz oraz dwa przyciski pozwalające na założenie nowej i usunięcie istniejącej bazy. Po prawej stronie okna widać parametry aktywnej (zaznaczonej na niebiesko na rysunku) bazy. Są to nazwa bazy i jej położenie w strukturze katalogów w górnej ramce oraz poszczególne indeksy w ramce dolnej. Aby dodać nową bazę wykonujemy: 1. Wciskamy przycisk Nowa baza. Powinniśmy ujrzeć taki stan jak na rysunku 2. Rys. 2. Okno konfiguracji nowej bazy 2. W drugim kroku zmieniamy nazwę bazy nowa_baza na nazwę naszej bazy. 3. Później wypełniamy pole położenie poprzez naciśnięcie przycisku Przeglądaj, który otwiera okno dialogowe do wyboru pliku bazy (jak na rysunku 3). Wybieramy interesującą nas bazę i klikając przycisk Otwórz. 5
Rys. 3. Okno wyboru pliku bazy 4. Kolejną czynnością. Jest wybór indeksów. Indeksy wybieramy z rozwijanych list, tak aby ich znaczenie odpowiadało terminowi po lewej stronie listy wyboru (Zobacz rysunek 2 pkt. 4). 5. Cały proces dodawania bazy kończymy wybierając przycisk ZAPISZ. W tym momencie pierwsza baza zostala skonfigurowana i można dodawać kolejne bazy do programu. W dowolnym momencie wprowadzone dane można modyfikować, poprzez wybór żądanej bazy z listy po lewej stronie. Wszystkie zmiany kończymy wybierając przycisk ZAPISZ. 4.2. Wersja dla Linux/Unix W systemie Linux/Unix jedynym sposobem konfiguracji aplikacji FIDSERW jest uzupełnienie pliku bazy.mm. Plik ten stanowi opis baz, do których FIDSERW powinien mieć dostęp i jest pisany jawnym tekstem z wykorzystaniem słów kluczowych. Opis każdej bazy rozpoczyna się od słowa kluczowego b po którym następuje nazwa bazy. W dalszej kolejności należy podać położenie bazy po słowie kluczowym url oraz indeksy. Pełen zbiór słów kluczowych opisany jest poniżej wraz z przykładowym opisem bazy katm21-d. Słowo kluczowe b url iauthor ititle iseries iisbn Znaczenie nazwa bazy, używana w protokole Z39.50, stanowi unikalny identyfikator w obrębie FIDSERW. Może być różna od nazwy bazy w MAK-u. ścieżka dostępu wraz z nazwą pliku bazy bez rozszerzenia np: /usr/mak/kat/katm21-d indeks autorski (1003 w BIB-1) indeks tytułowy (4 w BIB-1) indeks serii (5 w BIB-1) indeks numerów ISBN (7 w BIB-1) 6
Słowo kluczowe iissn isubject idate ipublisher ititleword ikeyword Znaczenie indeks numerów ISSN (8 w BIB-1) indeks przedmiotowy (21 w BIB-1) indeks daty wydania (31 w BIB-1) indeks wydawców (1018 w BIB-1) indeks słów w tytule (4 w BIB-1, attr3=3) indeks słów kluczowych np. rzeczowy (29 w BIB-1) Przykładowy opis bazy: b=katm21-d url=/usr/mak/kat/katm21-d iauthor=autorski ititle=tytułowy iisbn=numerów-isbn isubject=haseł-przedm ikeyword=rzeczowy ipublisher=wydawców UWAGA: Po słowie kluczowym następuje znak równości i nazwa bez żadnych znaków spacji. Opis bazy rozpoczyna słowo kluczowe b, dalsza kolejność jest dowolna. Nie wszystkie indeksy muszą być wypełnione. Powyższy opis jest poprawny zarówno dla systemu Linux/Unix jak również MS Windows (dla systemu Windows są dwie metody konfiguracji tekstowa i graficzna opisana wyżej). 5. Uruchamianie 5.1. Wersja dla Windows Aby uruchomić program FIDSERW należy uruchomić program START FIDSERW z Menu Start. Powinno się wtedy pokazać okno, takie jak na rysunku 4. Rys. 4. Okno programu uruchomieniowego Aby uruchomić FIDSERW: 1. Podajemy numer portu, na którym ma nasłuchiwać FIDSERW (należy to uzgodnić z administratorem sieci) 2. Definiujemy plik LOG, do którego zapisywane są informacje o działaniu programu. Plik LOG wybieramy poprzez przycisk Przeglądaj i wybór pliku z okna dialogowego takiego jak przedstawiono na rysunku 3. 3. Zatwierdzamy ustawienia naciskając OK. W tym momencie został uruchomiony program FIDSERW w zminimalizowanym oknie. 7
UWAGA: Otworzonego okna nie wolno zamykać! W przeciwnym wypadku wyłączymy FIDSERW. FIDSERW'a można uruchomić również z linii poleceń. Znajdując się w jego katalogu instalacji (domyślnie C:\Program Files\Fidserw) wpisujemy polecenie: fidserw.exe -l nazwa_pliku_log tcp:@:numer_portu Jeżeli nie podamy opcji -l z nazwą pliku LOG, to wszystkie komunikaty będą wypisywane w oknie działającego programu. 5.2. Wersja dla Linux/Unix FIDSERW'a pod Linux/Unix uruchamiamy poprzez wywołanie skryptu start opisywanego przy okazji opisu instalacji. Automatyczne uruchamianie można uzyskać poprzez dodanie do konfiguracji demona zegarowego CRON wpisu wołającego skrypt starttest. Podobnie jak pod Windows można uruchomić FIDSERW'a bezpośrednio wołając plik fidserw. W przypadku Linux/Unix zalecane jest uruchomienie programu w tle (&), najlepiej poprzez nohup, aby serwer mógł działać również po wylogowaniu się. nohup fidserw -l nazwa_pliku_log tcp:@:numer_portu & W miarę możliwości zalecamy korzystanie ze skryptów pomocnicznych. 6. Najczęściej spotykane problemy 1. Program się nie uruchamia i wypisuje komunikat: Niepoprawny plik licencji. Proszę sprawdzić, czy w katalogu docelowym instalcji znajdują się pliki license.mm oraz blowfish.dat. 2. Program się nie uruchamia, a w pliku LOG zapisuje: Failed to bind... Komunikat może brzmieć tak lub podobnie w zależności od systemu. Oznacza on, że wskazany port jest wykorzystywany przez inny program. Należy odczekać kilka minut i spróbować ponownie w szczególności jeżeli przed chwilą działał na tym porcie FIDSERW, jeżeli to nie pomoże może okazać się niezbędna zmiana portu, ponieważ ten może być wykorzystywany przez inne uslugi. 3. Nie działa przeszukiwanie bazy i na konsoli (ew. w pliku nohup.out) pojawia się zapis: Nie mozna otowrzyc pliku bazy: [blad n] (gdzie n jest liczbą całkowitą). Oznacza to, że nie można otworzyć plików bazy *.baz, *.ind lub *.org. Należy sprawdzić podaną ścieżkę i uprawnienia dostępu do katalogów i plików. 4. Pod niektórymi wersjami Linux-a program potrafi się wyłączyć w trakcie użytkowania W chwili obecnej błąd jest ciągle analizowany i w miarę możliwości zostanie naprawiony w kolejnych wersjach. W razie kłopotów prosimy o kontakt z Federacją Fides! Dziękujemy za zakup programu! 8