Skip to content

installation.md

Latest commit

 

History

History
182 lines (146 loc) · 4.81 KB

installation.md

File metadata and controls

182 lines (146 loc) · 4.81 KB
Raw

Installation

Overview:

GENERAL

BACKEND

FRONTEND

ADDITIONAL

Requirements:

Note: This Plugin supports ElasticSearch 7.0 and above. If you're looking for ElasticSearch Plugin for older versions check SyliusElasticSearchPlugin in version 1.x.

We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.

Package Version
PHP >=8.1
sylius/sylius 1.12.x - 1.13.x
MySQL >= 5.7
NodeJS >= 18.x
ElasticSearch >= 7.x

Composer:

composer require bitbag/elasticsearch-plugin --no-scripts

Basic configuration:

Add plugin dependencies to your config/bundles.php file:

# config/bundles.php

return [
    ...
    FOS\ElasticaBundle\FOSElasticaBundle::class => ['all' => true],
    BitBag\SyliusElasticsearchPlugin\BitBagSyliusElasticsearchPlugin::class => ['all' => true],
];

Import required config in your config/packages/_sylius.yaml file:

# config/packages/_sylius.yaml

imports:
    ...
    - { resource: "@BitBagSyliusElasticsearchPlugin/config/config.yml" }

Import routing on top of your config/routes/sylius_shop.yaml file:

IMPORTANT!

Note. The code presented below needs to be loaded before including the sylius_shop routes. Please be sure, that it's being loaded first.

# config/routes.yaml

bitbag_sylius_elasticsearch_plugin:
    resource: "@BitBagSyliusElasticsearchPlugin/config/routing.yml"

Remove the default ElasticSearch index (app) defined by FOSElasticaBundle in config/packages/fos_elastica.yaml:

# config/packages/fos_elastica.yaml

fos_elastica:
    clients:
        default: { url: '%env(ELASTICSEARCH_URL)%' }
    indexes:
        app: ~

should become:

fos_elastica:
    clients:
        default: { url: '%env(ELASTICSEARCH_URL)%' }

Entities

Use BitBag\SyliusElasticsearchPlugin\Model\ProductVariantTrait and BitBag\SyliusElasticsearchPlugin\Model\ProductVariantInterface in an overridden ProductVariant entity class. The configuration, depending on the mapping used, may vary.

Attribute mapping

XML mapping

Update installed assets with the following command:

bin/console assets:install

Clear application cache by using command:

bin/console cache:clear

Finally, with an elasticsearch server running, execute following command:

bin/console fos:elastica:populate

Note: If you are running it on production, add the -e prod flag to this command. Elastic are created with environment suffix.

Webpack

Webpack.config.js

Please setup your webpack.config.js file to require the plugin's webpack configuration. To do so, please put the line below somewhere on top of your webpack.config.js file:

const [ bitbagElasticSearchShop ] = require('./vendor/bitbag/elasticsearch-plugin/webpack.config.js')

As next step, please add the imported consts into final module exports:

module.exports = [..., bitbagElasticSearchShop];

Assets

Add the asset configuration into config/packages/assets.yaml:

framework:
    assets:
        packages:
            ...
            elasticsearch_shop:
                json_manifest_path: '%kernel.project_dir%/public/build/bitbag/elasticsearch/shop/manifest.json'

Webpack Encore

Add the webpack configuration into config/packages/webpack_encore.yaml:

webpack_encore:
    output_path: '%kernel.project_dir%/public/build/default'
    builds:
        ...
        elasticsearch_shop: '%kernel.project_dir%/public/build/bitbag/elasticsearch/shop'

Encore functions

Add encore functions to your templates:

{# @templates/shop/javascripts.html.twig #}
{{ encore_entry_script_tags('bitbag-elasticsearch-shop', null, 'elasticsearch_shop') }}

{# @templates/shop/stylesheets.html.twig #}
{{ encore_entry_link_tags('bitbag-elasticsearch-shop', null, 'elasticsearch_shop') }}

Run commands

yarn install
yarn encore dev # or prod, depends on your environment

Additional configuration

Elasticsearch's port settings can be found in the .env file.

###> friendsofsymfony/elastica-bundle ###
ELASTICSEARCH_URL=http://localhost:9200/
###< friendsofsymfony/elastica-bundle ###

Known issues

Translations not displaying correctly

For incorrectly displayed translations, execute the command:

bin/console cache:clear