Commit a03ad83731f0f0f6cb9e27725ec5769b72d140c4
1 parent
1e07f156
Exists in
master
and in
2 other branches
Updated url docs [skip ci]
Showing
1 changed file
with
15 additions
and
6 deletions
Show diff stats
README.md
| @@ -1226,7 +1226,7 @@ And [setup-opensearch](https://github.com/ankane/setup-opensearch) for an easy w | @@ -1226,7 +1226,7 @@ And [setup-opensearch](https://github.com/ankane/setup-opensearch) for an easy w | ||
| 1226 | 1226 | ||
| 1227 | ## Deployment | 1227 | ## Deployment |
| 1228 | 1228 | ||
| 1229 | -Searchkick uses `ENV["ELASTICSEARCH_URL"]` for the search server. This defaults to `http://localhost:9200`. | 1229 | +For the search server, Searchkick uses `ENV["ELASTICSEARCH_URL"]` for Elasticsearch and `ENV["OPENSEARCH_URL"]` for OpenSearch. This defaults to `http://localhost:9200`. |
| 1230 | 1230 | ||
| 1231 | - [Elastic Cloud](#elastic-cloud) | 1231 | - [Elastic Cloud](#elastic-cloud) |
| 1232 | - [Heroku](#heroku) | 1232 | - [Heroku](#heroku) |
| @@ -1251,13 +1251,20 @@ rake searchkick:reindex:all | @@ -1251,13 +1251,20 @@ rake searchkick:reindex:all | ||
| 1251 | 1251 | ||
| 1252 | Choose an add-on: [Bonsai](https://elements.heroku.com/addons/bonsai), [SearchBox](https://elements.heroku.com/addons/searchbox), or [Elastic Cloud](https://elements.heroku.com/addons/foundelasticsearch). | 1252 | Choose an add-on: [Bonsai](https://elements.heroku.com/addons/bonsai), [SearchBox](https://elements.heroku.com/addons/searchbox), or [Elastic Cloud](https://elements.heroku.com/addons/foundelasticsearch). |
| 1253 | 1253 | ||
| 1254 | -For Bonsai: | 1254 | +For Elasticsearch on Bonsai: |
| 1255 | 1255 | ||
| 1256 | ```sh | 1256 | ```sh |
| 1257 | -heroku addons:create bonsai # use --engine=opensearch for OpenSearch | 1257 | +heroku addons:create bonsai |
| 1258 | heroku config:set ELASTICSEARCH_URL=`heroku config:get BONSAI_URL` | 1258 | heroku config:set ELASTICSEARCH_URL=`heroku config:get BONSAI_URL` |
| 1259 | ``` | 1259 | ``` |
| 1260 | 1260 | ||
| 1261 | +For OpenSearch on Bonsai: | ||
| 1262 | + | ||
| 1263 | +```sh | ||
| 1264 | +heroku addons:create bonsai --engine=opensearch | ||
| 1265 | +heroku config:set OPENSEARCH_URL=`heroku config:get BONSAI_URL` | ||
| 1266 | +``` | ||
| 1267 | + | ||
| 1261 | For SearchBox: | 1268 | For SearchBox: |
| 1262 | 1269 | ||
| 1263 | ```sh | 1270 | ```sh |
| @@ -1292,10 +1299,10 @@ heroku run rake searchkick:reindex:all | @@ -1292,10 +1299,10 @@ heroku run rake searchkick:reindex:all | ||
| 1292 | 1299 | ||
| 1293 | ### Amazon OpenSearch Service | 1300 | ### Amazon OpenSearch Service |
| 1294 | 1301 | ||
| 1295 | -Create an initializer `config/initializers/elasticsearch.rb` with: | 1302 | +Create an initializer `config/initializers/opensearch.rb` with: |
| 1296 | 1303 | ||
| 1297 | ```ruby | 1304 | ```ruby |
| 1298 | -ENV["ELASTICSEARCH_URL"] = "https://es-domain-1234.us-east-1.es.amazonaws.com:443" | 1305 | +ENV["OPENSEARCH_URL"] = "https://es-domain-1234.us-east-1.es.amazonaws.com:443" |
| 1299 | ``` | 1306 | ``` |
| 1300 | 1307 | ||
| 1301 | To use signed requests, include in your Gemfile: | 1308 | To use signed requests, include in your Gemfile: |
| @@ -1322,10 +1329,12 @@ rake searchkick:reindex:all | @@ -1322,10 +1329,12 @@ rake searchkick:reindex:all | ||
| 1322 | 1329 | ||
| 1323 | ### Self-Hosted and Other | 1330 | ### Self-Hosted and Other |
| 1324 | 1331 | ||
| 1325 | -Create an initializer `config/initializers/elasticsearch.rb` with: | 1332 | +Create an initializer with: |
| 1326 | 1333 | ||
| 1327 | ```ruby | 1334 | ```ruby |
| 1328 | ENV["ELASTICSEARCH_URL"] = "https://user:password@host:port" | 1335 | ENV["ELASTICSEARCH_URL"] = "https://user:password@host:port" |
| 1336 | +# or | ||
| 1337 | +ENV["OPENSEARCH_URL"] = "https://user:password@host:port" | ||
| 1329 | ``` | 1338 | ``` |
| 1330 | 1339 | ||
| 1331 | Then deploy and reindex: | 1340 | Then deploy and reindex: |