Instrukcja obsługi systemu dLibra 5.0 oraz dMuseion 1.0

Skip to end of metadata
Go to start of metadata

Przygotowanie do instalacji serwera systemu dLibra

 

Wymagane oprogramowanie


Aby zainstalować i uruchomić serwer systemu dLibra niezbędne jest następujące oprogramowanie:

  • Maszyna Wirtualna Java (JRE lub JDK) - w wersji 8, implementacja Oracle lub OpenJDK. Oprogramowanie to musi być zainstalowane na każdym komputerze, na którym ma być uruchomiony serwer systemu dLibra oraz instalator systemu. Należy pamiętać o ustawieniu zmiennej systemowej JAVA_HOME na katalog w którym zainstalowano JRE, oraz dodaniu do zmiennej systemowej PATH podkatalogu bin katalogu, w którym została zainstalowano JRE.
  • Apache Ant - w wersji co najmniej 1.7.0, dostępne na stronie Apache. Oprogramowanie to musi być zainstalowane na komputerze, na którym uruchamiany będzie instalator systemu. Należy pamiętać o ustawieniu zmiennej systemowej ANT_HOME na katalog w którym zainstalowano Apache Ant, oraz dodaniu do zmiennej systemowej PATH podkatalogu bin katalogu, w którym został zainstalowany Apache Ant.
  • Baza danych - niezbędna, aby uruchomić serwer systemu dLibra. Aktualnie wspierane są następujące typy baz danych: Oracle w wersji od 9.2.x, PostgreSQL w wersji 9.x, MariaDB w wersji 5.5 oraz MySQL w wersji 5.5. W szczególnych przypadkach można zrezygnować z zewnętrznej bazy danych i wykorzystać wbudowaną w serwer dLibra bazę danych Derby - szczegółowe informacje poniżej.


Kodowanie UTF-8

Baza danych, która będzie wykorzystywana do działania systemu dLibra powinna być tak skonfigurowana, aby przechowywała dane w kodowaniu UTF-8 lub zgodnym.

W przypadku bazy danych MySQL konieczne może okazać się poprawienie domyślnego sposobu porównywania znaków przy kodowaniu UTF-8. Szczegółowe informacje znaleźć można w sekcji Niewłaściwe porównywanie znaków diakrytycznych w bazie MySQL.


Działanie bez zewnętrznej bazy danych

Możliwe jest działanie systemu dLibra bez zewnętrznej bazy danych. Wykorzystuje on wtedy wbudowaną bazę Apache Derby. Należy pamiętać, że rozwiązanie z zewnętrzną bazą danych zapewnia lepszą wydajność i stabilność systemu w przypadku zwiększonego obciążenia. Z tego powodu rozwiązanie z bazą wbudowaną zalecane jest tylko do mniejszych instalacji wykorzystywanych w celach demonstracyjnych czy testowych.

Zawartość dystrybucji

Link umożliwiający pobranie pakietu dystrybucyjnego oraz login i hasło będą dostępne po podpisaniu umowy. Aby je otrzymać, należy skontaktować się z pomocą techniczną zespołu dLibra (help@dlibra.psnc.pl).

 

Struktura katalogów dystrybucji systemu dLibra zawiera katalogi bezpośrednio związane z systemem dLibra:

  • binaries- zawiera wersje wykonywalne poszczególnych komponentów systemu. Poszczególne podkatalogi zawierają:
    • dlibra-client-publication-files-uploader - narzędzie służące do dodawania plików do publikacji planowanej.
    • dlibra-server - serwer systemu dLibra.
    • dlibra-webapp - aplikacja czytelnika (WWW).
  • install-sql - zawiera skrypty sql niezbędne do utworzenia i wstępnego wypełnienia struktury bazy danych w każdej ze wspieranych baz danych.
  • migrate-sql - skrypty zawierające polecenia SQL wykorzystywane do migracji struktury bazy danych do bieżącej wersji.

Równolegle w katalogu dystrybucyjnym znajdują się pliki i katalogi instalatora systemu dLibra:

  • lib - zawiera biblioteki pomocnicze instalatora.
  • resources - zawiera zasoby graficzne i tekstowe instalatora.
  • install.bat, install.sh - skrypty służące do uruchomienia instalatora odpowiednio w systemie Windows i Linux/Unix.
  • antinstall-config.xml, build.xml - pliki konfiguracyjne instalatora.

Dodatkowo w głównym katalogu pakietu instalacyjnego znajdują się następujące pliki:

  • sample-server.properties - szablon konfiguracji instalatora serwera systemu dLibra.
  • sample-webapp.properties - szablon konfiguracji instalatora Aplikacji Czytelnika.

 

Parametry instalacyjne


Przed przystąpieniem do instalacji należy przygotować plik tekstowy zawierający parametry konfiguracji instalacji serwera systemu dLibra. Plik ten zawiera kolejne wpisy w postaci: <nazwa>=<wartosc>. Każdy wpis powinien znajdować się w osobnej linijce. Szablon tego pliku, zawierający przykładowe wartości niektórych parametrów to wspomniany wcześniej plik sample-server.properties znajdujący się w głównym katalogu pakietu dystrybucyjnego. Znaczenie poszczególnych parametrów zawiera Dodatek A. Parametry konfiguracyjne instalatora systemu dLibra.

Znaki spacji w wartościach parametrów instalacyjnych

Icon

Często popełnianym błędem jest pozostawienie na końcu wartości wpisu w pliku konfiguracyjnym instalatora nadmiarowych znaków spacji. Znaki te nie są ignorowane, tak więc jeżeli np. w pliku konfiguracyjnym serwera podane zostanie hasło administratora z nadmiarowym znakiem spacji na końcu, to przy logowaniu do systemu niezbędne będzie podanie go również z tym nadmiarowym znakiem.

Notatka

Icon

Warto zachować pliki konfiguracyjne wykorzystane w procesie instalacji. Mogą one być później wykorzystane przy migracji do nowszych wersji oprogramowania dLibra.

 

Proces instalacji


Po zainstalowaniu niezbędnego oprogramowania zewnętrznych dostawców (patrz punkt Wymagane oprogramowanie), można rozpocząć proces instalacji systemu dLibra. Składa się on z opisanych poniżej dwóch kroków. Pierwszy z nich to uruchomienie instalatora w celu zebrania odpowiednich informacji i przygotowania odpowiednio skonfigurowanych pakietów oprogramowania. Drugi krok polega na odpowiednim rozmieszczeniu wygenerowanych przez instalator pakietów oprogramowania.

 

Uruchomienie instalatora


Instalator serwera uruchamia się poprzez uruchomienie interpretera skryptów Apache Ant w katalogu głównym pakietu instalacyjnego (polecenie ant) z parametrem server. W procesie instalacji serwera generowane jest hasło dostępowe niezbędne w procesie Aplikacji Czytelnika. Istotne jest więc, aby najpierw zainstalować serwer, a dopiero później Aplikację Czytelnika.

Interpreter automatycznie wczyta znajdujący się tam skrypt instalatora i rozpocznie wykonywanie odpowiednich operacji. Po uruchomieniu tego skryptu, niezależnie od wybranej opcji użytkownik będzie musiał odpowiedzieć na przedstawione poniżej pytania:

Please enter configuration file name:

Odpowiedzią na to pytanie powinna być nazwa pliku (wraz z pełną ścieżką), który zawiera parametry instalacyjne serwera.

Please enter target directory for this installation:

Odpowiedź na powyższe pytanie określa katalog docelowy, do którego zostanie skopiowane skonfigurowany serwer.

Po podaniu katalogu instalator rozpocznie faktyczny proces instalacji, w trakcie którego nastąpi stworzenie plików konfiguracyjnych oraz skopiowanie skonfigurowanych komponentów do katalogu docelowego.
Po zakończeniu instalacji w katalogu docelowym powinien znaleźć się podkatalog dlibra-server-5.0.x zawierający przygotowany do uruchomienia serwer dLibra.

Dodatkowo na końcu procesu instalacji serwera na ekranie wyświetlone zostanie wygenerowane w trakcie tej instalacji hasło dostępowe Aplikacji Czytelnika. Hasło to należy zapisać jako wartość parametru psPasswd w pliku konfiguracyjnym instalatora Aplikacji Czytelnika.

 

Rozmieszczenie serwera


Po poprawnym zakończeniu działania instalatora i zainicjalizowaniu bazy danych należy przenieść skonfigurowany serwer we właściwą lokalizację. Czynność ta została poniżej krótko opisana.

W wyniku instalacji w docelowym katalogu powstaje podkatalog o nazwie dlibra-server-numer.wersji, zwany dalej katalogiem głównym serwera. numer.wersji powinien zaczynać się od "5.0." po czym powinien znajdować sie numer instalowanej wersji (np. "5.0.2"). Zawiera on przygotowany do uruchomienia serwer systemu dLibra. Serwer może być uruchomiony bezpośrednio w katalogu, w którym został umieszczony w procesie instalacji. Można też przenieść ten katalog w dowolne inne miejsce na dysku. Dopuszczalna jest zmiana nazwy katalogu z dlibra-server-numer.wersji na dowolną inną.

  • No labels