[CONF] Apache Solr Reference Guide > About This Guide

["Cassandra Targett (Confluence)" <co...@apache.org>]

Space: Apache Solr Reference Guide (https://cwiki.apache.org/confluence/display/solr)
Page: About This Guide (https://cwiki.apache.org/confluence/display/solr/About+This+Guide)

Change Comment:
---------------------------------------------------------------------
Add info on doc conventions for paths, hosts, and ports

Edited by Cassandra Targett:
---------------------------------------------------------------------
This guide describes all of the important features and functions of Apache Solr. It is free to download from [http://lucene.apache.org/solr/].

Designed to provide high-level documentation, this guide is intended to be more encyclopedic and less of a cookbook. It is structured to address a broad spectrum of needs, ranging from new developers getting started to well-experienced developers extending their application or troubleshooting. It will be of use at any point in the application life cycle, for whenever you need authoritative information about Solr.

The material as presented assumes that you are familiar with some basic search concepts and that you can read XML. It does not assume that you are a Java programmer, although knowledge of Java is helpful when working directly with Lucene or when developing custom extensions to a Lucene/Solr installation.

h3. Special Inline Notes
Special notes are included throughout these pages.

|| Note Type || Look & Description ||
| *Information* | {info}Notes with a blue background are used for information that is important for you to know.{info} |
| *Notes* | {note}Yellow notes are further clarifications of important points to keep in mind while using Solr.{note} |
| *Tip* | {tip}Notes with a green background are Helpful Tips.{tip} |
| *Warning* | {warning}Notes with a red background are warning messages.{warning} |

h3. Hosts and Port Examples

The default port configured for Solr during the install process is 8983. The samples, URLs and screenshots in this guide may show different ports, because the port number that Solr uses is configurable. If you have not customized your installation of Solr, please make sure that you use port 8983 when following the examples, or configure your own installation to use the port numbers shown in the examples. For information about configuring port numbers used by Tomcat or Jetty, see [Managing Solr].

Similarly, URL examples use 'localhost' throughout; if you are accessing Solr from a location remote to the server hosting Solr, replace 'localhost' with the proper domain or IP where Solr is running.

h3. Paths

Path information is given relative to {{solr.home}}, which is the location under the main Solr installation where Solr's collections and their {{conf}} and {{data}} directories are stored. In the default Solr package, {{solr.home}} is {{example/solr}}, which is itself relative to where you unpackaged the application; if you have moved this location for your servlet container or for another reason, the path to {{solr.home}} may be different than the default.

{scrollbar}


Stop watching space: https://cwiki.apache.org/confluence/users/removespacenotification.action?spaceKey=solr
Change email notification preferences: https://cwiki.apache.org/confluence/users/editmyemailsettings.action