Instalace XCNCIP2Toolkit jako implementace NCIP protokolu

black23 edited this page Jun 21, 2017 · 16 revisions

Poznámka: níže opsaný postup funguje v systému Debian, ale s mírnými rozdíly bude funkční v dalších distribucích linuxu.

Jak na to?

V podstatě máte dvě jednoduché možnosti rychlé instalace:

  1. Za pomocí virtualizovaného prostředí Docker a připraveného buildu
  2. Za pomocí BASH skriptu přímo do OS, ve kterém skript spustíte

Třetí, relativně pomalou metodou je instalace krok za krokem, což Vám umožní nahlédnout a pochopit postupy instalace a mít větší kontrolu nad tím, co vše do svého systému instalujete. Tato metoda je rozepsána nejníže.

Nastavení v systému Koha

Vytvořte si speciální kategorii, která bude využívána jen pro transakce přes API, pojmenujte ji například API_bots. Vytvořte nového čtenáře a pojmenujte ho nápadně, aby nedošlo k záměně. Dále přejděte k nastavení oprávnění a povolte přístup do intranetu.

Zaškrtněte:

X catalogue Je nutné pro všechny knihovníky Umožňit přístup do intranetu a katalogu knihovny

Uchovejte ID tohoto speciálního čtenáře a jeho přístupové heslo. Údaje budete potřebovat při nastavení NCIP.

Instalace ve virtualizovaném Docker prostředí

  1. nainstalujte si Docker návod
  2. stáhněte si obsah obsah tohoto adresáře na stroj, kde chcete NCIP provozovat (to lze snadno provést pomocí příkazu git clone https://github.com/eXtensibleCatalog/xcncip2toolkit.git, čímz stáhnete celý projekt a pak stačí vejít do dockerfile adresáře)
  3. spusťte Docker instalaci příkazem ./install-koha.sh a vyplňte pole, na která se Vás instalace zeptá
  4. jakmile nespatříte žádný ERROR, pak spusťte Docker kontejner příkazem ./start.sh (zastavit lze ./stop.sh) pakliže nějaký ERROR spatříte, obraťte se na mail@jkozlovsky.cz nebo zde založte issue
  5. rozhraní XCNCIP2Toolkit běží na http://localhost:8080/koha-web/

Instalace BASH skriptem

  1. stáhněte si tento soubor a spusťte jej:

cd /tmp && wget -Nq https://github.com/open-source-knihovna/KohaCZ/raw/master/xcncip2toolkit-install.sh && bash xcncip2toolkit-install.sh

  1. vyplňte potřebné údaje a případně řeště vzniklé problémy jako může být například již obsazený port (zvolte jiný), nedostatek místa na úložišti (cca 3GB !) atd ..

  2. až skript dokončí svou práci, navštivte URL, kterou Vám nabídne v konzoli pro ověření funkčnosti

"Ruční" instalace bez Dockeru či BASH skriptu

  1. Stáhnout a nainstalovat závislosti apt-get install git maven openjdk-7-jdk tomcat8
  2. Naklonovat xcncip2toolkit z Gitu do adresáře /opt
  • cd /opt
  • git clone https://github.com/eXtensibleCatalog/xcncip2toolkit.git
  1. Vytvořit v Koha uživatele, přes kterého bude NCIP provádět transakce
Typ čtenáře: API bots (BOT)
Práva uživatele: cataloque
Login a heslo dle libosti a poznačit na později ..
  1. Kompilace jádra xcncip2toolkit cd /opt/xcncip2toolkit/core/trunk

Tento příkaz stáhne závislosti a skončí chybou: (to je bohužel očekávané chování převzaté od organizace eXtensibleCatalog spravující NCIP protokol a jeho xcncip2toolkit implementaci) mvn install

Tento příkaz už chybou neskončí (pokud ano, tak jen u projektu example a initiator, což Vás v podstatě nemusí zajímat a můžete předpokládat kompilaci za zdařilou): mvn install -Dmaven.test.skip

  1. Nastavení Koha connectoru pro xcncip2toolkit cd /opt/xcncip2toolkit/connectors/koha/3.xx/trunk/web/src/main/resources/ cp toolkit.properties.example toolkit.properties

Nastavte takto:

# Koha Configuration
AgencyUnstructuredAddress=**Adresa Vaši knihovny**
AgencyTranslatedName=**Český název Vaši knihovny**
AgencyId=**SIGLA Vaši knihovny**

# Set this link to your client's registration site
UserRegistrationLink=**URL pro online registraci do Vaši knihovny** (ponechte prázdné pokud takovou službu nemáte)

# OPACServer must be in format without backslash at the end & does have to include either https:// or http://
IntranetServer=**URL Vašeho intranetu včetně specifikace zda se jedná o http či https!**
IntranetPort=**port, na kterém běží Váš intranet**

AdminName=**uživatelské jméno NCIP bota**
AdminPass=**heslo NCIP bota**

# Time in hours needed to transfer item after being requested from specific branch (format is: "BranchCode:Hours, BranchCode:Hours")
TransferBranchTime=**Mapování Vašich oddělení a doby, která je průměrně nutná k přichystání výpůjčky při žádosti o výpůjčku v tomto oddělení v hodinách**
Příklad: DOSP:1, SPBE:48, P:24

Kde vzít kódy jednotlivých oddělení ve vaší instalaci? https://VASE_URL(:port)/cgi-bin/koha/admin/branches.pl

Texty musí být v Unicode, takže je vhodné za účelem zachování české diakritiky v nastavení právě vytvořený konfigurační soubor toolkit.properties do tohoto formátu převést těmito dvěma příkazy:

native2ascii toolkit.properties > toolkit.properties.temp mv toolkit.properties.temp toolkit.properties

  1. Kompilace Koha connectoru pro xcncip2toolkit po úspěšné konfiguraci: cd /opt/xcncip2toolkit/connectors/koha/3.xx/trunk/

Tento příkaz nesmí skončit chybou: mvn install -Dmaven.test.skip

  1. Symlink waru do Tomcatu ln -s /opt/xcncip2toolkit/connectors/koha/3.xx/trunk/web/target/koha-web-0.0.1-SNAPSHOT.war /var/lib/tomcat8/webapps/koha-web.war

  2. Nastavení portu, pro otestování si nastavte port, na kterém chcete vyzkoušet funkčnost NCIPu (pokud Vám stačí 8080, tak můžete tento krok přeskočit). Tento příklad nastaví port na 9080 (defaultně je 8080). sed -i "s_8080_9080_g" /opt/apache-tomcat/conf/server.xml

  3. Spustíme Tomcat tomcat-start

  4. Zkontrolujeme funkčnost Tomcatu

navštivte IP stroje, na kterém jste právě nainstalovali xcncip2toolkit na portu, který jste (ne)zadali v kroku číslo 9 např. localhost:8080 - prohlížeč by neměl vyhodit žádný problém se spojením, pokud tak učiní, zkontrolujte nastavení firewallu či si ověřte nastavené IP a port

  1. Zkontrolujeme, že NCIP funguje

http://IP:PORT/koha-web/ např. 9.9.9.9:8090/koha-web/

  1. Měla by se zobrazit stránka Responderu a můžeme otestovat jeho odpovědi na několika požadavcích

Pro začátek stačí Kliknout na LookupAgency a potvrdit poslání .. pokud se ve spodním okně objeví adresa a české jméno knihovny, které jste definovali v nastavení, pak je vše OK a můžete adresu svého xcncip2toolkitu poslat na otestování vývojovému a testovacímu týmu CPK na ncip@mzk.cz

Doporučujeme pokračovat na stránce zabezpečení NCIP toolkitu

V případě nejasností při instalaci nebo dotazů kontaktujte vývojový tým:

Diskutovat můžete také on-line na našem Gitteru

Join the chat at https://gitter.im/open.source.knihovna/KohaCZ

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.