https://github.com/ericktamayo/laravel-scout-elastic

Elastic Driver for Laravel Scout
https://github.com/ericktamayo/laravel-scout-elastic

elasticsearch laravel laravel-scout php scout

Last synced: 3 months ago
JSON representation

Elastic Driver for Laravel Scout

• Host: GitHub
• URL: https://github.com/ericktamayo/laravel-scout-elastic
• Owner: ErickTamayo
• License: mit
• Archived: true
• Created: 2016-08-15T17:40:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-05T05:52:17.000Z (almost 2 years ago)
• Last Synced: 2024-09-28T05:05:13.427Z (3 months ago)
• Topics: elasticsearch, laravel, laravel-scout, php, scout
• Language: PHP
• Homepage:
• Size: 80.1 KB
• Stars: 917
• Watchers: 35
• Forks: 242
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Laravel Scout Elasticsearch Driver

[![Latest Stable Version](https://poser.pugx.org/tamayo/laravel-scout-elastic/v)](//packagist.org/packages/tamayo/laravel-scout-elastic) [![Total Downloads](https://poser.pugx.org/tamayo/laravel-scout-elastic/downloads)](//packagist.org/packages/tamayo/laravel-scout-elastic) [![License](https://poser.pugx.org/tamayo/laravel-scout-elastic/license)](//packagist.org/packages/tamayo/laravel-scout-elastic) ![Build Status](https://travis-ci.org/ErickTamayo/laravel-scout-elastic.svg?branch=master)

## Archived

I haven't had the time to dedicate work to this repo and I don't plan to do so in the future. 

This package provides a [Elasticsearch](https://www.elastic.co/products/elasticsearch) driver for Laravel Scout.

## Contents

- [Installation](#installation)

- [Usage](#usage)

- [Credits](#credits)

- [License](#license)

## Installation

You can install the package via composer:

```bash

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)`

```bash

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:

```php

// 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](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html)

## Usage

Now you can use Laravel Scout as described in the [Laravel Scout official documentation](https://laravel.com/docs/8.x/scout)

## Limitations

**Identifying Users**

Currrently user identification is not supported.

## Credits

- [Erick Tamayo](https://github.com/ericktamayo)

- [All Contributors](../../contributors)

## License

The MIT License (MIT).