README

简介

Laravel Scout OpenSearch 简化了 Laravel Scout 与 OpenSearch 的集成，提供了无缝的体验。此外，它还完全兼容 AWS OpenSearch，使实现过程更加简便。

安装

composer require bytexr/laravel-scout-opensearch

要更新必要的设置，请导航到 config/scout.php 并添加以下代码

return [
    ...

    'opensearch' => [
        'host' => env('OPENSEARCH_HOST', 'https://:9200'),
        'access_key' => env('OPENSEARCH_ACCESS_KEY', 'admin'),
        'secret_key' => env('OPENSEARCH_SECRET_KEY', 'admin'),
        'options' => [
            'ssl_verification' => env('OPENSEARCH_SSL_VERIFICATION', true),
            // Used for AWS
            'sigv4_enabled' => env('OPENSEARCH_SIGV4_ENABLED', false),
            'sigv4_region' =>  env('OPENSEARCH_SIGV4_REGION', 'eu-west-1'),
        ],
    ],

];

最后，请确保在您的 .env 文件中设置了所有必需的环境变量，并且不要忘记将 SCOUT_DRIVER 的值设置为 opensearch。

显式映射

如果您需要为索引特别定义映射，您可以在 config/scout.php 中通过设置 index-settings 键来完成，如下所示

return [
    ...
    
    'opensearch' => [
        ...
        'index-settings' => [
            Post::class => [
                'mappings' => [
                    'properties' => [
                        'id' => [
                            'type' => 'text',
                        ],
                        'title' => [
                            'type' => 'text',
                        ],
                    ],
                ],
            ],
        ],
    ]
]

许可证

Laravel Scout OpenSearch 是开源软件，采用MIT 许可证。