Difference between revisions of "DiscoverEd Quickstart"

From Creative Commons
Jump to: navigation, search
(Getting Started)
Line 11: Line 11:
 
</pre>
 
</pre>
  
The script will check for dependencies, build DiscoverEd, and launch a J2EE server with the software.
+
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.
  
 
=== What does the script do? ===
 
=== What does the script do? ===
  
 
* Install the DiscoverEd code in <tt>./discovered</tt> (relative to the working directory)
 
* Install the DiscoverEd code in <tt>./discovered</tt> (relative to the working directory)
* Create a <tt>discovered</tt> database (the default configuration is for MySQL)
+
* Create a Derby database in the <tt>db</tt> directory
 
* Add a sample curator, and a sample feed
 
* 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 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:
  
* Download a copy of the excellent web server Tomcat in the same directory
+
* Launch an included copy of Jetty
* Run that copy of Tomcat
 
 
* Open the search engine in Firefox
 
* Open the search engine in Firefox
  
Line 33: Line 33:
 
== Controlling the Installation ==
 
== Controlling the Installation ==
  
The script has several variables which control its behavior, including the install location (<tt>DISCOVER_ED_ROOT</tt>) and database name (<tt>DED_DB_NAME</tt>).
+
The script has several variables which control its behavior, including the install location (<tt>DISCOVER_ED_ROOT</tt>).
  
 
If you need more control (or are using this in production), you'll probably want to do a '''[[DiscoverEd/Install manually|manual installation]]'''.
 
If you need more control (or are using this in production), you'll probably want to do a '''[[DiscoverEd/Install manually|manual installation]]'''.

Revision as of 00:23, 17 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 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 "DiscoverEd", but which is colored and laid-out incorrectly. The text of the results won't display. (We're working on it.)

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.