Instalace verze K5 - ceskaexpedice/kramerius GitHub Wiki
Stránka popisuje instalaci a nastavení verze 5.5.*.
Před instalací aplikace Kramerius je třeba nainstalovat následující systémové komponenty:
- Java: Oracle JDK 11 a vyšší
- Aplikační server: podporující specifikace Servlet 2.5 a JSP 2.1 nebo novější (popsaná ukázková instalace předpokládá použití Apache Tomcat 6), nepoužívat Tomcat verze >= 8.0.39 (#470)
- Databáze: Postgres 8.4 nebo novější
- Úložiště: Fedora Commons 3.4, 3.5, 3.6, 3.7, 3.8 nebo 3.8.1
- SMTP server: libovolný
Kramerius 5 nevyžaduje žádné specifické revize uvedených komponent, obecně je rozumné používat jejich pokud možno nejnovější aktualizace. Popis instalace a administrace těchto systémových komponent není součástí této dokumentace, předpokládáme, že administrátor aplikace Kramerius 5 ovládá instalaci a administraci výše uvedených komponent.
Operační systém může být libovolný, na kterém je možno tyto komponenty provozovat, vlastní aplikace Kramerius 5 žádné speciální požadavky na systém nemá. Systém je vyvíjen a testován na běžných distribucích Linuxu. Hardware serveru musí být dimenzován na uvažované množství dat, doporučujeme minimálně dvojnásobnou velikost pevného disku, než je plánovaná velikost obrazových dat. Vzhledem k velké paměťové náročnosti práce s grafickými daty (náhledy stránek, zoomování) je třeba i při minimálním provozu aplikace alespoň 8GB RAM.
K5 je vhodné nainstalovat pod samostatným uživatelským účtem, například kramerius.
V produkčním prostředí je před J2EE server (Tomcat) vhodné předřadit webserver přístupný na portu 80, například Apache s nakonfigurovanými moduly mod_proxy a mod_proxy_ajp.
Každou komponentu systému Kramerius (tedy repository Fedora, vlastní aplikaci Kramerius (search.war), indexer SOLR, databázi PostgreSQL) je možné nainstalovat na samostatný server.
Distribuční soubory aplikace Kramerius najdete v sekci Releases
Jsou všechny soubory zabaleny do jednoho archivního souboru kramerius-x.x.x.zip (znaky x.x.x jsou samozřejmě nahrazeny konkrétním číslem verze).
Všechny soubory rozděleny do několika archivních souborů:
-
Installation-x.x.x.zip
obsahuje podpůrné soubory potřebné při prvotní instalaci K5, jejich obsah se mezi jednotlivými aktualizacemi K5 nemění -
Core-x.x.x.tar.gz
obsahuje vlastní aplikaci Kramerius (search.war), soubory z tohoto archivu je třeba instalovat jak při prvotní instalaci, tak při následných aktualizacích. -
security-core-x.x.x.tar.gz
obsahuje knihovnu security-core.jar pro podporu single-signon, kterou je třeba instalovat do adresáře tomcat/libs jak při prvotní instalaci, tak při následných aktualizacích. -
Client-x.x.x.tar.gz
obsahuje alternativní samostatnou klientskou aplikaci (client.war), soubory z tohoto archivu je třeba instalovat jak při prvotní instalaci, tak při následných aktualizacích. -
Editors-x.x.x.zip
obsahuje aplikace editoru uživatelů a editoru pořadí částí dokumentů.
Pokud v konkrétním release některý z uvedených souborů chybí, znamená to, ž ev něm oproti předchozí verzi nedošlo k žádné změně a je možno ponechat soubory z předchozího release (například v release 5.3.3 je třeba použít editory ze souboru Editors-5.1.0.zip).
V následujících odstavcích jsou uvedeny požadavky aplikace Kramerius na specifickou konfiguraci systémových komponent, pokud možno i s odkazy na příklady konkrétních úprav příslušných konfiguračních souborů. Tyto příklady jsou uvedeny pouze pro ilustraci jedné z možných konfigurací a nenahrazují dokumentaci k jednotlivým systémovým komponentám. V případě distribuované instalace je třeba uvedené příklady konfiguračních URL (localhost) nahradit adresami příslušných serverů.
- Nastavit systémovou proměnnou pro instalaci Fedora Commons(
FEDORA_HOME
). - Nastavit dodatečné spouštěcí parametry pro aplikační server :
-Djava.awt.headless=true -Dsolr.solr.home=$FEDORA_HOME/solr -XX:MaxPermSize=128m -Xms512m -Xmx1024m
(Poznámka: Nastavení proměnné můžete vynechat, pokud provozujete SOLR jako samostatnou instanci. Viz: Solr 6
Příklad konfigurace systémových proměnných
(v uvedených příkladech konfigurace předpokládáme instalaci Tomcatu a Fedory do domácího adresáře uživatele kramerius4)
*Vytvořit uživatele fedoraAdmin
a pro něj databáze fedora3
, kramerius4
a (při použití implementace Fedora Resource Indexu MPTTripleStore) riTriples
.
Nainstalujte úložiště Fedora Commons podle jeho dokumentace.
Příklad instalace Fedora Commons
Po instalaci fedory je třeba do souboru $FEDORA_HOME/server/config/fedora.fcfg
do sekce začínající <module role="fedora.server.resourceIndex.ResourceIndex"
přidat následující parametry (definice aliasů pro XML namespace):
<param name="alias:kramerius" value="http://www.nsdl.org/ontologies/relationships#">
<comment>Alias for Kramerius</comment>
</param>
<param name="alias:oai" value="http://www.openarchives.org/OAI/2.0/">
<comment>Alias for OAI</comment>
</param>
Ve stejné sekci fedora.fcfg
, jako pro nastavení aliasů (resource index), je třeba změnit u parametru datastore
hodnotu na localPostgresMPTTriplestore
. V odpovídající sekci localPostgresMPTTriplestore
, kde je definován datasource pro MPTTriplesotre, je třeba nastavit databázové heslo na heslo, které jste přiřadili uživateli fedoraAdmin
.
(Poznámka: Kramerius podporuje implementaci Resource index Mulgara i MPTtripleStore. To, která implementace bude použita, je určeno konfigurační property resource.index.service.class
v souboru configuration.properties
- viz níže. Výchozí hodnota této property je nastavena na MPTtripleStore, protože implementace Mulgara není v současné podobě použitelná se službou OAI provider. )
Konfigurace úložiště Akubra je popsána na wiki Fedora Commons https://wiki.lyrasis.org/display/FEDORA38/Configuring+Low+Level+Storage
Pro velká úložiště je vhodné změnit pattern úložiště z defaultní hodnoty ##
na ##/##
.
(Parametr pattern určuje vnitřní strukturu úložiště, tedy počet úrovní stromu podadresářů a počet adresářů v jednotlivých úrovních. Názvy adresářů odpovídají počátečním znakům MD5 hashe názvu uloženého souboru, každému znaku # v patternu tedy odpovídá jeden hexadecimální znak (0 - f). Výchozí pattern ## tedy znamená, že úložiště bude mít jednu úroveň adresářů, v ní je maximálně 256 adresářů (00-ff). Pokud předpokládáte větší objemy dat, např. více než milion dokumentů, je vhodné změnit pattern na ##/##
. Úložiště pak bude mít dvě úrovně adresářů, v každé maximálně 256 adresářů (00-ff), celkem tedy přibližně 65000 adresářů. Při rovnoměrném rozložení souborů by tedy počet souborů v jednom adresáři neměl pro běžné instalace překročit 1000 souborů. Jen pro skutečně velké instituce se stovkami milionů dokumentů by bylo vhodné změnit pattern na 3 úrovně (##/##/##). Strukturu úložiště je možné měnit jen pokud nic neobsahuje).
Aplikace Kramerius má vlastní systém řízení přístupových práv a nevyužívá systém XACML pravidel Fedora Commons. Pokud nepotřebujete k úložišti přistupovat odjinud, než z aplikace Kramerius, je tedy nejjednodušší úložiště vůbec nezveřejňovat a systém pravidel XACML nevyužívat. Deaktivace autorizačního systému je popsána v dokumentaci Fedora Commons, jednou z možností je v souboru fedora.fcfg v sekci <module role="org.fcrepo.server.security.Authorization"
nastavit parametr <param name="ENFORCE-MODE" value="permit-all-requests"/>
.
Jestliže z nějakého důvodu autorizační systém Fedora Commons potřebujete používat, je pravděpodobné, že narazíte na následující situace:
-
Pokud k administrátorskému rozhraní Fedory chcete přistupovat z jiného počítače, než na kterém je nainstalovaná, musíte deaktivovat nebo upravit omezení přístupu
deny-apim-if-not-localhost.xml
-
Při použití FOXML objektů s externě referencovaným obsahem datastreamů je třeba deaktivovat nebo upravit pravidlo
deny-unallowed-file-resolution.xml
XACML pravidla jsou uložena ve složce $FEDORA_HOME/data/fedora-xacml-policies/repository-policies
. Deaktivaci lze provést buď editací xacml pravidel v souboru nebo jeho prostým odstraněním. Editace xacml pravidel je popsána v dokumentaci úložiště Fedora Commons.
Přes administrátorské rozhraní Fedory je třeba naimportovat FOXML objekty obsažené v distribučním souboru installation-x.x.zip, adresář fedora
. Pokud budete importovat i OAI Fedora model, je před jeho importem nutné provést konfiguraci . Popis administrátorského rozhraní je součástí dokumentace Fedora Commons.
Od verze 5.3.5 je možnost provozovat systém kramerius s novou verzí vyhledávače SOLR. Popis instalace je zde.
U některých verzí se může objevit poznámka o změně schématu. V tom případě je nutno změnit soubory přímo v solru. (Zejména schéma). Postup je následující:
- Stáhněte si konfigurační soubory a slovníky buď z instalačního balíčku nebo přímo z git repozitáře.
- Stáhnuté soubory umístěte do adresáře
<solr_home>/server/solr/kramerius
. - Otevřte administrační prostředí solru
http://localhost:8983/
. - V záložce core-admin vyberte odpovídající jádro a zmáčkněte tlačítko
reload
.
Poznámka: Podporováno jenom pro verze 5.3.9 a starší
Na aplikační server nainstalovat aplikaci solr.war
z distribučního souboru installation-x.x.zip.
Do adresáře $FEDORA_HOME/solr (nebo jinam podle vašich potřeb) nakopírovat obsah adresáře solr
z distribučního souboru installation-x.x.zip.
V adresáři $FEDORA_HOME/solr/conf editovat soubor solrconfig.xml - položka dataDir
Nastavit systémovou property JDK solr.solr.home
na cestu k adresáři s instalací solr (tedy obvykle $FEDORA_HOME/solr, pro Tomcat se nastavuje jako součást systémové proměnné JAVA_OPTS
)
Na aplikační server nainstalovat aplikaci search.war, client.war, editor.war a rightseditor.war z distribučních balíčků. U verze 5.3.4
jsou balíčky v souboru kramerius-5.3.4
, u starších verzí jsou souby v balíčcích Core-x.x.x.tar.gz,Client-x.x.x.tar.gz a souboru Editors-x.x.zip.
V aplikačním serveru nakonfigurujte JDBC datasource pro databázi kramerius4
( příklad pro Tomcat).
Do adresáře sdílených knihoven aplikačního serveru (v případě Tomcatu $CATALINA_HOME/lib
) přidejte jar soubor s JDBC ovladačem pro PostgreSQL, který je součástí instalace vašeho databázového serveru.
Do adresáře sdílených knihoven (v případě Tomcatu $CATALINA_HOME/lib
) je třeba nainstalovat knihovnu security-core.jar
z distribučního souboru kramerius-5.3.4.zip u verze 5.3.4 resp secutity-core-x.x.x.tar.gz u verzí předchozích.
Pokud instalujete aplikaci Kramerius na stejnou instanci aplikačního serveru, na kterém je nainstalováno úložiště Fedora Commons, je třeba do adresáře sdílených knihoven aplikačního serveru překopírovat také následující knihovní soubory jar z aplikace fedora (v případě Tomcatu adresář $CATALINA_HOME/webapps/fedora/WEB-INF/lib
):
carol
-
commons-logging
(pro Fedora Commons 3.4 a novější již není třeba) -
log4j
(pro Fedora Commons 3.4 a novější již není třeba)
V aplikačním serveru nastavte kódování URI na UTF-8 (příklad pro Tomcat)
Pro autentizaci a jednotné přihlášení uživatele pro všechny 3 webové aplikace systému Kramerius (tedy hlavní search
a administrátorské editor
a rightseditor
), aktivujte single sign-on v konfiguraci aplikačního serveru.
Aplikace Kramerius využívá standardní autentizační mechanismus JAAS, (třída autentizačního modulu je cz.incad.kramerius.security.jaas.K4LoginModule
, třída uživatelské role je cz.incad.kramerius.security.jaas.K4RolePrincipal
).
Pokud Kramerius provozujete na stejném serevru, jako úložiště Fedora, povolte autentizaci těchto modulů v konfiguraci JAAS úložiště Fedora Commons (příklad pro Tomcat)
Pokud Kramerius provozujete na jiném serveru, než úložiště Fedora, nastavte výšeuvedené autentizační údaje podle dokumentace JAAS vašeho serveru.
Po prvním spuštění aplikace se v databázi vytvoří databázové tabulky s předdefinovanými autorizačními pravidly a implicitnim administrátorským uživatelem. Předdefinované jméno a heslo admin uživatele je:
krameriusAdmin
krameriusAdmin
Po prvním spuštění aplikačního serveru s nainstalovanou aplikací Kramerius (pod systémovým uživatelem kramerius4) je v domovském adresáři uživatele kramerius4 vytvořen adresář .kramerius4
a v něm prázdné soubory configuration.properties
, search.properties
,client.properties
, indexer.properties
a migration.properties
. Konfigurační soubory K5 využívají rozšířené syntaxe properties podporované použitou knihovnou Apache commons-configuration. Soubory jsou uspořádány ve dvoustupňové hierarchii: Základní sdílené properties jsou v souboru configuration.properties, jednotlivé plugin moduly externích procesů je pak rozšiřují ve svých konfiguračních souborech (např. migration.properties, indexer.properties). Konfigurační properties specifické pro GUI K5 jsou v souboru search.properties.
Defaultní hodnoty properties (viz níže) jsou definovány uvnitř aplikačního archivu search.war. Hodnoty je možno předefinovat jejich uvedením ve stejně pojmenovaném souboru umístěném v adresáři $USER_HOME/.kramerius4. Tyto konfigurační soubory (prázdné) jsou vytvořeny automaticky při prvním spuštění K5, resp. příslušného externího procesu.
Obsah defaultních hodnot jednotlivých konfiguračních souborů najdete zde:
migration.properties (konverze z K3)
migration.properties (konverze z METS-NDK)
Texty jednotlivých součástí GUI Krameria jsou lokalizovány pomocí standardního mechanismu resource bundle jazyka Java (viz např. http://docs.oracle.com/javase/6/docs/api/java/util/ResourceBundle.html), výchozí obsah lokalizačního souboru labels.properties
je k dispozici zde: labels_cs.properties pro K5
labels_cs.properties pro editor uživatelů
Požadované změny je možno provádět přepsáním hodnoty příslušného klíče v souboru ~/.kramerius4/bundles/labels.properties
, resp. ~/.kramerius4/bundles/labels_cs.properties
.
V případě rozsáhlejších, víceřádkových textů, systém Kramerius disponuje mechanismem zápisu textu do samostatného souboru. Soubory mohou být předefinovány v adresáři ~/.kramerius4/texts
.
-
texts/first_page_nolines_xml
- obsahuje text o nedostupnosti, který se objeví v dialogu při generování PDF i v samotném dokumentu. Implicitně zobrazovaný text je first_page_nolines_xml -
texts/help
- Obsahuje text nápovědy. Pokud není definovaný, zobrazí interní nápovědu Krameria. -
texts/rightMsg
- Obsahuje text o nedostupnosti dokumentu. Pokud není definovaný, zobrazí krátký text zlabels.properties
určený klíčemrightMsg
-
texts/intro
- Obsahuje popisný text o digitální knihovně. Implicitně zobrazovaný text intro. -
texts/k5info
- Obsahuje popisný zobrazovaný v klientské aplikaci. Implicitně zobrazovaný text intro.
Poznámka: V adresáři ~/.kramerius4/texts/
mohou existovat soubory first_page_xml
, first_page_html
, first_page
. Ty od verze 4.6 nejsou potřeba je možno je smazat.
Nově založenému uživateli je aplikací rightseditor přiděleno heslo a zasláno na email. Pro tuto funkci je třeba mít k dispozici SMTP server a do adresáře ~/.kramerius4
přidat soubor mail.properties
s obsahem:
# Mail properties bez SSL
[email protected]
[email protected]
mail.smtp.pass=blablabla
mail.smtp.host=smtp.gmail.com
mail.smtp.port=25
nebo
# Mail properties s podporou SSL
[email protected]
[email protected]
mail.smtp.pass=blablabla
mail.smtp.host=smtp.gmail.com
mail.smtp.port=465
mail.smtp.starttls.enable=true
mail.smtp.auth=true
mail.smtp.socketFactory.port=465
mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
mail.smtp.socketFactory.fallback=false
Text emailu je možné konfigurovat pomocí property mail.message
, předmět pomocí property mail.subject
v lokalizačním souboru labels_en.properties, resp. labels_cs.properties.
Registrační email se konfiguruje obdobně pomocí properties registeruser.mail.subject
a registeruser.mail.message
.
Pokud se login smtp k serveru liší od adresy odesilatele registračního emailu, je možné adresu odesilatele nastavit pomocí property mail.from
. Když není definovaná, použije se login k smtp serveru (z property mail.smtp.user
).
Výchozí hodnoty properties jsou
mail.message=Vážený uživateli systému Kramerius,\n pro Vaše přihlašovací jméno {0} bylo vygenerováno heslo {1}
mail.subject=Vygenerované heslo
registeruser.mail.subject=Aktivace uživatele
registeruser.mail.message=Pro aktivaci uživatele {0} ({1}) je nutné kliknout na následující link {2}
Čísla ve složených závorkách jsou parametry, které budou nahrazeny skutečnými hodnotami proměnných login, heslo , resp login, jméno a potvrzující URL.
Tyto základní atributy uživatelského rozhraní je možno měnit bez zásahu do aplikace změnou konfiguračních souborů uvedených v předchozí sekci [Konfigurace].
Obsah záložky s vybranými položkami i to, které záložky jsou zobrazeny, se nastavuje v souboru ~/.kramerius4/search.properties
Důležité jsou tyto položky:
# Seznam a poradi zalozek
search.home.tabs=custom,mostDesirables,newest,facets,browseAuthor,browseTitle,info,collections,favorites
# Seznam pids (oddelene carkou) objektu, zobrazenych na zalozce custom
search.home.tab.custom.uuids=
(zde stačí doplnit např. uuid:045b1250-7e47-11e0-add1-000d606f5dc6,uuid:0eaa6730-9068-11dd-97de-000d606f5dc6 …)
Obsah záložky informace je možno nahradit souborem ~/.kramerius4/texts/intro
.
Šablona stránek lze měnit pouze přímo jejich editací v rozbalené aplikaci v adresáři tomcat/webapps/search
, důležité jsou zejména adresáře css a img (tam je např. soubor logo.png
).
Případně můžete upravit celé téma UI jQuery takto:
Na strankach jQuery http://jqueryui.com/themeroller/ vytvořte svoje vlastní grafické téma a uložte si jej do příslušného podadresáře v adresáři css,
název css souboru musí být jquery-ui.custom.css
(tj. bez čísla verze).
Mezi tématy můžete přepínat pomocí URL parametru theme
, jehož hodnotou je název podadresáře s tématem.
Chcete-li např. použít předdefinované téma jQuery sunny
, stáhněte a rozzipujete jeho obsah do adresáře webapps/search/css/sunny
. Změňte název css souboru na jquery-ui.custom.css
a vyzkoušejte adresu k4server/search/?theme=sunny
Pokud chcete svoje téma nastavit jako výchozí, v souboru search/inc/html_header.jsp můžete změnit řádek 76, a misto "smoothness" napsat název svého tématu.
(volitelné nastavení)
Kromě standardního zobrazení obrázků v jejich nativním formátu má aplikace Kramerius 5 možnost prezentovat je pomocí integrované prohlížečky Seadragon (http://www.zoom.it). Prohlížečka Seadragon je aktivována pro konkrétní zobrazovaný digitální objekt (například stránku monografie), pokud jeho FOXML definice obsahuje v datastreamu RELS-EXT RDF literál <kramerius4:tiles-url>
. Je možno využít dvě alternativy:
Využít produkt IIP server (http://help.oldmapsonline.org/jpeg2000)
Konfigurace imageserveru je popsána na wiki stránce Konfigurace imageserveru pro podporu IIIF
Zde slouží Kramerius jako prostředník. Klientské dotazy na jednotlivé dlaždice přeposílá IIP serveru a sám se stará pouze o autorizaci požadavku. Hodnotou literálu <kramerius4:tiles-url>
je přímo URL na zoomovaný obrázek v IIP serveru.
Příklady definic v RELS-EXT:
<kramerius4:tiles-url>http://192.168.1.1/fcgi-bin/iipsrv.fcgi?DeepZoom=/mzk03/001/042/654/2619265924.jp2</kramerius4:tiles>
<kramerius4:tiles-url>http://imageserver.mzk.cz/mzk03/001/066/607/2619320306/1</kramerius4:tiles-url>
<kramerius4:tiles-url>http://iipserv.nkp.cz/fcgi-bin/iipsrv.fcgi?Zoomify=/home/k4/iip-data/2619265924.jp2</kramerius4:tiles-url>
Tato interní cache vlastně nahrazuje funkci externího image serveru. V tomto případě je nutné mít v literálu kramerius4:tiles-url mít uvedenou konstantu
kramerius4://deepZoomCache
.
Příklad:
<kramerius4:tiles-url>kramerius4://deepZoomCache</kramerius4:tiles-url>
Pozn.: Je samozřejmě nejdříve nutné cache naplnit a to akcí "Generování Deep Zoom Cache..." v administrátorském menu aplikace Kramerius 5.
Od verze 4.7 je možno volitelně používat buď prohlížečku Seadragon (protokol deepZoom) nebo OpenLayers (protokol zoomify). Výchozí nastavení (OpenLayers) je možno změnit nastavením property zoom.viewer=deepzoom
v souboru search.properties
Upozornění: U verze 4.8 a protokolu deepZoom byla opravena chyba při dotazování dzi deskriptoru. Deskriptor byl dotazován pomocí postfixu url_to_jp2/deepzoom.dzi na misto url_to_jp2.dzi (viz http://iipimage.sourceforge.net/documentation/protocol/). Pokud máte již nastaven mod_url rewriting modul na toto chybné chování, prosím, přenastavte si ho.
(volitelné nastavení)
Jedná se o samstatnou aplikaci. Instaluje se kopírováním souboru client.war na aplikační server (viz instalace Krameria)
Pro spuštění je potřeba upravit soubor client.properties
proměnnou api.point
na hodnotu ${k4.host}/api/v5.0
api.point=${k4.host}/api/v5.0
(volitelné nastavení)
Editor se instaluje jako samostatná webová aplikace nainstalováním souboru editor.war na aplikační server (viz instalace Krameria).
Před spuštěním je potřeba mít nakonfigurován single-sign-on (viz Přístupová práva).
Kramerius umožňuje nahradit tento výchozí editor jiným editorem. To, který editor se spustí z kontextového menu v GUI Krameria, je určeno položkou editorUrl v souboru ~/.kramerius4/configuration.properties
:
editorUrl=${_fedoraTomcatHost}/editor
Volané url z kontextového menu má například takovýto tvar:
http://localhost:8080/editor/?openIDs=uuid:0eaa6730-9068-11dd-97de-000d606f5dc6&locale=en
Případný alternativní editor tedy musí být schopen zpracovat parametry z tohoto URL.
V případě, že je použité jiné neź defaulní heslo je nutné aplikaci editor.war nakonfigurovat.
# editor.properties
k4.editor.user=krameriusAdmin
k4.editor.pswd=*
(volitelné nastavení)
V souborech service_ESEDep.xml
a model_repository.xml
v adresáři fedora
z distribučního souboru installation-x.x.zip
upravte všechna místa označená FIXME
podle vaší konkrétní instalace. Soubory potom nainstalujte jako ostatní FOXML modely do úložiště Fedora Commons.
Vytvořte uživatele proai
a databázi proai
.
Aplikaci OAI Provider naleznete na stránkách Fedora Commons Downloads pro patřičnou verzi Fedory. oaiprovider.zip
obsahuje oaiprovider.war
, který se instaluje na aplikační server. Nejjednodušší je upravit proai.properties
v oaiprovider.war
před instalací.
V nainstalované aplikaci oaiprovider
upravte soubor proai.properties
. Pro Tomcat je to soubor $CATALINA_HOME/webapps/oaiprovider/WEB-INF/classes/proai.properties
.
Jakékoli změny v proai.properties se projeví až po restartu aplikace oaiprovider
(např. Tomcat manager).
Lze použít předpřipravenou šablonu z distribučního souboru installation-x.x.zip/oai/proai.properties
. Obsahuje konfiguraci formátů Dublin Core (oai_dc
), Europeana (ese
) a Registr digitalizace (drkramerius4
). Nutná kontrola URL, uživatelů a hesel podle aktuální instalace Fedory.
Důležitá nastavení:
# Zapnutí/vypnutí hledání dat pro export z Fedory do OAI
proai.driverPollingEnabled = true
# /data/proai obsahuje exportovaná data a nesmí být mazán bez úpravy proai databáze
proai.cacheBaseDir = /data/proai/cache
proai.sessionBaseDir = /data/proai/sessions
proai.schemaDir = /data/proai/schemas
# databáze proai
proai.db.url = jdbc:postgresql://localhost/proai
proai.db.username = proai
proai.db.password = ********
# aplikace Fedora
driver.fedora.baseURL = http://localhost:8080/fedora/
driver.fedora.user = fedoraAdmin
driver.fedora.pass = ********
driver.fedora.identify = http://localhost:8080/fedora/get/model:Repository/Identify.xml
# v případě použití MPT resource indexu
driver.fedora.queryFactory = fedora.services.oaiprovider.MPTQueryFactory
driver.fedora.mpt.jdbc.url = jdbc:postgresql://localhost/riTriples
driver.fedora.mpt.jdbc.user = fedoraAdmin
driver.fedora.mpt.jdbc.password = ********
# definice setů podle datových modelů Krameria
driver.fedora.itemSetSpecPath = $item <info:fedora/fedora-system:def/model#hasModel> $set $set <http://www.openarchives.org/OAI/2.0/setSpec> $setSpec
Popis všech parametrů je na stránkách Fedory.
Ukázka definice formátu ese
pro Europeana.
# seznam formátů
driver.fedora.md.formats = ese
driver.fedora.md.format.ese.loc = http://www.europeana.eu/schemas/ese/ESE-V3.2.xsd
driver.fedora.md.format.ese.uri = http://www.europeana.eu/schemas/ese/
# definice obsahu pro daný formát
driver.fedora.md.format.ese.dissType = info:fedora/*/service:ESEDef/get
Standardní implementace OAI (fedora proai) má bohužel výkonnostní problémy při použití s většími úložišti (desítky milionů dokumentů). Jako alternativní implementace OAI je od verze K5.3.3 k dispozici implementace oai4solr, která pracuje přímo nad daty indexu SOLR. Instalační soubory a popis instalace a konfigurace je k dipozici v modulu installation/oai4solr6 (https://github.com/ceskaexpedice/kramerius/tree/master/installation/oai4solr6) případně https://github.com/ceskaexpedice/kramerius/tree/master/installation/oai4solr7 pro SOLR 7 a vyšší.
Při aktualizaci existující instalace Krameria stačí na aplikační server nainstalovat nové verze souborů *.war
(a případně sdílené knihovny securtiy-core.jar
) z distribučního balíčku Core-x.x.x.tar.gz
a security-core-x.x.x.tar.gz
. Konfiguraci systému a ostatních komponent z balíčku installation-x.x.x.zip
a Editors-x.x.x.zip
není obvykle třeba měnit (pokud u konkrétní verze není uvedeno jinak). Pokud je v distribučním balíčku soubor schema.xml
, nakopírujte jej do adresáře $FEDORA_HOME/solr/conf.
Postup instalace je závislý na konkrétním aplikačním serveru. Pro server Tomcat je vhodné postupovat takto:
- vypněte Tomcat
-
Důležité: smažte rozbalené adresáře
search
,editor
arightseditor
z adresářetomcat/webapps
atomcat/work/Catalina/localhost
- do adresáře
tomcat/webapps
nakopírujte nové verze souborůsearch.war
,editor.war
arightseditor.war
, do adresářetomcat/lib
souborsecurity-core.jar
- restartujte Tomcat
- Klientské systémy (klientská aplikace a administrační aplikace) by měly být provozovány za systémem apache a propojené pomocí
mod_ajp
případněmod_jk
. - Doporučujeme pro provozování systému Kramerius použít protokol
https
.