root/other-projects/trunk/gs3-webservices-democlient/docs/HowToFiles/4InstallingFedoraGSearch.html @ 15486

Revision 15486, 4.3 KB (checked in by ak19, 12 years ago)

Now it tells users to bear in mind what index name they choose when installing FedoraGSearch

  • Property svn:executable set to *
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3<html>
4<head>
5<title>Installing Fedora Generic Search</title>
6</head>
7<body>
8<a href="index.html">Back to index page</a>
9
10<h1>Installing Fedora Generic Search</h1>
11In this document,
12<ul>
13<li>$FEDORA_HOME refers to the full path to your Fedora installation directory.<br /> </li>
14<li>For a walkthrough on installing Fedora (and for links to the official Fedora instructions for installation) see <a href="3InstallingFedora.html">Installing Fedora</a>.</li>
15</ul>
16
17
18<ol>
19<li><a href="http://drama.ramp.org.au/cgi-bin/trac.cgi/wiki/InstallingFedoraGSearch">The detailed installation instructions</a> which I followed were written by the Muradora team.<br />
20Make sure that upon installing Fedora Generic Search, you either
21<ul>
22<li>choose to call your index <b>FedoraIndex</b> since this is what the demo-client expects by default, or</li>
23<li>create a file called gs3democlient.properties in the same folder as where the demo-client executable is, unless such a file already exists. Then in that properties file, write down the name of your index for the property <i>gsearch.indexName</i> as follows:
24<pre>gsearch.indexName=your-fedora-index-name</pre>
25If you had to create the properties file, you'd have to create this property as well. But if the file already existed, then the property <i>gsearch.indexName</i> would have been in there and you need only adjust the index name it is set to to your own.</li>
26</ul>
27</li>
28
29<li>Once installed, the FedoraGSearch rest url will by default be at:
30<pre>http://localhost:8080/fedoragsearch/rest</pre>
31</li>
32
33<li>Next to the steps above, you will need to make some more changes in order to enable full-text indexing and searching of the Greenstone documents ingested into the Fedora repository.
34<ol style="list-style-type:lower-alpha"> 
35<li>Open the file:
36<pre>$FEDORAHOME/tomcat/webapps/fedoragsearch/WEB-INF/classes/config/index/demoFoxmlToLucene.xslt</pre>
37At present, Muradora's file allows all digital objects in your Fedora repository to be indexed and searchable. If you're alright with indexing just the Greenstone documents stored in Fedora's repository, then we'll add the following to the above file:
38<pre>   &lt;xsl:if test="starts-with($PID,'greenstone')"&gt;
39    ...
40    &lt;/xsl:if&gt;
41</pre>
42So that now the file contains:
43<pre>&lt;xsl:if test="foxml:digitalObject/foxml:objectProperties/foxml:property[@NAME='http://www.w3.org/1999/02/22-rdf-syntax-ns#type' and @VALUE='FedoraObject']"&gt;
44  <b>&lt;xsl:if test="starts-with($PID,'greenstone')"&gt; // ADDED THIS</b>
45     &lt;!--    filter out annotations: --&gt;
46     &lt;!--
47        &lt;xsl:choose&gt;
48        &lt;xsl:when test="foxml:digitalObject/foxml:datastream/foxml:datastreamVersion[last()]/foxml:xmlContent/rdf:RDF/rdf:Description/rel:isMemberOf[@rdf:resource='info:fedora/mura:annotations']"&gt;
49        &lt;/xsl:when&gt; // CORRECTED typo in this comment
50        &lt;xsl:otherwise&gt;
51     --&gt;
52    &lt;xsl:apply-templates mode="activeDemoFedoraObject"/&gt;
53     &lt;!--
54        &lt;/xsl:otherwise&gt;
55        &lt;/xsl:choose&gt;
56     --&gt;
57  <b>&lt;/xsl:if&gt; // ADDED THIS</b>
58&lt;/xsl:if&gt;
59</pre>
60</li>
61
62<li>In the file
63<pre>
64$FEDORAHOME/tomcat/webapps/fedoragsearch/WEB-INF/classes/config/index/index.properties</pre>
65we're going to add fulltext (and label) to the list of fields that are indexed and are therefore searchable. We do this by appending
66<pre>
67ds.fulltext ds.label
68</pre>
69So that it now becomes:
70<pre>fgsindex.defaultQueryFields = dc.description dc.title dc.creator dc.identifier ds.fulltext ds.label</pre>
71The field ds.label and a document's full-text can now be searched and will appear in the search results. (Only a customisable snippet-size of a document's full-text will present in the results of a search.)
72</li>
73
74<li>Finally, <b>an important note:</b> Fedora Generic Search only supports indexing and searching Fedora Digital Objects (Fedora repository contents) whose MIME-type is one of
75<ul>
76<li>text/html</li>
77<li>text/plain</li>
78<li>application/pdf</li>
79</ul>
80Text/xml is not accepted. (Therefore Greenstone documents exported to FedoraMETS and ingested into Fedora must be of one of the above MIME-types, else they will not be indexed by Fedora Generic Search.) 
81</li>
82</ol>
83</li>
84</ol>
85
86</body>
87</html>
Note: See TracBrowser for help on using the browser.