README.txt 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  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. Solr server
  16. ------------
  17. This directory contains an instance of the Jetty Servlet container setup to
  18. run Solr.
  19. To run Solr:
  20. cd $SOLR_INSTALL
  21. bin/solr start
  22. where $SOLR_INSTALL is the location where you extracted the Solr installation bundle.
  23. Server directory layout
  24. -----------------------
  25. server/contexts
  26. This directory contains the Jetty Web application deployment descriptor for the Solr Web app.
  27. server/etc
  28. Jetty configuration and example SSL keystore
  29. server/lib
  30. Jetty and other 3rd party libraries
  31. server/logs
  32. Solr log files
  33. server/resources
  34. Contains configuration files, such as the Log4j configuration (log4j2.xml) for configuring Solr loggers.
  35. server/scripts/cloud-scripts
  36. Command-line utility for working with ZooKeeper when running in SolrCloud mode, see zkcli.sh / .cmd for
  37. usage information.
  38. server/solr
  39. Default solr.solr.home directory where Solr will create core directories; must contain solr.xml
  40. server/solr/configsets
  41. Directories containing different configuration options for running Solr.
  42. _default : Bare minimum configurations with field-guessing and managed schema turned
  43. on by default, so as to start indexing data in Solr without having to design
  44. a schema upfront. You can use the REST API to manage your schema as you refine your index
  45. requirements. You can turn off the field (for a collection, say mycollection) guessing by:
  46. curl http://host:8983/solr/mycollection/config -d '{"set-user-property": {"update.autoCreateFields":"false"}}'
  47. sample_techproducts_configs : Comprehensive example configuration that demonstrates many of the powerful
  48. features of Solr, based on the use case of building a search solution for
  49. tech products.
  50. server/solr-webapp
  51. Contains files used by the Solr server; do not edit files in this directory (Solr is not a Java Web application).
  52. Notes About Solr Examples
  53. --------------------------
  54. * SolrHome *
  55. By default, start.jar starts Solr in Jetty using the default Solr Home
  56. directory of "./solr/" (relative to the working directory of the servlet
  57. container).
  58. * References to Jar Files Outside This Directory *
  59. Various example SolrHome dirs contained in this directory may use "<lib>"
  60. statements in the solrconfig.xml file to reference plugin jars outside of
  61. this directory for loading "contrib" plugins via relative paths.
  62. If you make a copy of this example server and wish to use the
  63. ExtractingRequestHandler (SolrCell), DataImportHandler (DIH), the
  64. clustering component, or any other modules in "contrib", you will need to
  65. copy the required jars or update the paths to those jars in your
  66. solrconfig.xml.
  67. * Logging *
  68. By default, Jetty & Solr will log to the console and logs/solr.log. This can
  69. be convenient when first getting started, but eventually you will want to
  70. log just to a file. To configure logging, edit the log4j2.xml file in
  71. "resources".
  72. It is also possible to setup log4j or other popular logging frameworks.