zookeeper/README.txt

   1 # Licensed to the Apache Software Foundation (ASF) under one or more
   2 # contributor license agreements.  See the NOTICE file distributed with
   3 # this work for additional information regarding copyright ownership.
   4 # The ASF licenses this file to You under the Apache License, Version 2.0
   5 # (the "License"); you may not use this file except in compliance with
   6 # the License.  You may obtain a copy of the License at
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 Solr example
  17 ------------
  18
  19 This directory contains an instance of the Jetty Servlet container setup to
  20 run Solr using an example configuration.
  21
  22 To run this example:
  23
  24   java -jar start.jar
  25
  26 in this example directory, and when Solr is started connect to
  27
  28   http://localhost:8983/solr/
  29
  30 To add documents to the index, use the post.jar (or post.sh script) in
  31 the example/exampledocs subdirectory (while Solr is running), for example:
  32
  33      cd exampledocs
  34      java -jar post.jar *.xml
  35 Or:  sh post.sh *.xml
  36
  37 For more information about this example please read...
  38
  39  * example/solr/README.txt
  40    For more information about the "Solr Home" and Solr specific configuration
  41  * http://lucene.apache.org/solr/tutorial.html
  42    For a Tutorial using this example configuration
  43  * http://wiki.apache.org/solr/SolrResources
  44    For a list of other tutorials and introductory articles.
  45
  46 Notes About These Examples
  47 --------------------------
  48
  49 * SolrHome *
  50
  51 By default, start.jar starts Solr in Jetty using the default Solr Home
  52 directory of "./solr/" (relative to the working directory of hte servlet
  53 container).  To run other example configurations, you can specify the
  54 solr.solr.home system property when starting jetty...
  55
  56   java -Dsolr.solr.home=multicore -jar start.jar
  57   java -Dsolr.solr.home=example-DIH/solr -jar start.jar
  58
  59 * References to Jar Files Outside This Directory *
  60
  61 Various example SolrHome dirs contained in this directory may use "<lib>"
  62 statements in the solrconfig.xml file to reference plugin jars outside of
  63 this directory for loading "contrib" plugins via relative paths.
  64
  65 If you make a copy of this example server and wish to use the
  66 ExtractingRequestHandler (SolrCell), DataImportHandler (DIH), UIMA, the
  67 clustering component, or any other modules in "contrib", you will need to
  68 copy the required jars or update the paths to those jars in your
  69 solrconfig.xml.
  70
  71 * Logging *
  72
  73 By default, Jetty & Solr will log to the console a logs/solr.log. This can be convenient when
  74 first getting started, but eventually you will want to log just to a file. To
  75 configure logging, edit the log4j.properties file in "resources".
  76
  77 It is also possible to setup log4j or other popular logging frameworks.
  78