Updated documentation for self managed. (#48)

JasonStoltz · web-flow · commit 1fc5fcaf2f96 · 2019-10-22T07:29:20.000-04:00
diff --git a/README.md b/README.md
@@ -66,6 +66,7 @@ The following is a complete list of options available for configuration in [engi
 | option               | value type    | required/optional | source                                                                                                                                                                                 |
 | -------------------- | ------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `engineName`         | String        | required          | Found in your [App Search Dashboard](http://app.swiftype.com/as).                                                                                                                      |
+| `endpointBase`       | String        | optional          | Use this instead of "hostIdentifier" if you are using self managed. ex: "http://127.0.0.1:3002"                                                                                        |
 | `hostIdentifier`     | String        | required          | Found in your [App Search Dashboard](http://app.swiftype.com/as).                                                                                                                      |
 | `searchKey`          | String        | required          | Found in your [App Search Dashboard](http://app.swiftype.com/as).                                                                                                                      |
 | `searchFields`       | Array[String] | required          | A list of fields that will be searched with your search term.                                                                                                                          |
diff --git a/src/config/engine.json.example b/src/config/engine.json.example
@@ -1,4 +1,5 @@
 {
+  "endpointBase": "http://127.0.0.1:3002",
   "engineName": "your-engine-name",
   "hostIdentifier": "host-XXXXX",
   "searchKey": "search-XXXXXXXXXXXXXXXXXXXXXXX",

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`{`
	`2`	`+ "endpointBase": "http://127.0.0.1:3002",`
`2`	`3`	`"engineName": "your-engine-name",`
`3`	`4`	`"hostIdentifier": "host-XXXXX",`
`4`	`5`	`"searchKey": "search-XXXXXXXXXXXXXXXXXXXXXXX",`