Skip to content

Commit 980577d

Browse files
committed
Update readme
1 parent 6a4a776 commit 980577d

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,34 @@ GITHUB_SECRET=
3939
GITHUB_URL=http://laravel.io.test/auth/github
4040
```
4141

42+
### Algolia search (optional)
43+
44+
To get Algolia search running locally, you'll need to [register for a new account](https://www.algolia.com/users/sign_up) and create an index called `threads`. Algolia have a free tier which satisfies all of the requirements needed for a development environment. Now update the following variables in your `.env` file. The App ID and secret keys can be found in the `API Keys` section of the Algoila UI.
45+
46+
```
47+
SCOUT_DRIVER=algolia
48+
SCOUT_QUEUE=true
49+
50+
ALGOLIA_APP_ID=
51+
// Use the Write API Key
52+
ALGOLIA_SECRET=
53+
54+
MIX_ALGOLIA_APP_ID="${ALGOLIA_APP_ID}"
55+
// Use the Search API Key
56+
MIX_ALGOLIA_SECRET=
57+
MIX_ALGOLIA_INDEX=threads
58+
```
59+
60+
In order to index your existing threads, run the following command.
61+
62+
`php artisan scout:import`
63+
64+
New threads will be automatically added to the index and threads which get edited will be automatically updated.
65+
66+
If you need to flush your index and start again, you can run the following command:
67+
68+
`php artisan scout:flush`
69+
4270
## Maintainers
4371

4472
The Laravel.io portal is currently maintained by [Dries Vints](https://github.com/driesvints) and [Joe Dixon](https://github.com/joedixon). If you have any questions please don't hesitate to create an issue on this repo.

0 commit comments

Comments
 (0)