Changeset 15762

Show
Ignore:
Timestamp:
28.05.2008 15:40:06 (11 years ago)
Author:
ak19
Message:

Updates - since FLI has now been tested on Windows and the demo-client has been tested against Fedora 3.0 (updates also include how to use GSearchInstaller)

Location:
other-projects/trunk/gs3-webservices-democlient/docs/HowToFiles
Files:
3 modified

Legend:

Unmodified
Added
Removed
  • other-projects/trunk/gs3-webservices-democlient/docs/HowToFiles/3InstallingFedora.html

    r15391 r15762  
    88<a href="index.html">Back to index page</a> 
    99 
    10 <h1>Installing Fedora 2.2.1 and Fedora-related information</h1> 
     10<h1>Installing Fedora (2.2.1/3.0) and Fedora-related information</h1> 
    1111 
    1212<p>Here, we're following <a href="http://www.fedora.info/download/2.2.1/userdocs/distribution/installation.html">the official Fedora instructions for installing Fedora 2.2.1</a></p> 
    1313 
    14 <p>(Installation instructions for other versions of Fedora:  
     14<p>Installation instructions for other versions of Fedora are similar and can be found at:  
    1515<ul> 
    1616<li><a href="http://www.fedora-commons.org/documentation/2.2.2/userdocs/distribution/installation.html">Fedora 2.2.2</a></li> 
    1717<li><a href="http://www.fedora-commons.org/documentation/3.0b1/userdocs/distribution/installation.html">Fedora 3.0</a></li> 
    1818</ul> 
    19 We've not tried using these later versions with the GS3 web services demo-client application yet.)</p> 
    20  
    21 <p>I've not installed Fedora on Windows, and I've only tried working with 2.2.1 so far. But Fedora's own installation instructions refer to how to get it working on Windows. The procedure seems to be pretty much similar.</p> 
     19I've now tested Fedora 2.2.1 and Fedora 3.0 with the GS3 web services demo-client application, where Fedora 2.2.1 was installed on Linux and Fedora 3.0 on Windows.</p> 
    2220 
    2321 
     
    7371<ol> 
    7472<li>Download Fedora 2.2.1 from <a href="http://www.fedora.info/download/">http://www.fedora.info/download/</a>.<br /> 
    75 (Although I've not tried it, you could also try Fedora 2.2.2 or even Fedora 3 which are available from <a href="http://www.fedora-commons.org/developers/index.php">the Fedora Commons main page</a>) 
     73(Although I've not tried it, you could also try Fedora 2.2.2 or even Fedora 3 which are available from <a href="http://www.fedora-commons.org/developers/index.php">the Fedora Commons main page</a>.) 
    7674</li> 
    7775<li>Extract it. 
  • other-projects/trunk/gs3-webservices-democlient/docs/HowToFiles/4InstallingFedoraGSearch.html

    r15486 r15762  
    99 
    1010<h1>Installing Fedora Generic Search</h1> 
     11<h2>Sections</h2> 
     12<ul> 
     13<li><a href="#A">A Using the GSearchInstaller</a></li> 
     14<li><a href="#B">B Manual Installation</a></li> 
     15<li><a href="#C">C Important Notes</a></li> 
     16</ul> 
     17 
     18<p>Fedora Generic Search (Fedora GSearch) provides full-text indexing and searching for Fedora. This functionality is not offered by Fedora out-of-the-box, which is why it's a good idea to install Fedora GSearch alongside it.</p> 
     19 
    1120In this document, 
    1221<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> 
     22<li>$FEDORA_HOME refers to the full path to your Fedora installation directory.</li> 
     23<li>You need to have Fedora installed in order to install Fedora Generic Search.<br /> 
     24For a walkthrough on installing Fedora (and for links to the official Fedora instructions for installation) see <a href="3InstallingFedora.html">Installing Fedora</a>.</li> 
    1525</ul> 
    1626 
    1727 
     28This document describes <b>two ways</b> in which you can install Fedora Generic Search: 
     29<ul> 
     30<li>By downloading Muradora's version of the fedoragsearch.war file and then using the GSearchInstaller application, or</li> 
     31<li>by doing the same steps manually.</li> 
     32</ul> 
     33See also the final section containing <a href="#C">Important Notes</a>. 
     34 
     35<h2><a name="A">A Using the GSearchInstaller</a></h2> 
     36You will need Java 1.5 or higher, which would also have been required to install Fedora itself. 
    1837<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 /> 
    20 Make 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> 
    25 If 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> 
     38<li>Download <a href="http://drama.ramp.org.au/software/fedoragsearch.war">Muradora's version of fedoragsearch.war</a>.</li> 
     39<li>Download the GSearchInstaller.jar from the same place where you got the GS3 Web Services Demo-Client (GSearchInstaller.jar is part of the GS3 Web Services Demo-Client distribution file).</li> 
     40<li>In a Linux x-term or a Windows DOS prompt, go to the location where your GSearchInstaller.jar is located, and type 
     41<pre>java -jar GSearchInstaller.jar</pre> 
     42This will launch the installer's opening dialog.<br /> 
     43(It is recommended that Windows users don't just double-click on the jar file as the application's output will indicate whether and where anything failed during installation. This output is sent to the DOS console which won't be there if you run the jar-file by double-clicking.)</li> 
     44<li>Type in your Fedora server host, port, username and password. Then choose a name for the Fedora GSearch index and repository. (By default, the GS3 Web Services Demo-Client application expects the index name to be <i>FedoraIndex</i>. If you choose something other than FedoraIndex as the index name, follow the steps in <a href="#C">Important Note #2</a>.) Finally, browse to the location of your Muradora fedorgsearch.war file.<br /> 
     45<b>Note:</b> GSearchInstaller can also be run from the command-line, by passing command-line arguments to GSearchInstaller.jar. To find out what the accepted arguments are, run it with the -help flag: 
     46<pre>java -jar GSearchInstaller.jar -help</pre> 
    2747</li> 
     48<li>It will take a little while to run, and if nothing went wrong, it will have installed Fedora Generic Search and indexed the <a href="8RunFedoraLibrarianInterface.html">Greenstone documents that were ingested into Fedora using FLI</a>.</li> 
     49</ol> 
    2850 
    29 <li>Once installed, the FedoraGSearch rest url will by default be at:  
    30 <pre>http://localhost:8080/fedoragsearch/rest</pre> 
    31 </li> 
     51<h2><a name="B">B Manual Installation</a></h2> 
     52<ol> 
     53<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.</li> 
    3254 
    3355<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. 
     
    7193The 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.)  
    7294</li> 
     95</ol> 
     96</li> 
     97</ol> 
    7398 
    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 
     99<h2><a name="C">C Important notes</a></h2> 
     100<ol> 
     101<li>Once installed, the FedoraGSearch rest url will by default be at:  
     102<pre>http://localhost:8080/fedoragsearch/rest</pre> 
     103If you visit this page, there are links to doing searches and browsing the Fedora repository's full-text contexts.</li> 
     104<li>Make sure that upon installing Fedora Generic Search (whether using GSearchInstaller or installing manually), you either: 
     105<ul> 
     106<li>choose to call your index <b>FedoraIndex</b> since this is what the demo-client expects by default, or</li> 
     107<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: 
     108<pre>gsearch.indexName=your-fedora-index-name</pre> 
     109If 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> 
     110</ul> 
     111</li> 
     112 
     113<li><b>IMPORTANT:</b> Fedora Generic Search only supports indexing and searching Fedora Digital Objects (Fedora repository contents) whose MIME-type is one of 
    75114<ul> 
    76115<li>text/html</li> 
     
    78117<li>application/pdf</li> 
    79118</ul> 
    80 Text/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.)   
     119Text/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.) <br /> 
     120At present, FLI sets the content-type of the Fedora METS documents it exports to being text/xml. Therefore these documents don't yet get indexed by Fedora Generic Search. In order to do that, you need to use <i>Fedora</i>'s Admin-Client application to change the content-type for the documents FLI puts into Fedora from text/xml to text/html. 
    81121</li> 
    82122</ol> 
    83 </li> 
    84 </ol> 
    85  
    86123</body> 
    87124</html> 
  • other-projects/trunk/gs3-webservices-democlient/docs/HowToFiles/8RunFedoraLibrarianInterface.html

    r15398 r15762  
    2626<li>fli.sh launches a modified gli.sh. But fli.bat launches gli.bat which has yet to be edited to work for both gs3 and gs2. In other words, at present the Windows fli.bat should be used when working with Greenstone 2, and fli4gs3.bat when working with Greenstone 3. 
    2727</li> 
    28 <li>You need the Greenstone server to be running on the same machine as where your Fedora machine is running. This <i>may</i> not be a requirement in the future.</li> 
     28<li>You need the Greenstone server to be running on the same machine as where your Fedora machine is running. This <i>may</i> not be a requirement in the future, but it is at present.</li> 
    2929</ul> 
    3030 
     
    3232<ul> 
    3333<li>You need Greenstone 2 or 3</li> 
    34 <li>You need Fedora installed (which would have required you to set the environment variables FEDORA_HOME, CATALINA_HOME and JAVA_HOME). And: 
     34<li>You need Fedora installed (which would have required you to set the environment variables FEDORA_HOME, CATALINA_HOME and JAVA_HOME, which are also needed by FLI). And: 
    3535<ul> 
    3636<li>if the version you have installed is Fedora 2.*, then you need to add a new environment variable called FEDORA2_HOME to point to where you have Fedora 2.* installed.  
     
    4040</ul> 
    4141</li> 
    42 <li>You need the Greenstone server running on the same machine as where you're Fedora server is installed.</li> 
     42<li>You need the Greenstone server running on the same machine as where your Fedora server is installed.</li> 
    4343</ul> 
    4444 
     
    5757If you're on Windows, go into Greenstone's gli folder and double-click on fli.bat 
    5858</li> 
    59 <li>Once FLI starts up, it will ask you to the Fedora server details and your Fedora username and password to access the Fedora repository.</li> 
     59<li>Once FLI starts up, it will ask you the Fedora server details and your Fedora username and password to access the Fedora repository.</li> 
    6060<li>Drag and drop documents into a collection as before, go to the Build tab and press the Build button. Once the building is finished, pressing the preview button will open the browser onto the Fedora search page.  
    6161</li>