Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/solr
Apache Solr open-source search software
https://github.com/apache/solr
backend information-retrieval java lucene nosql search search-engine solr
Last synced: 6 days ago
JSON representation
Apache Solr open-source search software
- Host: GitHub
- URL: https://github.com/apache/solr
- Owner: apache
- License: apache-2.0
- Created: 2021-02-23T00:12:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T11:57:18.000Z (about 2 months ago)
- Last Synced: 2024-10-29T13:35:11.204Z (about 2 months ago)
- Topics: backend, information-retrieval, java, lucene, nosql, search, search-engine, solr
- Language: Java
- Homepage: https://solr.apache.org/
- Size: 491 MB
- Stars: 1,209
- Watchers: 53
- Forks: 659
- Open Issues: 187
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-vector-search - Solr - Apache Solr - [has a Dense Vector Search feature as of Solr 9.0](https://solr.apache.org/guide/solr/latest/query-guide/dense-vector-search.html) (Awesome Vector Search Engine / Standalone Service)
README
# Welcome to the Apache Solr project!
-----------------------------------
Solr is the blazing-fast, open source, multi-modal search platform built on [Apache Lucene](https://lucene.apache.org/).
It powers full-text, vector, and geospatial search at many of the world's largest organizations.
[](https://ci-builds.apache.org/job/Solr/job/Solr-Artifacts-main/)
[](https://ci-builds.apache.org/job/Solr/job/Solr-Lint-main/)
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](https://solr.apache.org/guide/solr/latest/deployment-guide/system-requirements.html) to walk you through installing Solr.
### Running Solr in Docker
You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
Learn more about [Solr in Docker](https://solr.apache.org/guide/solr/latest/deployment-guide/solr-in-docker.html)
### Running Solr on Kubernetes
Solr has official support for running on Kubernetes, in the official Docker image.
Please refer to the [Solr Operator](https://solr.apache.org/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 where 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](https://solr.apache.org/guide/solr/latest/getting-started/solr-tutorial.html).
## Support
- [Users Mailing List](https://solr.apache.org/community.html#mailing-lists-chat)
- Slack: Solr Community Channel. Sign up at https://s.apache.org/solr-slack
- IRC: `#solr` on [libera.chat](https://web.libera.chat/?channels=#solr)
## Developer Documentation
Learn more about developing Solr by reading through the developer docs in [./dev-docs](./dev-docs) source tree or building Solr from source in [./dev-docs/solr-source-code.adoc](./dev-docs/solr-source-code.adoc)
### Quickstart
Solr uses [Gradle](https://gradle.org/) 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 the `bin/solr post` tool to index some sample data.
## Get Involved
Please review [CONTRIBUTING.md](CONTRIBUTING.md) for information on contributing to the project.
To get involved in the developer community:
- [Mailing Lists](https://solr.apache.org/community.html#mailing-lists-chat)
- Slack: `#solr-dev` in the `the-asf` organization. Sign up at https://the-asf.slack.com/messages/CE70MDPMF
- [Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SOLR)
- IRC: `#solr-dev` on [libera.chat](https://web.libera.chat/?channels=#solr-dev)