Awesome
<!-- 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 blazing-fast, open source, multi-modal search platform built on Apache Lucene. It powers full-text, vector, and geospatial search at many of the world's largest organizations.
For a complete description of the Solr project, team composition, source code repositories, and other details, please see the Solr web site at https://solr.apache.org/
Download
Downloads for Apache Solr distributions are available at https://solr.apache.org/downloads.html.
Running Solr
Installing Solr
The Reference Guide contains an entire Deployment Guide to walk you through installing Solr.
Running Solr in Docker
You can run Solr in Docker via the official image. Learn more about Solr in Docker
Running Solr on Kubernetes
Solr has official support for running on Kubernetes, in the official Docker image. Please refer to the Solr Operator home for details, tutorials and instructions.
How to Use
Solr includes a few examples to help you get started. To run a specific example, enter:
bin/solr start -e <EXAMPLE> where <EXAMPLE> is one of:
cloud: SolrCloud example
techproducts: Comprehensive example illustrating many of Solr's core capabilities
schemaless: Schema-less example (schema is inferred from data during indexing)
films: Example of starting with _default configset and adding explicit fields dynamically
For instance, if you want to run the techproducts example, enter:
bin/solr start -e techproducts
For a more in-depth introduction, please check out the tutorials in the Solr Reference Guide.
Support
- Users Mailing List
- Slack: Solr Community Channel. Sign up at https://s.apache.org/solr-slack
- IRC:
#solr
on libera.chat
Developer Documentation
Learn more about developing Solr by reading through the developer docs in ./dev-docs source tree or building Solr from source in ./dev-docs/solr-source-code.adoc
Quickstart
Solr uses Gradle for its build system. Here are some useful hints to build and run Solr locally:
- To build a Solr dev distribution:
./gradlew dev
- To run the Solr dev distribution locally:
cd ./solr/packaging/build/dev
bin/solr start
- Open a web browser and go to http://localhost:8983/solr/ to access the Solr Admin interface. You can also use the
bin/solr
script to create and manage Solr collections. For example use thebin/solr post
tool to index some sample data.
Get Involved
Please review CONTRIBUTING.md for information on contributing to the project.
To get involved in the developer community:
- Mailing Lists
- Slack:
#solr-dev
in thethe-asf
organization. Sign up at https://the-asf.slack.com/messages/CE70MDPMF - Issue Tracker (JIRA)
- IRC:
#solr-dev
on libera.chat