root/other-projects/trunk/gs3-webservices-democlient/docs/HowToFiles/8RunFedoraLibrarianInterface.html @ 15390

Revision 15390, 4.6 KB (checked in by ak19, 12 years ago)

Added HTML document on How to run FLI

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3<html>
4<head>
5<title>Running FLI, the Fedora Librarian Interface</title>
6</head>
7<body>
8<a href="index.html">Back to index page</a>
9
10<h1>Running FLI, the Fedora Librarian Interface</h1>
11
12<h2>Sections</h2>
13<ul>
14<li><a href="#A">A The purpose of FLI</a></li>
15<li><a href="#B">B Some limitations</a></li>
16<li><a href="#C">C Prerequisites for running FLI</a></li>
17<li><a href="#D">D Running FLI</a></li>
18</ul>
19
20
21<h2><a name="A">A The purpose of FLI</a></h2>
22<p>FLI is built on top of GLI. Just as with GLI, it allows you to drag-and-drop documents into a collection which it will then build. The building process of FLI is different in that it will export the documents into a Fedora repository.</p>
23
24<h2><a name="B">B Some limitations</a></h2>
25<ul>
26<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.
27</li>
28<li>You need the Greenstone server to be running on the same machine as where your Fedora machine is running. This may not be a requirement in the future.</li>
29<li>fli.sh will at present put documents into the Fedora repository if Greenstone is running locally to FLI (as opposed to a remote Greenstone server). It's the intention to fix this discrepancy soon. But if you want an immediate solution, what you need to do is:
30<ul>
31<li>Stop the fedora server</li>
32<li>Go to $FEDORA_HOME/tomcat/conf/Catalina/<your-fedora-host-name or localhost>/
33(where $FEDORA_HOME is your Fedora installation folder)
34Finding out what the last folder should be is tricky, but if you look inside $FEDORA_HOME/tomcat/conf/Catalina/, there should already be a folder with the required fedora hostname.
35</li>
36<li>Create a file containing this XML:
37<pre>&lt;?xml version='1.0' encoding='utf-8'?&gt;
38&lt;Context docBase="/full/path/to/parent/folder/of/greenstone/collectdir" path="/gsdl"&gt;&lt;/Context&gt;
39</pre>
40Where this would be $GSDLHOME/web/sites/localsite for Greenstone 3, and just plain $GSDLHOME for Greenstone 2. (Note that in both cases, it has to be the full path to the parent directory of the "collect" directory.)
41</li>
42<li>Restart the fedora server
43</li>
44<li>Now you can run FLI as described below.</li>
45</ul>
46</li>
47</ul>
48
49<h2><a name="C">C Prerequisites for running FLI</a></h2>
50<ul>
51<li>You need Greenstone 2 or 3</li>
52<li>You need Fedora installed (which would have required you to set the environment variables FEDORA_HOME, CATALINA_HOME and JAVA_HOME). And:
53<ul>
54<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.
55</li>
56<li>if you have Fedora 3.* installed, then you have to add a new environment variable called FEDORA3_HOME to point to where you have it installed.
57</li>
58</ul>
59</li>
60<li>You need the Greenstone server running on the same machine as where you're Fedora server is installed.</li>
61</ul>
62
63<h2><a name="D">D Running FLI</a></h2>
64<ul>
65<li>If you have more than one Greenstone installed (Greenstone 2 and Greenstone 3), then first run the setup file for the Greenstone installation you want to use, so that your Greenstone environment is set up.<br /> 
66If you were on linux, you would have to source the setup scripts by going into the Greenstone installation directory and typing
67<pre>source setup.bash</pre>
68if it is Greenstone 2.
69And
70<pre>source gs3-setup.sh</pre>
71if it is Greenstone 3.<br />   
72If you're on Windows you would run setup.bat in the Greenstone 2 folder or gs3-setup.bat in the Greenstone 3 folder.
73</li>
74<li>If you're using a Linux xterm, you'd go into Greenstone's gli folder and type:
75<pre>./fli.sh</pre>
76If you're on Windows, go into Greenstone's gli folder and double-click on fli.bat
77</li>
78<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>
79<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.
80</li>
81<li><i>If</i> you have other digital objects in your Fedora repository besides the content generated by Greenstone, you will have to type
82<pre>"greenstone:*"</pre>
83or just
84<pre>"greenstone*"</pre>
85in the search box&mdash;with the quotes.<br />
86If your Fedora repository only contains documents built in FLI, then pressing just the search button should be fine.
87</li>
88</ul>
89
90</body>
91</html>
Note: See TracBrowser for help on using the browser.