Apache Slr fr FSI SERVER User Manual Versin 4.5
Apache Slr fr FSI Server NeptuneLabs GmbH Lagesche Str. 32 D-32657 Lemg Germany 2009-2015 NeptuneLabs. All rights reserved. Last updated: Nvember 2013 FSI Server Versin: 3.0 Apache Slr Versin: 4.5 Manual Revisin: 002 All brands and prduct names are trademarks r registered trademarks f the respective prducers. FSI Viewer, FSI Server and NeptuneLabs are registered trademarks f NeptuneLabs GmbH, Germany. Apache, Apache Slr, and Slr are trademarks f The Apache Sftware Fundatin. N endrsement by The Apache Sftware Fundatin is implied by the use f these marks.
FSI Server 3 uses Apache Slr as a database t allw searching in asset metadata. The Slr server is nt embedded in FSI Server as the database was in FSI Server versins 1 and 2. If yu require searching, fr example in FSI Pages r FSI Pages mbile, then yu will have t prvide a Slr instance fr FSI Server t use. This dcument will assist yu in setting up a new Slr server r cnfiguring an existing Slr server t wrk with FSI Server. If yu are running FSI Server n Micrsft Windws and have installed it using the Windws installer versin frm the FSI Viewer website then the Slr server is autmatically installed tgether with FSI Server, FSI Administratr and FSI Cache. In that case the setup instructins are nt relevant fr yur installatin. If yu are already familiar with Slr and want t use an existing Slr instance fr yur FSI Server, then yu can skip sectins I and II. 1.1 What is Slr? Slr is an enterprise search platfrm develped at the Apache Fundatin. Slr is pen surce and written in Java. It runs as a standalne full-text search server within a servlet cntainer like Apache Tmcat. Slr is based n Apache Lucene and prvides a REST- like API t update and query data, allwing client develpment in almst any prgramming language. 1.2 Setting up Slr fr FSI Server Fr yur cnvenience NeptuneLabs has packaged a precnfigured Slr server which can be dwnladed frm the FSI Viewer website at http://www.fsiviewer.cm. This minimizes the installatin effrts and allws an easy installatin even fr unexperienced users. This package is a web archive (war) just like the FSI Server and can therefre simple be deplyed in an arbitrary tmcat instance. As FSI Server and Slr/Lucene are bth memry critical applicatins they shuld nt be deplyed under the same JVM ther than fr testing. IMPORTANT: Fr prductin envirnments it is highly recmmended t deply theslr package in an wn Tmcat/JVM instance. In high lad envirnments yu shuldcnsider installing the Slr instance n separate hardware. As mentined abve the Slr server frm the FSI Viewer website is precnfigured, meaning the cre used by FSI Server is already installed and activated with the crrect cnfiguratin and schema. By default the data itself will be saved within the servlet cntext, just like FSI Servers internal strage yu shuld cnsider relcating this t a different directry. The fllwing steps will lead thrugh the installatin f NeptuneLabs - Slr fr FSI Server 3
Slr using thepackage prvided by NeptuneLabs and will enable the Search in FSI Server. 1. Dwnlad the Slr Package (slr.war) frm http://www.fsi-viewer.cm 2. Deply Slr Cpy the dwnladed war-file t the Tmcats webapps directry. 3. Cnfigure access restrictins t the Slr server By default access t the Slr server is limited t cnnectins frm lcal ip addresses. If yu are installing the package n a different machine, then yu will have t disable this limitatin by cmmmenting ut the Valve cnfiguratin in webapps/slr/meta-inf/cntext.xml The access t the Slr server is nt restricted t a specified user, but shuld be when the abve limitatin is remved. T enable this security feature,please uncmment the "security cntraint" and the "lgincnfig" blcks in webapps/web-inf/web- xml and add an apprpriate user t yur Tmcat installatin, e.g. by adding the fllwing lines t yur tmcat-users.xml: <tmcat-users> <rle rlename="slr_user"/> <user username="fsi" passwrd="mypasswrd" rles="slr_ user"/> </tmcat-users> 4. Enable the search in FSI Server Set the "enabled" attribute f the "search" sectins t true in the surcemanager.xml and requestprcessr.xml and set the lgin credentials accrding t the previus step if required. r: Lg in t FSI Administratr, navigate t yur FSI Server and enable the search sectins in the Request Prcessr Settings and the Surce Manager Settings screens. Cnfigure lgin credentials if required. 5. Wait fr the FSI Server t finish the autmatic build f the search database. 4 NeptuneLabs - Slr fr FSI Server
1.3 Cnfiguring an exisiting Slr server Presuming that yu have a running Slr server and als have sme experience administrating a Slr server. If that is the case, yu can create a new Slr cre using the files frm the cntrib directry in yur FSI Server deplyment and enable the search in FSI Server as described in step 4 f the previus chapter Setting up Slr fr FSI Server. NeptuneLabs - Slr fr FSI Server 5
Apache Slr fr FSI Server NeptuneLabs GmbH Lagesche Str. 32 32657 Lemg Germany Fn: +49 5261-28732-0 Fax: +49 5261-28732-29 email: http: inf@neptunelabs.cm www.neptunelabs.cm www.fsi-server.cm N part f this manual, including the sftware described in it, may be reprduced, transmitted, transcribed, stred in a retrieval system, r translated int any language in any frm r by any means, except dcumentatin kept by the purchaser fr backup purpses, withut the express written permissin f NeptuneLabs. Specificatins and infrmatin cntained in this manual are furnished fr infrmatinal use nly and are subject t change at any time withut ntice, and shuld nt be cnstrued as a cmmitment by NeptuneLabs. NeptuneLabs assumes n respnsibility r liability fr any errrs r inaccuracies in this manual, including the sftware described in it. 2009-2015 NeptuneLabs GmbH, Germany. All rights reserved.
www.fsi-viewer.cm NeptuneLabs GmbH Lagesche Str. 32 32657 Lemg Germany fn: + 49 5261-28732- 0 fax: + 49 5261-28732- 29 inf@neptunelabs.cm www.neptunelabs.cm