Skip to content

INSTALL.md

Latest commit

 

History

History
66 lines (41 loc) · 1.79 KB

INSTALL.md

File metadata and controls

66 lines (41 loc) · 1.79 KB

Netgen Tags Bundle installation instructions

Requirements

  • Ibexa DXP 5.0+

Installation steps

Use Composer

Run the following from your website root folder to install Netgen Tags Bundle:

$ composer require netgen/tagsbundle

Add routing configuration

Add the file config/routes/netgen_tags.yaml with the following content to activate Netgen Tags routes:

netgen_tags:
    resource: "@NetgenTagsBundle/Resources/config/routing.yaml"

Import database tables

Netgen Tags Bundle uses custom database tables to store the tags. Use the following command to add the tables to your Ibexa database:

$ mysql -u<user> -p<password> -h<host> <db_name> < vendor/netgen/tagsbundle/bundle/Resources/sql/mysql/schema.sql

PostgreSQL variant of the above schema file is also available at vendor/netgen/tagsbundle/bundle/Resources/sql/postgresql/schema.sql

Note: Netgen Tags supports Ibexa schema builder, making it possible to automatically install its database tables when installing clean/demo data of Ibexa. In that case, there's no need to install the tables manually.

Update Anonymous Role permissions

Give 'Read' permissions to the 'Tags' module for the Anonymous role otherwise the field value is empty

Clear the caches

Clear the caches with the following command:

$ php bin/console cache:clear

Install assets

Run the following to correctly install assets for Ibexa Admin UI:

$ php bin/console assets:install --symlink --relative

Use the bundle

  1. You can now load and create content with eztags field type

  2. Use TagsService in your controllers to work with tags. The service is accessible through Symfony DIC, with ID netgen_tags.api.service.tags