Skip to content

Latest commit

 

History

History
224 lines (171 loc) · 4.95 KB

installation.md

File metadata and controls

224 lines (171 loc) · 4.95 KB
Raw

Installation

ElasticSearch

The SuluArticleBundle requires a running elasticsearch ^5.0, ^6.0 or ^7.0.

Install dependencies

composer require "elasticsearch/elasticsearch:7.9.*" # should match version of your elasticsearch installation
composer require "handcraftedinthealps/elasticsearch-bundle:^5.2"
composer require sulu/article-bundle

Configure SuluArticleBundle and sulu core

# config/packages/sulu_article.yaml

sulu_article:
    index_name: '%env(resolve:ELASTICSEARCH_INDEX)%'
    hosts:
        - '%env(resolve:ELASTICSEARCH_HOST)%'
    types:
        article:
            translation_key: "sulu_article.article"

sulu_route:
    mappings:
        Sulu\Bundle\ArticleBundle\Document\ArticleDocument:
            generator: schema
            options:
                route_schema: '/articles/{implode("-", object)}'

ongr_elasticsearch:
# If you expect more than 10000 articles, you need to set the `max_result_window` to an appropriate number  
#    managers:
#        default:
#            index:
#                settings:
#                    max_result_window: 20000
#        live:
#            index:
#                settings:
#                    max_result_window: 20000
    
    analysis:
        tokenizer:
            pathTokenizer:
                type: path_hierarchy
        analyzer:
            pathAnalyzer:
                tokenizer: pathTokenizer

Create env variables

As the elasticsearch index and host could be different between system we create environment variables for them.

# .env
ELASTICSEARCH_HOST=127.0.0.1:9200
ELASTICSEARCH_INDEX=su_myproject

Configure the routing

# config/routes/sulu_admin.yaml

sulu_article_api:
    resource: "@SuluArticleBundle/Resources/config/routing_api.yml"
    type: rest
    prefix: /admin/api

Configure multi webspace setup

Simple configuration:

# config/packages/sulu_article.yaml

sulu_article:
    default_main_webspace: 'webspace1'
    default_additional_webspaces:
        - 'webspace2'
        - 'webspace3'

Localized configuration:

# config/packages/sulu_article.yaml

sulu_article:
    default_main_webspace: 
        de: 'webspaceA'
        en: 'webspaceX'
    default_additional_webspaces:
        de:
            - 'webspaceN'
            - 'webspaceM'
        en:
            - 'webspaceN'

Localized configuration with a defined default:

# config/packages/sulu_article.yaml

sulu_article:
    default_main_webspace: 
        default: 'webspaceA'
        en: 'webspaceX'
        fr: 'webspaceF'
    default_additional_webspaces:
        default:
            - 'webspaceB'
            - 'webspaceC'
        de:
            - 'webspaceN'
            - 'webspaceM'
        en:
            - 'webspaceN'

More information about this topic can be found in the section multi-webspaces.

Create Template

Add xml template for structure in configured folder:

%kernel.project_dir%/config/templates/articles/default.xml

Example is located in Bundle default.xml.

Add template for article type in configured folder:

%kernel.project_dir%/templates/articles/default.html.twig

Example is located in Bundle default.html.twig.

Initialize bundle

Create required phpcr nodes:

php bin/console sulu:document:init

Create elasticsearch index:

php bin/console ongr:es:index:create
php bin/console ongr:es:index:create --manager=live

Permissions:

Make sure you've set the correct permissions in the Sulu backend for this bundle!

Settings > User Roles

Possible bundle configurations:

# config/packages/sulu_article.yaml

sulu_article:
    index_name: su_articles
    hosts: ['127.0.0.1:9200']
    default_main_webspace: null
    default_additional_webspaces: []
    smart_content:
        default_limit:        100
    documents:
        article:
            view:                 Sulu\Bundle\ArticleBundle\Document\ArticleViewDocument
        article_page:
            view:                 Sulu\Bundle\ArticleBundle\Document\ArticlePageViewObject
    types:
        # Prototype
        name:
            translation_key:      ~

    # Display tab 'all' in list view
    display_tab_all:      true

    # Set default author if none isset
    default_author:       true
    search_fields:

        # Defaults:
        - title
        - excerpt.title
        - excerpt.description
        - excerpt.seo.title
        - excerpt.seo.description
        - excerpt.seo.keywords
        - teaser_description

Troubleshooting

Add bundles to AbstractKernel

The bundle need to be registered after the SuluCoreBundle and SuluDocumentManagerBundle. This should be done automatically by Symfony Flex, if that fails for some reason you have to do it manually:

/* config/bundles.php */
       	
Sulu\Bundle\ArticleBundle\SuluArticleBundle::class => ['all' => true],
ONGR\ElasticsearchBundle\ONGRElasticsearchBundle::class => ['all' => true],