Apache Solr Documentation

6.4 Ref Guide (PDF Download)
Solr Tutorial
Solr Community Wiki

Older Versions of this Guide (PDF)

6.5 Draft Ref Guide Topics

Meta-Documentation

This Unreleased Guide Will Cover Apache Solr 6.5

Skip to end of metadata
Go to start of metadata

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.

Special Inline Notes

Special notes are included throughout these pages.

Note Type

Look & Description

Information

Notes with a blue background are used for information that is important for you to know.

Notes

Yellow notes are further clarifications of important points to keep in mind while using Solr.

Tip

Notes with a green background are Helpful Tips.

Warning

Notes with a red background are warning messages.

Hosts and Port Examples

The default port when running Solr 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, 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.

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. When running the various examples mentioned through out this tutorial (i.e., bin/solr -e techproducts) the solr.home will be a sub directory of example/ created for you automatically.

  • No labels

7 Comments

  1. The first two paragraphs:

    ****

    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.

    ****

    waver between this guide being encyclopedic coverage of Solr and covering "all the important features and functions." 

    Would the following come closer to capturing the goal of the guide?

    ****

    This guide addresses the needs of both new to Solr and experienced developers. It is free to download from http://lucene.apache.org/solr/.

    Getting Started (with hyperlink) will have new to Solr developers up and indexing in minutes.

    Experienced Solr developers will find complete coverage on:

    (list of sections with hyperlinks and page numbers)

    ****

    Does the suggested text capture the original intent of this section?

     

  2. For Special Inline Notes, shouldn't that be "Conventions"? Then outline what Solr displays, what the user types (in different fonts) plus have Notes, Tips, Warnings and how distinct from the rest of the text. I'm not sure about the difference between "information" and "notes."

    1. This section probably should be called Conventions as you indicate, and it should have information about different typefaces and colors used in the documentation as well as the "inline note" information that it currently includes.  Before changing this section to comply with these ideas, the entire corpus needs to be reviewed to figure out what the conventions are, and to fix any inconsistencies.

      If my free time were anywhere close to what's required, I would volunteer for that job.

      1. I will take a stab at capturing conventions starting in "Using the Solr Administration User Interface. Will post results here for discussion on best means for further reporting on conventions.

  3. Host and Port information: Shouldn't all examples have localhost and the default port so a user can run the examples from the guide? Of course that would mean the examples need to have markup that allows them to be tested against its version of Solr along with sample data.

    1. If there are places in the documentation that are not consistent, we should make them consistent.  Do you have any specific examples that need to be fixed?

      I have a special dislike for things that say "localhost:8983" in conjunction with Solr.  It's awesome if you've got a GUI installed on the Solr machine and can actually run a browser there, but that is not always the case.

      For SolrCloud, if there are multiple machines, anything that causes a node to register as 127.x.x.x or localhost will NOT work properly.

      If I had my way, the documentation would never mention using localhost, but I do not have final say on these things, and there IS documentation (right on this page) that mentions what to do if the machine is remote.

      1. No, no examples, I was keying off the text saying the examples were inconsistent. 

        I would assume anyone running SolrCloud would know how to adapt examples. I was thinking more of onboarding casual explorers as easily as possible. 

        But as you say, a survey of the text would useful than discussing this in the abstract.