Import/Export Algolia settings into your Laravel Scout project
The easiest way to manage your settings is usually to go to your Algolia dashboard because it has a nice UI and you can test the relevancy directly there.
Once you fine tuned your configuration, you may want to add it to your project. This package you add two Laravel commands to save your settings into a JSON file in your project and push it back to Algolia.
This has 3 majors advantages:
- You can version your configuration with your VCS
- You can set a new environement or restore backup easily
- Let you customize your settings in JSON format before pushing them
Install this package with composer
composer require algolia/laravel-scout-settingsIf you use Laravel 5.5, this package take advantage of the Package Auto-Discovery feature so you have nothing more to do.
If you use an older version of Laravel, you will have to add the Service Provider to the providers array in config/app.php
Algolia\Settings\ServiceProvider::class,You will know get two new commands available in artisan. They both take a model fully qualified class name, just like Laravel Scout does to import/flush data.
The following example assume you have an App\Contact class, which use the Searchable trait.
Note: Scout allows you to customize the index name with the searchableAs() method. This package will follow this name
The following command will export all the settings of the App\Contact's index into the resources/settings/prefix_index_name.json file.
php artisan algolia:settings:backup App\Contact
The following command will read all the settings in the resources/settings/prefix_index_name.json file and import them into Algolia's index.
php artisan algolia:settings:push App\Contact
Feel free to open a thread on our Community forum