Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 2.05 KB

README.md

File metadata and controls

74 lines (54 loc) · 2.05 KB

Laravel Scout Elasticsearch Driver

Software License

This package makes is the Elasticsearch v6.x driver for Laravel Scout.

Contents

Installation

You can install the package via composer:

composer require aobozhang/laravel-scout-elastic @dev

Unless Laravel 5.5 or Above, 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' => [
        'default_index' => env('ELASTICSEARCH_INDEX', 'default'),
        'index_prefix'  => env('ELASTICSEARCH_INDEX_PREFIX', true),
        'hosts' => [
            [
                'host'   => env('ELASTICSEARCH_HOST', 'http://localhost'),
                'port'   => env('ELASTICSEARCH_PORT', '9200'),
                'scheme' => env('ELASTICSEARCH_SSL', true) ? 'https': 'http',
                // 'user'   => 'username',
                // 'pass'   => 'password!#$?*abc'
            ],
        ],
    ],
...

Usage

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

Credits

License

The MIT License (MIT).