Add root HTML file providing brief description and links to documenta…

…tion Update README adding setup instructions for webapp Resolves https://www.pivotaltracker.com/story/show/55768810
fcrepo4-archive · Sep 28, 2013 · cd54fd8 · cd54fd8
1 parent 6b0a785
commit cd54fd8
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,15 @@ This is a fcrepo 4.x indexer that listens to the Fedora JMS topic, retrieves the
 
 ## Running the indexer
 
-We should have both a stand-alone mode where the indexer is run separately from the repository, and a bundled mode where the indexer is deployed with the repository.
+In the simplest case, the indexer can be configurd in the same container as the repository.   See [kitchen-sink/fuseki](https://github.com/futures/fcrepo-kitchen-sink/tree/fuseki) for an example of this configuration.
+
+For production deployment, it is more typical to run the indexer on a separate machine.  So we also have a stand-alone mode where the indexer is run as its own webapp:
+
+```xml
+$ git clone https://github.com/futures/fcrepo-jms-indexer-pluggable.git
+$ cd fcrepo-jms-indexer-pluggable/fcrepo-jms-indexer-webapp
+$ mvn -D jetty.port=9999 install jetty:run
+```
 
 ## Configuring the indexer
 
@@ -75,12 +83,12 @@ Currently, the tests work with either Jena Fuseki or Sesame triplestores/SPARQL
 ### Fuseki
 Fuseki is the easiest to setup -- just download it from http://www.apache.org/dist/jena/binaries/, unpack and start ```fuseki-server```:
 
-    ``` sh
-    curl -O http://www.apache.org/dist/jena/binaries/jena-fuseki-0.2.7-distribution.tar.gz
-    tar xvfz jena-fuseki-0.2.7-distribution.tar.gz
-    cd jena-fuseki-0.2.7
-    ./fuseki-server --update --mem /test
-    ```
+``` sh
+curl -O http://www.apache.org/dist/jena/binaries/jena-fuseki-0.2.7-distribution.tar.gz
+tar xvfz jena-fuseki-0.2.7-distribution.tar.gz
+cd jena-fuseki-0.2.7
+./fuseki-server --update --mem /test
+```
 
 ### Sesame
 

diff --git a/fcrepo-jms-indexer-webapp/src/main/webapp/index.html b/fcrepo-jms-indexer-webapp/src/main/webapp/index.html
@@ -0,0 +1,28 @@
+<html>
+  <head>
+    <title>fcrepo-jms-indexer</title>
+    <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.min.css" rel="stylesheet"></link>
+  </head>
+  <body>
+    <div id="main" class="container">
+      <h1>fcrepo-jms-indexer</h1>
+      <p>fcrepo-jms-indexer is the indexing component of the Fedora4 repository.  The indexer listens to JMS events, retrieves RDF for updated objects, and calls one or more workers to index the object in Solr, a triplestore, etc.</p>
+      <dl>
+        <dt>Requirements</dt>
+        <dd>
+          <ul>
+            <li><a href="https://github.com/futures/fcrepo4">fcrepo4</a>: this webapp is intended to be run independently from the repository, so you will need to build and run that separately.  There is also a version of fcrepo4 bundled with a pre-configured indexer (see <a href="https://wiki.duraspace.org/display/FF/Design+-+Indexing#Design-Indexing-TryingOuttheIndexer">setup instructions</a>)</li>
+            <li>triplestore: by default, this webapp is configured to sync to a triplestore using SPARQL Update.  We've tested with Jena Fuseki and Sesame (see <a href="https://wiki.duraspace.org/display/FF/Triplestore+Setup">triplestore setup instructions</a>)</li>
+          </ul>
+        </dd>
+        <dt>Documentation</dt>
+        <dd>
+          <ul>
+            <li><a href="https://wiki.duraspace.org/display/FF/Design+-+Indexing">Design - Indexing</a>: overview of the indexer, including configuration and adding support for new indexers</li>
+            <li><a href="https://wiki.duraspace.org/display/FF/Triplestore+Setup">Triplestore Setup</a>: instructions for setting up Fuseki and Sesame triplestores</li>
+          </ul>
+        </dd>
+      </dl>
+    </div>
+  </body>
+</html>