Skip to content

[8.x] Add Meilisearch upgrade note to Scout docs #7286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 3, 2021
Merged

[8.x] Add Meilisearch upgrade note to Scout docs #7286

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
35c6d7d
Update scout.md
driesvints Sep 3, 2021
6bf3510
Update scout.md
driesvints Sep 3, 2021
8dd50df
Update scout.md
taylorotwell Sep 3, 2021
479d7bf
Update scout.md
taylorotwell Sep 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions scout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- [Installation](#installation)
- [Driver Prerequisites](#driver-prerequisites)
- [Queueing](#queueing)
- [Upgrading Scout](#upgrading-scout)
- [Configuration](#configuration)
- [Configuring Model Indexes](#configuring-model-indexes)
- [Configuring Searchable Data](#configuring-searchable-data)
Expand Down Expand Up @@ -70,6 +71,8 @@ When using the Algolia driver, you should configure your Algolia `id` and `secre
<a name="meilisearch"></a>
#### MeiliSearch

[MeiliSearch](https://www.meilisearch.com) is a blazingly fast and open source search engine. If you aren't sure how to install MeiliSearch on your local machine, you may use [Laravel Sail](/docs/{{version}}/sail#meilisearch), Laravel's officially supported Docker development environment.

When using the MeiliSearch driver you will need to install the MeiliSearch PHP SDK via the Composer package manager:

composer require meilisearch/meilisearch-php http-interop/http-factory-guzzle
Expand All @@ -80,9 +83,11 @@ Then, set the `SCOUT_DRIVER` environment variable as well as your MeiliSearch `h
MEILISEARCH_HOST=http://127.0.0.1:7700
MEILISEARCH_KEY=masterKey

For more information regarding MeiliSearch, please consult the [MeiliSearch documentation](https://docs.meilisearch.com/learn/getting_started/quick_start.html).
For more information regarding MeiliSearch, please consult the [MeiliSearch documentation](https://docs.meilisearch.com/learn/getting_started/quick_start.html).

In addition, you should ensure that you install a version of `meilisearch/meilisearch-php` that is compatible with your MeiliSearch binary version by reviewing [MeiliSearch's documentation regarding binary compatibility](https://github.com/meilisearch/meilisearch-php#-compatibility-with-meilisearch).

> {tip} If you aren't sure how to install MeiliSearch on your local machine, you may use [Laravel Sail](/docs/{{version}}/sail#meilisearch), Laravel's officially supported Docker development environment.
> {note} When upgrading Scout on an application that utilizes MeiliSearch, you should always [review any additional breaking changes](https://github.com/meilisearch/MeiliSearch/releases) to the MeiliSearch service itself.

<a name="queueing"></a>
### Queueing
Expand Down