| 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 | |
|---|
| 17 | Example "Solr Home" Directory |
|---|
| 18 | ============================= |
|---|
| 19 | |
|---|
| 20 | This directory is provided as an example of what a "Solr Home" directory |
|---|
| 21 | should look like. |
|---|
| 22 | |
|---|
| 23 | It's not strictly necessary that you copy all of the files in this |
|---|
| 24 | directory when setting up a new instance of Solr, but it is recommended. |
|---|
| 25 | |
|---|
| 26 | |
|---|
| 27 | Basic Directory Structure |
|---|
| 28 | ------------------------- |
|---|
| 29 | |
|---|
| 30 | The Solr Home directory typically contains the following subdirectories... |
|---|
| 31 | |
|---|
| 32 | conf/ |
|---|
| 33 | This directory is mandatory and must contain your solrconfig.xml |
|---|
| 34 | and schema.xml. Any other optional configuration files would also |
|---|
| 35 | be kept here. |
|---|
| 36 | |
|---|
| 37 | data/ |
|---|
| 38 | This directory is the default location where Solr will keep your |
|---|
| 39 | index, and is used by the replication scripts for dealing with |
|---|
| 40 | snapshots. You can override this location in the solrconfig.xml |
|---|
| 41 | and scripts.conf files. Solr will create this directory if it |
|---|
| 42 | does not already exist. |
|---|
| 43 | |
|---|
| 44 | lib/ |
|---|
| 45 | This directory is optional. If it exists, Solr will load any Jars |
|---|
| 46 | found in this directory and use them to resolve any "plugins" |
|---|
| 47 | specified in your solrconfig.xml or schema.xml (ie: Analyzers, |
|---|
| 48 | Request Handlers, etc...). Alternatively you can use the <lib> |
|---|
| 49 | syntax in solrconfig.xml to direct Solr to your plugins. See the |
|---|
| 50 | example solrconfig.xml file for details. |
|---|
| 51 | |
|---|
| 52 | bin/ |
|---|
| 53 | This directory is optional. It is the default location used for |
|---|
| 54 | keeping the replication scripts. |
|---|
