root/lucene-ws/trunk/README

Revision 431, 1.8 kB (checked in by brian.cassidy, 1 year ago)

apply r430 to trunk

Line 
1 Lucene Web Service
2 ------------------
3
4 DESCRIPTION
5
6 The Lucene Web Service is a REST-compliant Java servlet capable of searching and
7 managing multiple Lucene indices via the web. It is built upon the Atom Publishing
8 Protocol and conforms to the OpenSearch 1.1 standard.
9
10 BUILDING
11
12 To build the Lucene Web Service you can use ant with the build.xml that is included.
13
14 INSTALLING
15
16 Configure the web service by editing web.xml in the conf directory. Most of the default
17 settings should be ok, but you will need to change the indices.directories init-param to
18 specify the directories where you want Lucene indexes to reside.
19
20 Setting:               Description:
21 ===============================================================================================
22    
23 properties.file        When present in initial parameters, service will replace all initial
24                        parameters with those contained within the file pointed to by the value.
25                          
26 service.title          The title of service. Defaults to "Lucene Web Service vX.X.X"
27                          
28 service.defaultfield   Provides a global default field to be used when searching. This value is
29                        only used as a last resort.
30                          
31 indices.directories    A comma-delimited list of directories within which will reside the indices.
32                        Left-most directories have higher priority than right-most. New indices
33                        are created in the left-most directory.
34                          
35 service.debugging      If true, a stack trace is appended to all exceptions thrown, providing
36                        valuable information.
37
38 AUTHORS
39
40 Adam Paynter <adam.paynter@gmail.com>
41 Brian Cassidy <brian.cassidy@gmail.com>
42
43 CONTRIBUTORS
44
45 Darren Osten
46 Kris Resellmo
47 Kirk Beers
Note: See TracBrowser for help on using the browser.