DiscoverEd Quickstart: Difference between revisions

Latest revision as of 06:01, 21 August 2010

Getting Started

Run these commands to download a quickstart script.

cd /tmp/ # As good a place as any
wget http://gitorious.org/discovered/repo/blobs/raw/master/gimme-discovered
bash gimme-discovered

The script will check for dependencies, build DiscoverEd, perform a small crawl, and launch a J2EE server (Jetty) with the software.

What does the script do?

Install the DiscoverEd code in ./discovered (relative to the working directory)
Create a Derby database in the DISCOVERED_DB directory
Add a sample curator, and a sample feed
Aggregate the resources listed in that feed
Perform a simple crawl
Run a test search for the term "christianity", and print the results to your terminal

The above steps use the search engine without using a web browser. To make it all work in your web browser, the script will then do the following:

Launch an included copy of Jetty
Open the search engine in Firefox

What you should expect to see

This is a development branch. What you'll see is a search engine that says "Nutch".

Controlling the Installation

The script has several variables which control its behavior, including the install location (DISCOVER_ED_ROOT).

If you need more control (or are using this in production), you'll probably want to do a manual installation.

@@ Line 1: / Line 1: @@
 [[Category:DiscoverEd]]
-== How to install DiscoverEd ==
+== Getting Started ==
-. Run these commands to download a quickstart script.
+Run these commands to download a quickstart script.
-<pre style='margin: 0 0 2em 2em; line-height: 140%;'>
+<pre style='margin: 0 0 2em 2em; line-height: 160%;'>
 cd /tmp/ # As good a place as any
-wget http://gitorious.org/discovered/repo/blobs/raw/deploy_script/gimme-discovered
+wget http://gitorious.org/discovered/repo/blobs/raw/master/gimme-discovered
+bash gimme-discovered
 </pre>
-. Edit the script and change <tt>MYSQL_ROOT_PASSWORD</tt> to the right thing.
+The script will check for dependencies, build DiscoverEd, perform a small crawl, and launch a J2EE server ([http://en.wikipedia.org/wiki/Jetty_(web_server) Jetty]) with the software.
-. Run this command to execute the script.
-<pre style='margin: 0 0 2em 2em;'>
-bash gimme-discovered
-</pre>
 === What does the script do? ===
-This will do a few things:
+* Install the DiscoverEd code in <tt>./discovered</tt> (relative to the working directory)
-* Install the DiscoverEd code in <tt>/var/lib/discovered/</tt>
+* Create a Derby database in the <tt>DISCOVERED_DB</tt> directory
 * Add a sample curator, and a sample feed
-* Download the web pages linked to by that feed
+* Aggregate the resources listed in that feed
-* Run a test search for the term "crime", and print the results to your terminal
+* Perform a simple crawl
+* Run a test search for the term "christianity", and print the results to your terminal
+The above steps use the search engine without using a web browser. To make it all work in your web browser, the script will then do the following:
-The above steps are performed by DiscoverEd. Next, we install a copy of the excellent web server Tomcat, which will allow to you perform searches through your web browser. So the script will do a few more things:
+* Launch an included copy of Jetty
-* Install a copy of the excellent web server Tomcat in the same place
-* Run that copy of Tomcat
 * Open the search engine in Firefox
-== Or do it manually ==
+=== What you should expect to see ===
+This is a development branch. What you'll see is a search engine that says "Nutch".
+== Controlling the Installation ==
+The script has several variables which control its behavior, including the install location (<tt>DISCOVER_ED_ROOT</tt>).
-See '''[[DiscoverEd/Install manually]]'''.
+If you need more control (or are using this in production), you'll probably want to do a '''[[DiscoverEd/Install manually|manual installation]]'''.