00-installation-configuration.md

Installation

This bundle depends on the Pimcore DataHub, which needs to be installed first.

To install the Simple REST Adapter complete following steps:

1. Install via composer

composer require bo-hub/ci-hub-adapter-bundle
composer require bo-hub/ci-hub-api-bundle

2. Enable via command-line (or inside the Pimcore extension manager)

bin/console pimcore:bundle:enable SimpleRESTAdapterBundle

3. Extend security.yaml

access_control:
  - { path: ^/datahub, roles: PUBLIC_ACCESS }

4. Clear cache and reload Pimcore

bin/console cache:clear --no-warmup

Make sure, that the priority of the Pimcore DataHub is higher than the priority of the Simple REST Adapter. This can be specified as parameter of the pimcore:bundle:enable command or in the Pimcore extension manager.

Other Examples

• Docker Setup

Bundle Configuration

Configure Elasticsearch hosts and index name prefix with Symfony configuration:

# Default configuration for "SimpleRESTAdapterBundle"
datahub_rest_adapter:

    # Prefix for index names.
    index_name_prefix:    datahub_restindex

    # Default providers that populate the index.
    asset_provider: 'CIHub\Bundle\SimpleRESTAdapterBundle\Provider\AssetProvider'
    data_object_provider: 'CIHub\Bundle\SimpleRESTAdapterBundle\Provider\DataObjectProvider'

    # Default transformer for the filter parameter. Used in search and tree-items endpoint.
    filter_field_name_transformer: 'CIHub\Bundle\SimpleRESTAdapterBundle\Transformer\FilterFieldNameTransformer'

    # List of Elasticsearch hosts.
    es_hosts:

        # Default:
        - localhost

    # Global Elasticsearch index settings.
    index_settings:

        # Defaults:
        number_of_shards:    5
        number_of_replicas:  0
        max_ngram_diff:      20
        analysis:
            analyzer:
                datahub_ngram_analyzer:
                    type:                custom
                    tokenizer:           datahub_ngram_tokenizer
                    filter:
                        - lowercase
                datahub_whitespace_analyzer:
                    type:                custom
                    tokenizer:           datahub_whitespace_tokenizer
                    filter:
                        - lowercase
            normalizer:
                lowercase:
                    type:                custom
                    filter:
                        - lowercase
            tokenizer:
                datahub_ngram_tokenizer:
                    type:                nGram
                    min_gram:            2
                    max_gram:            20
                    token_chars:
                        - letter
                        - digit
                datahub_whitespace_tokenizer:
                    type:                whitespace

Supported Elasticsearch version: ^7.0

Notice: If you are using Elasticsearch version 8.0 and above, you should set datahub_rest_adapter.index_settings.analysis.tokenizer.datahub_ngram_tokenizer.type in the above configuration as ngram, not nGram.

To make sure the indexing queue is processed and index is filled, the following command has to be executed on a regular basis, e.g. every 5 minutes.

*/5 * * * * php /var/www/html/bin/console messenger:consume datahub_es_index_queue --limit=20 --time-limit=240 >/dev/null 2>&1