mirror of https://github.com/apache/lucene.git
0b353b6741
Squashed commit of the following: commit 1cc4de5c4506c757746eac1809f9a7f3d3a55d00 Author: Cassandra Targett <ctargett@apache.org> Date: Tue Aug 15 13:23:40 2017 -0500 SOLR-10842: add Field UI images; rename image paths; minor cleanups commit 39c7c2f87c54eaaa3341dd119ecd4f0675244a38 Author: Cassandra Targett <ctargett@apache.org> Date: Thu Aug 3 15:49:21 2017 -0500 SOLR-10842: remove running-solr.adoc; move starting solr content to installing-solr; move pages to improve flow; final readthrough commit 70bea0e73159557f991572ad680a251a0791faec Author: Cassandra Targett <ctargett@apache.org> Date: Wed Aug 2 19:31:57 2017 -0500 SOLR-10842: rename upgrading-solr.adoc; fix links commit 0d0cbe7980bf0868ea5d36093aad6101201de82b Author: Cassandra Targett <ctargett@apache.org> Date: Tue Aug 1 09:46:42 2017 -0500 SOLR-10842: page re-org cleanup; copy edits on tutorial; rename "quick-start" to "tutorial" commit 4a2635638b214b1480d3b7055afa219ae7bb6a36 Author: Cassandra Targett <ctargett@apache.org> Date: Fri Jul 28 13:45:39 2017 -0500 SOLR-10842: Overhaul of tutorial; update query image commit 1e1646223b29a0788597d3695b5d0e7ebdd28187 Author: Cassandra Targett <ctargett@apache.org> Date: Thu Jul 20 14:13:43 2017 -0500 little typos commit e2cb85649dabfd7fd7df6f3d3cce2ca58a4c76a9 Author: Cassandra Targett <ctargett@apache.org> Date: Wed Jul 19 09:32:25 2017 -0500 Change example to use Films commit 49ad12ca58d5b3bbe60f3cb8f61469bfe321fcc3 Author: Cassandra Targett <ctargett@apache.org> Date: Tue Jul 18 09:31:03 2017 -0500 Further experiments with tabbed layout commit 21e4dcb38f802f9d2aed795d5c6ba3701b0178ae Author: Cassandra Targett <ctargett@apache.org> Date: Mon Jul 17 16:58:33 2017 -0500 Fix page links; add experiment with tabs for different data formats commit c24a9385361d22d7cb51051152b9e1f834c25d45 Author: Cassandra Targett <ctargett@apache.org> Date: Thu Jun 29 14:36:01 2017 -0500 SOLR-10842: minor changes to a few files commit 819f160423d17dbb647935c5bbfd8a16d4b7b57c Author: Cassandra Targett <ctargett@apache.org> Date: Fri Jun 23 13:49:32 2017 -0500 SOLR-10842: major page reorg; new content for install and config files commit 4be7b61ba46f440accdf96757566c3d854e09328 Author: Cassandra Targett <ctargett@apache.org> Date: Tue Jun 13 15:34:49 2017 -0500 SOLR-10842: installation docs commit c83a9ba91d96d5b75df2191404a3482ca81f8505 Author: Cassandra Targett <ctargett@apache.org> Date: Tue Jun 13 13:56:47 2017 -0500 SOLR-10842: little fixes for quick start commit 10c1a462338aa16c0435c01eba0506fe09277174 Author: Cassandra Targett <ctargett@apache.org> Date: Fri Jun 9 13:47:04 2017 -0500 SOLR-10842: add quickstart.html from CMS; convert to asciidoc style |
||
---|---|---|
.. | ||
bin | ||
cloud-dev | ||
contrib | ||
core | ||
example | ||
licenses | ||
server | ||
site | ||
solr-ref-guide | ||
solrj | ||
test-framework | ||
webapp | ||
.gitignore | ||
CHANGES.txt | ||
LICENSE.txt | ||
NOTICE.txt | ||
README.txt | ||
build.xml | ||
common-build.xml |
README.txt
# Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. Welcome to the Apache Solr project! ----------------------------------- Solr is the popular, blazing fast open source enterprise search platform from the Apache Lucene project. For a complete description of the Solr project, team composition, source code repositories, and other details, please see the Solr web site at http://lucene.apache.org/solr Getting Started --------------- To start Solr for the first time after installation, simply do: bin/solr start This will launch a standalone Solr server in the background of your shell, listening on port 8983. Alternatively, you can launch Solr in "cloud" mode, which allows you to scale out using sharding and replication. To launch Solr in cloud mode, do: bin/solr start -cloud To see all available options for starting Solr, please do: bin/solr start -help After starting Solr, create either a core or collection depending on whether Solr is running in standalone (core) or SolrCloud mode (collection) by doing: bin/solr create -c <name> This will create a collection that uses a data-driven schema which tries to guess the correct field type when you add documents to the index. To see all available options for creating a new collection, execute: bin/solr create -help After starting Solr, direct your Web browser to the Solr Admin Console at: http://localhost:8983/solr/ Solr Examples --------------- Solr includes a few examples to help you get started. To run a specific example, do: bin/solr -e <EXAMPLE> where <EXAMPLE> is one of: cloud : SolrCloud example dih : Data Import Handler (rdbms, mail, atom, tika) schemaless : Schema-less example (schema is inferred from data during indexing) techproducts : Kitchen sink example providing comprehensive examples of Solr features For instance, if you want to run the Solr Data Import Handler example, do: bin/solr -e dih Indexing Documents --------------- To add documents to the index, use bin/post. For example: bin/post -c <collection_name> example/exampledocs/*.xml For more information about Solr examples please read... * example/README.txt For more information about the "Solr Home" and Solr specific configuration * http://lucene.apache.org/solr/quickstart.html For a Quick Start guide * http://lucene.apache.org/solr/resources.html For a list of other tutorials and introductory articles. or linked from "docs/index.html" in a binary distribution. Also, there are Solr clients for many programming languages, see http://wiki.apache.org/solr/IntegratingSolr Files included in an Apache Solr binary distribution ---------------------------------------------------- server/ A self-contained Solr instance, complete with a sample configuration and documents to index. Please see: bin/solr start -help for more information about starting a Solr server. example/ Contains example documents and an alternative Solr home directory containing examples of how to use the Data Import Handler, see example/example-DIH/README.txt for more information. dist/solr-<component>-XX.jar The Apache Solr libraries. To compile Apache Solr Plugins, one or more of these will be required. The core library is required at a minimum. (see http://wiki.apache.org/solr/SolrPlugins for more information). docs/index.html A link to the online version of Apache Solr Javadoc API documentation and Tutorial Instructions for Building Apache Solr from Source ------------------------------------------------- 1. Download the Java SE 8 JDK (Java Development Kit) or later from http://www.oracle.com/java/ You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin) folder included on your command path. To test this, issue a "java -version" command from your shell (command prompt) and verify that the Java version is 1.8 or later. 2. Download the Apache Ant binary distribution (1.8.2+) from http://ant.apache.org/ You will need Ant installed and the $ANT_HOME/bin (Windows: %ANT_HOME%\bin) folder included on your command path. To test this, issue a "ant -version" command from your shell (command prompt) and verify that Ant is available. You will also need to install Apache Ivy binary distribution (2.2.0) from http://ant.apache.org/ivy/ and place ivy-2.2.0.jar file in ~/.ant/lib -- if you skip this step, the Solr build system will offer to do it for you. 3. Download the Apache Solr distribution, linked from the above web site. Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr Alternately, you can obtain a copy of the latest Apache Solr source code directly from the GIT repository: http://lucene.apache.org/solr/versioncontrol.html 4. Navigate to the "solr" folder and issue an "ant" command to see the available options for building, testing, and packaging Solr. NOTE: To see Solr in action, you may want to use the "ant server" command to build and package Solr into the server directory. See also server/README.txt. Export control ------------------------------------------------- This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See <http://www.wassenaar.org/> for more information. The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code. The following provides more details on the included cryptographic software: Apache Solr uses the Apache Tika which uses the Bouncy Castle generic encryption libraries for extracting text content and metadata from encrypted PDF files. See http://www.bouncycastle.org/ for more details on Bouncy Castle.