Permalink
Browse files

include properties file in zip. still not available to run script, th…

…ough.
  • Loading branch information...
1 parent 50c4205 commit 2d6180b9625f8057619d37b8ed3e1712fdb5a699 Robert Newson committed Oct 7, 2009
Showing with 30 additions and 18 deletions.
  1. +10 −10 README.md
  2. +4 −4 src/main/assembly/dist.xml
  3. +2 −0 src/main/bin/run
  4. +0 −3 src/main/bin/start.sh
  5. +0 −1 src/main/bin/stop.sh
  6. +14 −0 src/main/conf/couchdb-lucene.properties
View
20 README.md
@@ -31,38 +31,38 @@ JDK6 is required; the Sun version is recommended as it's regularly tested agains
<li>configure couchdb (see below)
</ol>
+You will now have a zip file in the target/ directory. This contains all the couchdb-lucene code, dependencies, startup scripts and configuration files to run couchdb-lucene.
+
<h1>Configure CouchDB</h1>
<pre>
[couchdb]
os_process_timeout=60000 ; increase the timeout from 5 seconds.
[external]
-fti=/path/to/couchdb-lucene/couchdb-external-hook.rb
+fti=/path/to/ruby /usr/lib/couchdb/couchdb-lucene/couchdb-external-hook.rb couchdb.log.dir=/tmp couchdb.lucene.host=localhost couchdb.lucene.port=5985
[httpd_db_handlers]
_fti = {couch_httpd_external, handle_external_req, <<"fti">>}
</pre>
<h1>Configure couchdb-lucene</h1>
-From 0.5 onwards, couchdb-lucene runs in a single, standalone JVM. As such, you can choose to locate your couchdb-lucene server on a different machine to couchdb if you wish, or keep it on the same machine, it's your call. In either case, you need to tell couchdb-lucene where couch is. Edit the couchdb-lucene.properties file and fill in the host and port details;
+From 0.5 onwards, couchdb-lucene runs in a single, standalone JVM. As such, you can choose to locate your couchdb-lucene server on a different machine to couchdb if you wish, or keep it on the same machine, it's your call.
-<pre>
-couchdb.url=http://localhost:5984
-</pre>
+<ol>
+<li>Unzip the couchdb-lucene zip file.
+<li>Open the conf/couchdb-lucene.properties file.
+<li>Edit the couchdb.url to point to your couchdb installation.
<h1>Start couchdb-lucene</h1>
To start couchdb-lucene, run;
<pre>
-couchdb-lucene start
+bin/run
</pre>
-To stop couchdb-lucene, run;
-<pre>
-couchdb-lucene stop
-</pre>
+To stop couchdb-lucene, simply kill the Java process.
<h1>Indexing Strategy</h1>
View
8 src/main/assembly/dist.xml
@@ -15,14 +15,14 @@
</fileSets>
<files>
<file>
- <source>${project.basedir}/src/main/bin/start.sh</source>
+ <source>${project.basedir}/src/main/bin/run</source>
<fileMode>500</fileMode>
<outputDirectory>/bin</outputDirectory>
</file>
<file>
- <source>${project.basedir}/src/main/bin/stop.sh</source>
- <fileMode>500</fileMode>
- <outputDirectory>/bin</outputDirectory>
+ <source>${project.basedir}/src/main/conf/couchdb-lucene.properties</source>
+ <fileMode>400</fileMode>
+ <outputDirectory>/conf</outputDirectory>
</file>
</files>
<dependencySets>
View
2 src/main/bin/run
@@ -0,0 +1,2 @@
+#!/bin/sh
+java -server -Xmx1g -jar lib/couchdb-lucene-0.5-SNAPSHOT.jar
View
3 src/main/bin/start.sh
@@ -1,3 +0,0 @@
-#!/bin/sh
-
-java -jar lib/couchdb-lucene-0.5-SNAPSHOT.jar
View
1 src/main/bin/stop.sh
@@ -1 +0,0 @@
-#!/bin/sh
View
14 src/main/conf/couchdb-lucene.properties
@@ -0,0 +1,14 @@
+# The location of CouchDB.
+couchdb.url=http://localhost:5984
+
+# The output directory for Lucene indexes.
+lucene.dir=indexes
+
+# The location of our log file.
+lucene.log=log/couchdb-lucene.log
+
+# The port that couchdb-lucene binds to.
+lucene.port=5985
+
+# Whether Lucene's near-realtime search feature is enabled.
+lucene.realtime=true

0 comments on commit 2d6180b

Please sign in to comment.