ijuniorfu/laravel-scout-elasticsearch

Elastic Driver for Laravel Scout

v7.6 2020-04-08 01:55 UTC

Requires

• php: ^7.1
• elasticsearch/elasticsearch: ^7.6
• laravel/scout: ^5.0|^6.0|^7.0

Requires (Dev)

• fzaninotto/faker: ~1.4
• mockery/mockery: 0.9.*
• phpunit/phpunit: ~5.0

Suggests

• elasticsearch/elasticsearch: Required to use the Elasticsearch engine (^7.6).

MIT

• elasticsearch
• laravel
• elastic
• scout

README

This package makes is the Elasticsearch driver for Laravel Scout.

Contents

• Installation
• Usage
• License

Installation

You can install the package via composer:

composer require ijuniorfu/laravel-scout-elasticsearch

You must add the Scout service provider and the package service provider in your app.php config:

// config/app.php
'providers' => [
    ...
    Laravel\Scout\ScoutServiceProvider::class,
    ...
    ScoutEngines\Elasticsearch\ElasticsearchProvider::class,
],

Setting up Elasticsearch configuration

You must have a Elasticsearch server up and running with the index you want to use created

If you need help with this please refer to the Elasticsearch documentation

After you've published the Laravel Scout package configuration:

// config/scout.php
// Set your driver to elasticsearch
    'driver' => env('SCOUT_DRIVER', 'elasticsearch'),

...
    'elasticsearch' => [
        'type' => env('ELASTICSEARCH_TYPE', '_doc'),
        'hosts' => [
            env('ELASTICSEARCH_HOST', 'http://localhost'),
        ],
    ],
...

Usage

Now you can use Laravel Scout as described in the official documentation

License

The MIT License (MIT).