root/other-projects/trunk/gs3-webservices-democlient/docs/HowToFiles/3InstallingFedora.html @ 15762

Revision 15762, 9.6 KB (checked in by ak19, 11 years ago)

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)

  • 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</title>
6</head>
7<body>
8<a href="index.html">Back to index page</a>
9
10<h1>Installing Fedora (2.2.1/3.0) and Fedora-related information</h1>
11
12<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>
13
14<p>Installation instructions for other versions of Fedora are similar and can be found at:
15<ul>
16<li><a href="http://www.fedora-commons.org/documentation/2.2.2/userdocs/distribution/installation.html">Fedora 2.2.2</a></li>
17<li><a href="http://www.fedora-commons.org/documentation/3.0b1/userdocs/distribution/installation.html">Fedora 3.0</a></li>
18</ul>
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>
20
21
22<h2>Sections</h2>
23<ul>
24<li><a href="#A">A Preliminary Steps</a></li>
25<li><a href="#B">B Installing Fedora 2.2.1</a></li>
26<li><a href="#C">C How to run Fedora (and how to stop it)</a></li>
27<li><a href="#D">D Creating the custom Greenstone 3 pid prefix</a></li>
28<li><a href="#E">E Exporting Greenstone documents into Fedora's repository</a></li>
29<li><a href="#F">F Further Information</a></li>
30</ul>
31
32
33<h2><a name="A">A Preliminary Steps</a></h2>
34<ol>
35<li>You need Greenstone 3.<br />
36Since we will be working with Greenstone 3 documents stored in Fedora's repository as "Fedora Digital Objects", Greenstone 3 is needed for its functionality to convert GS3 documents into FedoraMETS format and put them into the Fedora repository.<br />
37(If you only want a walkthrough on installing Fedora, then you don't need Greenstone 3 of course and can skip the parts of this document relating to that.)</li>
38<li>Fedora 2.2.1 requires Java 5 (I used jdk1.5.0_10).<br /> 
39If you wish to compile it yourself, you will need Apache Ant 1.6.5 and put it on your PATH.</li>
40<li>Defining environment variables. See <a href="http://www.fedora.info/download/2.2.1/userdocs/distribution/installation.html#intro.env">the official instructions</a> for further details on this.
41
42<p>Let's assume that when you have downloaded Fedora 2.2.1 and extracted it (as you will in Section B below), the Fedora executable stuff will go into a folder called "fedora" whose location is /full/path/to/fedora. With that in mind, we need to set the following environment variables:
43<ul>
44<li>JAVA_HOME - set this to the path of your JDK folder</li>
45<li>FEDORA_HOME - set this to the full path to that "fedora" folder just mentioned</li>
46<li>CATALINA_HOME should be set to the /full/path/to/fedora/tomcat folder.</li>
47<li>The PATH variable must contain your JDK 1.5's bin folder, and the 2 bin folders of Fedora: /full/path/to/fedora/server/bin and /full/path/to/fedora/client/bin</li>
48<li>If you plan on compiling it all yourself, have the full paths to Apache Ant 1.6.5 and of your JDK's bin/javac on your PATH.</li>
49</ul>
50
51<p>If you're on <b>Linux</b>, you can set the environment variables by editing your ~/.profile file and then, after saving the edits, logging out or doing a "source ~/.profile" in the x-term.<br />
52For example:
53<pre>
54export JAVA_HOME=/opt/jdk1.5.0_10/
55export FEDORA_HOME=/my/path/to/fedora
56export CATALINA_HOME=$FEDORA_HOME/tomcat
57
58PATH=/opt/jdk1.5.0_10/bin:/opt/jdk1.5.0_10/bin/javac:/my/path/to/apache-ant-1.6.5:$FEDORA_HOME/server/bin:$FEDORA_HOME/client/bin:$PATH
59</pre>
60</p>
61
62<p>On <b>Windows</b>, adjustments to your PATH variable, and creation of new variables (like FEDORA_HOME, CATALINA_HOME, JAVA_HOME) are made by going to: <blockquote>Start > Control Panel > (Performance and Maintenance icon OR click on Switch to Classic View on the left >) System > Advanced tab. Press the Environment Variables button. Add new System Variables and edit the Path variable.</blockquote>
63Note that on Windows, you use the <b>;</b> sign to append new items to your path, and when referring to previously declared environment variables you have to surround them with <b>%</b> signs:
64E.g.
65<pre>PATH=&lt;whatever-was-on-your-path-before&gt;;%FEDORA_HOME%/server/bin</pre>
66</p>
67</li>
68</ol>
69
70<h2><a name="B">B Installing Fedora 2.2.1</a></h2>
71<ol>
72<li>Download Fedora 2.2.1 from <a href="http://www.fedora.info/download/">http://www.fedora.info/download/</a>.<br />
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>.)
74</li>
75<li>Extract it.
76</li>
77<li>Make sure you have the environment variables set as described in Preliminary Steps above.
78In an Linux x-term, move into extracted directory (e.g. fedora-2.2.1-src/) and type in xterm:
79<pre>ant installer</pre>
80Then go into the dist folder of the extraction directory (e.g. fedora-2.2.1-src/dist/) and type:
81<pre>java -jar fedora-2.2.1-installer.jar</pre>
82</li>
83<li>This will run the command-line installer. Choose "quick" installation.
84</li>
85<li>Accept everything as given and set a password for your Fedora Administrator account whose default username is "fedoraAdmin".
86By accepting the defaults, it will the server is set to run on localhost, port 8080 (with shutdown port 8005).
87</li>
88</ol>
89
90<b>You will need to remember the following details of your installation:</b>
91<ul>
92<li>the username for your Fedora account (default would be: fedoraAdmin)</li>
93<li>the password for it (?)</li>
94<li>the host (default would be: localhost)</li>
95<li>the port number (default would be: 8080)</li>
96</ul>
97
98
99<h2><a name="C">C How to run Fedora (and how to stop it)</a></h2> 
100<ol>
101<li>First <b>start</b> up fedora server by typing the following in xterm:
102<pre>$FEDORA_HOME/tomcat/bin/startup.sh</pre>
103
104<li>Point your browser to
105<pre>http://localhost:8080/fedora/</pre> 
106(or
107<pre>http://HOST:PORT/fedora</pre>
108with whatever host and port you chose to install it on).</li>
109
110<li>An authorization dialogue will pop up, asking you to enter the username and password you chose upon installation.</li>
111</ol>
112
113If you ever want to <b>stop</b> the Fedora server, you will need to type in the X-term
114<pre>$FEDORA_HOME/tomcat/bin/shutdown.sh</pre>
115
116
117<h2><a name="D">D Creating the custom Greenstone 3 pid prefix</a></h2>
118In order to work with the Greenstone3 client application, you will need to create a custom pid prefix for Greenstone 3 in fedora, and call it "greenstone".<br />
119To do this, you will need to:
120
121<ol>
122<li>Shutdown the fedora server
123<pre>$FEDORA_HOME/tomcat/bin/shutdown.sh</pre>
124</li>
125<li>Open up fedora's configuration file in a text editor
126<pre>$FEDORA_HOME/server/config/fedora.fcfg</pre>
127</li>
128<li>Go down to where it says:
129<pre>&lt;param name="retainPIDs" value="demo test changeme fedora-bdef fedora-bmech tutorial"&gt;</pre>
130And append greenstone to the list of values, so you get something like:
131<pre>&lt;param name="retainPIDs" value="demo test changeme fedora-bdef fedora-bmech tutorial greenstone"&gt;</pre>
132</li>
133<li>Restart the fedora server
134<pre>$FEDORA_HOME/tomcat/bin/startup.sh</pre>
135</li>
136</ol>
137
138<p>Having made the change in the fedora config file, it will now recognise "greenstone" as a valid PID and allow you to create/ingest digital data objects with a pid where the prefix is "greenstone".<br />
139For more information, you may want to look at the <a href="http://www.fedora.info/release/1.1/userdocs/distribution/release-notes.html">Fedora Release Notes</a>:
140<blockquote>"PID generation has been activated. Upon ingestion, Fedora objects that pass validation are automatically assigned a unique persistent identifer or PID. The namespace prefix on the PID is determined by the namespace parameter in the fedora.cfg configuration file."</blockquote></p>
141
142
143<h2><a name="E">E Exporting Greenstone documents into Fedora's repository</a></h2>
144<p>There is nothing in our Fedora repository yet. We want to have Greenstone 3 documents exported into Fedora format stored here. This is what we need Greenstone 3 for. We will be using its functionality for converting Greenstone 3 docs into FedoraMETS and exporting them into Fedora.</p>
145Use the FLI&mdash;Fedora Librarian Interface&mdash;application to do this. Refer to the document <a href="8RunFedoraLibrarianInterface.html">Running FLI</a> for information on how to do this.
146
147
148<div style="display:none">
149<p>http://trac.greenstone.org/browser/gsdl/trunk/bin/script/g2f-buildcol.pl<br />
150http://trac.greenstone.org/browser/gsdl/trunk/bin/script/g2f-import.pl<br />
151Greenstone to Fedora scripts. Similar to import.pl and buildcol.pl, g2f-import.pl first converts documents into FedoraMETS and then g2f-buildcol.pl ingests them into a Fedora repository. Needs to have FEDORA_HOME set.</p>
152</div>
153
154
155<h2><a name="F">F Further Information</a></h2>
156<ul>
157<li>To run the Fedora-client application, you would type
158<pre>cd $FEDORA_HOME/client
159fedora-admin.sh
160</pre>
161</li>
162<li>The location of the <b>Fedora Basic Search Interface</b> ("REST interface" as it uses Fedora's URL-based web services) is
163<pre>http://HOST:PORT/fedora/search</pre>
164where HOST and PORT depend on what you chose when you installed it. E.g. http://localhost:8080/fedora/search<br />
165Note that the default search functionality that Fedora's own access web services (API-A) provide do not include full-text indexing and searching.
166</li>
167<li>To install <b>Fedora Generic Search</b>&mdash;which provides full-text indexing and search capabilities for content stored in a Fedora repository&mdash;see the document <a href="4InstallingFedoraGSearch.html">Installing Fedora Generic Search</a>.
168</li>
169</ul>
170
171</body>
172</html>
Note: See TracBrowser for help on using the browser.