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 | Welcome to the Apache Solr project! |
---|
18 | ----------------------------------- |
---|
19 | |
---|
20 | Solr is the popular, blazing fast open source enterprise search platform |
---|
21 | from the Apache Lucene project. |
---|
22 | |
---|
23 | For a complete description of the Solr project, team composition, source |
---|
24 | code repositories, and other details, please see the Solr web site at |
---|
25 | http://lucene.apache.org/solr |
---|
26 | |
---|
27 | |
---|
28 | Getting Started |
---|
29 | --------------- |
---|
30 | |
---|
31 | See the "example" directory for an example Solr setup. A tutorial |
---|
32 | using the example setup can be found at |
---|
33 | http://lucene.apache.org/solr/tutorial.html |
---|
34 | or linked from "docs/api/index.html" in a binary distribution. |
---|
35 | Also, there are Solr clients for many programming languages, see |
---|
36 | http://wiki.apache.org/solr/IntegratingSolr |
---|
37 | |
---|
38 | |
---|
39 | Files included in an Apache Solr binary distribution |
---|
40 | ---------------------------------------------------- |
---|
41 | |
---|
42 | example/ |
---|
43 | A self-contained example Solr instance, complete with a sample |
---|
44 | configuration, documents to index, and the Jetty Servlet container. |
---|
45 | Please see example/README.txt for information about running this |
---|
46 | example. |
---|
47 | |
---|
48 | dist/apache-solr-XX.war |
---|
49 | The Apache Solr Application. Deploy this WAR file to any servlet |
---|
50 | container to run Apache Solr. |
---|
51 | |
---|
52 | dist/apache-solr-XX.jar |
---|
53 | The Apache Solr Libraries. This JAR file is needed to compile |
---|
54 | Apache Solr Plugins (see http://wiki.apache.org/solr/SolrPlugins for |
---|
55 | more information). |
---|
56 | |
---|
57 | docs/api/index.html |
---|
58 | The Apache Solr Javadoc API documentation and Tutorial |
---|
59 | |
---|
60 | |
---|
61 | Instructions for Building Apache Solr from Source |
---|
62 | ------------------------------------------------- |
---|
63 | |
---|
64 | 1. Download the Java SE 6 JDK (Java Development Kit) or later from http://java.sun.com/ |
---|
65 | You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin) |
---|
66 | folder included on your command path. To test this, issue a "java -version" command |
---|
67 | from your shell (command prompt) and verify that the Java version is 1.6 or later. |
---|
68 | |
---|
69 | 2. Download the Apache Ant binary distribution (1.8.2+) from |
---|
70 | http://ant.apache.org/ You will need Ant installed and the $ANT_HOME/bin (Windows: |
---|
71 | %ANT_HOME%\bin) folder included on your command path. To test this, issue a |
---|
72 | "ant -version" command from your shell (command prompt) and verify that Ant is |
---|
73 | available. |
---|
74 | |
---|
75 | You will also need to install Apache Ivy binary distribution (2.2.0) from |
---|
76 | http://ant.apache.org/ivy/ and place ivy-2.2.0.jar file in ~/.ant/lib -- if you skip |
---|
77 | this step, the Solr build system will offer to do it for you. |
---|
78 | |
---|
79 | 3. Download the Apache Solr distribution, linked from the above web site. |
---|
80 | Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr |
---|
81 | Alternately, you can obtain a copy of the latest Apache Solr source code |
---|
82 | directly from the Subversion repository: |
---|
83 | |
---|
84 | http://lucene.apache.org/solr/versioncontrol.html |
---|
85 | |
---|
86 | 4. Navigate to the "solr" folder and issue an "ant" command to see the available options |
---|
87 | for building, testing, and packaging Solr. |
---|
88 | |
---|
89 | NOTE: |
---|
90 | To see Solr in action, you may want to use the "ant example" command to build |
---|
91 | and package Solr into the example/webapps directory. See also example/README.txt. |
---|
92 | |
---|
93 | |
---|
94 | Export control |
---|
95 | ------------------------------------------------- |
---|
96 | This distribution includes cryptographic software. The country in |
---|
97 | which you currently reside may have restrictions on the import, |
---|
98 | possession, use, and/or re-export to another country, of |
---|
99 | encryption software. BEFORE using any encryption software, please |
---|
100 | check your country's laws, regulations and policies concerning the |
---|
101 | import, possession, or use, and re-export of encryption software, to |
---|
102 | see if this is permitted. See <http://www.wassenaar.org/> for more |
---|
103 | information. |
---|
104 | |
---|
105 | The U.S. Government Department of Commerce, Bureau of Industry and |
---|
106 | Security (BIS), has classified this software as Export Commodity |
---|
107 | Control Number (ECCN) 5D002.C.1, which includes information security |
---|
108 | software using or performing cryptographic functions with asymmetric |
---|
109 | algorithms. The form and manner of this Apache Software Foundation |
---|
110 | distribution makes it eligible for export under the License Exception |
---|
111 | ENC Technology Software Unrestricted (TSU) exception (see the BIS |
---|
112 | Export Administration Regulations, Section 740.13) for both object |
---|
113 | code and source code. |
---|
114 | |
---|
115 | The following provides more details on the included cryptographic |
---|
116 | software: |
---|
117 | Apache Solr uses the Apache Tika which uses the Bouncy Castle generic encryption libraries for |
---|
118 | extracting text content and metadata from encrypted PDF files. |
---|
119 | See http://www.bouncycastle.org/ for more details on Bouncy Castle. |
---|