Skip to content

Commit

Permalink
Update docs to install as Solr plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
kezhenxu94 committed Jun 27, 2020
1 parent efc552c commit b33bb9e
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,24 @@ image:https://img.shields.io/badge/Apache-2.0-ee1b3e.svg[capition="License", lin

== Installation

=== Solr Plugin (Recommended)

You can install **{project-name}** as a Solr Plugin:

[source,bash,subs="verbatim,attributes"]
----
solr package add-repo yasa "https://raw.githubusercontent.com/yasa-org/yasa/master/repo/"
solr package install yasa
# Should be unnecessary in the future
curl "http://localhost:8983/solr/admin/collections?action=CREATE&name=whatever&numShards=1"
solr package undeploy yasa -y -collections whatever
solr package deploy yasa -y -collections whatever
----

Then navigate your browser to http://localhost:8983/v2/plugin/yasa

=== Standalone Mode

You can install **{project-name}** in the standalone mode without affecting the official Solr Admin. Here is how:
Expand Down Expand Up @@ -65,7 +83,7 @@ If you are interested in `{project-name}` and want to contribute, you can run `{
# pull source code
git clone https://github.com/{org-name}/{project-name-lower}
cd {project-name-lower}
cd {project-name-lower}/yasa-ui
# install dependencies
npm i
Expand Down

0 comments on commit b33bb9e

Please sign in to comment.