Skip to content

Commit

Permalink
feat: add steps to install as package
Browse files Browse the repository at this point in the history
  • Loading branch information
munendrasn committed Oct 8, 2020
1 parent 5cbbaca commit 11b2100
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
34 changes: 34 additions & 0 deletions PACKAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## Install as a package

* Start Solr (version 8.4 or later) nodes with -Denable.packages=true
```bash
$ bin/solr -c -Denable.packages=true
```

* Add repository:
```bash
$ bin/solr package add-repo child-transformer "https://raw.githubusercontent.com/munendrasn/child-subquery/master/repo/"
```

* List available packages:
```bash
$ bin/solr package list-available
```

* Install the package
```bash
$ bin/solr package install child-transformer
```

* Deploy package on the collection

```bash
$ bin/solr package deploy child-transformer -y -collections test -p TRANSFORMER_NAME=childquery
```
> `TRANSFORMER_NAME` when not specified, defaults to `childquery`
Refer [this](README.md#childsubquerytransformer) for sample usage

## Development [Upcoming]

> Refer to [Ishan](https://github.com/chatman)'s [repo](https://github.com/chatman/question-answering#development)
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,4 @@ Once plugin is installed, add this to `solrconfig.xml`
<transformer name="childquery" class="org.munendrasn.transformer.ChildSubQueryAugmenterFactory" />
```

Or Add it using [Config API](https://lucene.apache.org/solr/guide/8_6/config-api.html#advanced-commands-for-components)
Or Add it using [Config API](https://lucene.apache.org/solr/guide/8_6/config-api.html#advanced-commands-for-components) Or install as a [package](PACKAGE.md)

0 comments on commit 11b2100

Please sign in to comment.