Opcje uruchamiania
Po instalacji w systemie dostępne będzie polecenie sip2server - jest to program pozwalający zarówno na konfigurowanie jak i zarządzanie serwerem SIP2.
Podstawowa składnia polecenia to:
sip2server <opcje> <komenda>
Większość opcji dostępna jest w dwóch wariantach - krótkiej (np. sip2server -p 6001) lub długiej (np. sip2server --port=6001). Na potrzeby przejrzystości dokumentacji w przykładach będą podane zwykle opcje w wariancie długim.
Spis dostępnych opcji można uzyskać wywołując polecenie (używając do wyboru opcji w wariancie krótkim lub długim):
sip2server -h
sip2server --help
Serwer podczas wywołania używa opcji podanych w parametrach, a w razie ich nie podania, opcji zapisanych w pliku konfiguracyjnym.
Znaczenie poszczególnych opcji (i ich wartości domyślne) są następujące:
-p, --port - numer portu TCP, na którym będzie nasłuchiwać serwer SIP2 [domyślnie: 6001]
-a, --bind-address - adres interfejsu sieciowego, na którym będzie dostępny serwer SIP2 [domyślnie: 0.0.0.0 - czyli wszystkie dostępne interfejsy]
-b, --backend - nazwa backendu serwera SIP2 (czyli podmodułu realizującego logikę komunikacji z systemem bibliotecznym) [domyślnie: sowa_bend - połączenie z serwerem SOWA]
-t, --threading - ustawienie trybu jedno lub wielowątkowego (tryb jednowątkowy akceptuje tylko jedno połączenie naraz). Dostępne wartości to single - jednowątkowy i multi - wielowątkowy. [domyślnie: multi]
-e, --encoding - sposób kodowania znaków diakrytycznych w komunikacji z klientem SIP2 [domyślnie: utf-8]
-l, --login - czy serwer ma obsługiwać tryb logowania w trybie telnet (dopuszczalne wartości to n - nie oraz y - tak. [domyślnie: n]
-B, --backend-options - opcje backendu, podane łącznie po przecinkach w formie <opcja>=<wartość>. (zob. dalej)
Serwer potencjalnie pozwala na różne backendy (czyli klasy wspierające różne systemy docelowe) - jedynym dostępnym obecnie backendem jest sowa_bend - czyli połączenie z systemem SOWA. Opcje dla tego backendu należy podać w opcji -B i są dostępne następujące opcje:
sowa-address - adres IP serwera aplikacji SOWA
sowa-port - numer portu, na którym uruchomiony jest katalog wypożyczalni.
Wartość domyślna dla tego parametru to sowa-address=127.0.0.1,sowa-port=40000.
UWAGA: nie można opcją -B ustawiać tylko jednego parametru backendu. Należy podać je wszystkie jednocześnie.
Zapisywanie konfiguracji domyślnej
Do zapisywanie konfiguracji domyślnej służy komenda polecenia storeconf.
Przykładowe wywołanie zmieniające wybrane domyślne parametry (tu: opcje backendu):
sip2server --backend-options=sowa-address=192.168.0.1,sowa-port=8900 storeconf
Po wykonaniu tej komendy zostanie wyświetlone podsumowanie wszystkich parametrów domyślnych. Jeśli chcemy wyświetlić parametry domyślne bez ich zmieniania, wystarczy wywołać polecenie z komendą storeconf bez żadnych parametrów.
Uruchamianie serwera SIP2
Do uruchamiania służy komenda polecenia start.
Jeśli nie będą podane żadne opcje, serwer będzie startował z zapisanymi ustawieniami domyślnymi.
Polecenie to uruchamia serwer w trybie interaktywnym, co jest bardzo pomocne w testowaniu - serwer wszystkie komunikaty wysyła na standardowe wyjście i zatrzymanie serwera następuje poprzez wciśnięcie kombinacji klawiszy CTRL+C.
Aby uruchomić serwer w tle (w trybie demona systemowego), należy wydać polecenie:
sip2server start --daemon
W tym momencie komunikaty serwera będą zapisywane do pliku ~/.sowang/var/log/sip2.log
Zatrzymywanie serwera SIP2
Zatrzymać można zarówno serwer uruchomiony w trybie interaktywnym, jak i w trybie demona. Należy wydać polecenie:
sip2server stop
Sprawdzanie stanu serwera SIP2
Do sprawdzania stanu serwera SIP2 (czyli czy jest uruchomiony, a jeśli nie, to czy stan systemu jest dobry), służy polecenie:
sip2server status