hollogram/laravel-scout-elastic

Elastic Driver for Laravel Scout

8.2.0 2022-04-15 09:03 UTC

Requires

• php: ^7.2|^8.0|^8.1
• laravel/scout: ^9.3

Requires (Dev)

• elasticsearch/elasticsearch: ^7.9
• mockery/mockery: ^1.0
• phpunit/phpunit: ^8.0|^9.3

Suggests

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

MIT

• Erick Tamayo

• elasticsearch
• laravel
• elastic
• scout

README

This package provides a Elasticsearch driver for Laravel Scout.

Contents

• Installation
• Usage
• Credits
• License

Installation

You can install the package via composer:

composer require tamayo/laravel-scout-elastic

Laravel will automatically register the driver service provider.

Install elasticsearch-php client

For use this library we recomend using the latest version at this time (^7.9)

composer require elasticsearch/elasticsearch

Setting up Elasticsearch configuration

After you've published the Laravel Scout package configuration, you need to set your driver to elasticsearch and add its configuration:

// config/scout.php
...
    // Set your driver to elasticsearch
    'driver' => env('SCOUT_DRIVER', 'elasticsearch'),
...
    /*
    |--------------------------------------------------------------------------
    | Elasticsearch Configuration
    |--------------------------------------------------------------------------
    |
    | Here you may configure your Elasticsearch settings.
    |
    */
    'elasticsearch' => [
        'hosts' => [
            env('ELASTICSEARCH_HOST', 'localhost'),
            // [
            //     'host'   => env('ELASTICSEARCH_HOST', 'localhost'),
            //     'port'   => env('ELASTICSEARCH_PORT', '9200'),
            //     'scheme' => env('ELASTICSEARCH_SCHEME', 'https'),
            //     'path'   => env('ELASTICSEARCH_PATH', '/elastic'),
            //     'user'   => env('ELASTICSEARCH_USER', 'username'),
            //     'pass'   => env('ELASTICSEARCH_PASS', 'password'),
            // ]
        ],
    ]
...

For host configuration you can refer to the official Elasticsearch documentation

Usage

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

Limitations

Identifying Users Currrently user identification is not supported.

Credits

• Erick Tamayo
• All Contributors

License

The MIT License (MIT).