Skip to content

Commit bead9bb

Browse files
freedevjanhoy
andauthored
Describe in README how to build solr from source (#2294)
Co-authored-by: Jan Høydahl <[email protected]>
1 parent 63bc62b commit bead9bb

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,28 @@ Guide](https://solr.apache.org/guide/solr/latest/getting-started/solr-tutorial.h
7373
- Slack: Solr Community Channel. Sign up at https://s.apache.org/solr-slack
7474
- IRC: `#solr` on [libera.chat](https://web.libera.chat/?channels=#solr)
7575

76+
## Developer Documentation
77+
78+
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)
79+
80+
### Quickstart
81+
82+
Solr uses [Gradle](https://gradle.org/) for its build system. Here are some useful hints to build and run Solr locally:
83+
84+
- To build a Solr dev distribution:
85+
86+
```
87+
./gradlew dev
88+
```
89+
90+
- To run the Solr dev distribution locally:
91+
92+
```
93+
cd ./solr/packaging/build/dev
94+
bin/solr start -c
95+
```
96+
97+
- 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.
7698

7799
## Get Involved
78100
Please review [CONTRIBUTING.md](CONTRIBUTING.md) for information on contributing to the project.
@@ -84,4 +106,3 @@ To get involved in the developer community:
84106
- [Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SOLR)
85107
- IRC: `#solr-dev` on [libera.chat](https://web.libera.chat/?channels=#solr-dev)
86108

87-
Learn more about developing Solr by reading through the developer docs in [./dev-docs](./dev-docs) source tree.

0 commit comments

Comments
 (0)