Skip to content
  • Documentation >
  • Update and migration >
  • Update from v5.0 >
  • Update to v5.0

Update from v5.0.x to v5.0.latest

To update from v4.6.x, see Update from v4.6 to v5.0. To update from an older version, visit the update page and choose the applicable path.

Update the application

Note which version you actually have before starting.

First, run:

1
2
composer require ibexa/headless:5.0.4 --with-all-dependencies --no-scripts
composer recipes:install ibexa/headless --force -v

1
2
composer require ibexa/experience:5.0.4 --with-all-dependencies --no-scripts
composer recipes:install ibexa/experience --force -v

1
2
composer require ibexa/commerce:5.0.4 --with-all-dependencies --no-scripts
composer recipes:install ibexa/commerce --force -v

Then execute the instructions below starting from the version you're upgrading from.

v5.0.1

Some packages increase their type hinting strictness. You can run Ibexa DXP Rector to update your code.

v5.0.2

Database update

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
CREATE TABLE ibexa_messenger_messages (
    id BIGINT AUTO_INCREMENT NOT NULL,
    body LONGTEXT NOT NULL,
    headers LONGTEXT NOT NULL,
    queue_name VARCHAR(190) NOT NULL,
    created_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)',
    available_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)',
    delivered_at DATETIME DEFAULT NULL COMMENT '(DC2Type:datetime_immutable)',
    INDEX ibexa_messenger_created_at_idx (created_at),
    INDEX ibexa_messenger_available_at_idx (available_at),
    INDEX ibexa_messenger_delivered_at_idx (delivered_at),
    PRIMARY KEY(id)
) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_520_ci` ENGINE = InnoDB;

CREATE TABLE ibexa_messenger_lock_keys (
    key_id VARCHAR(64) NOT NULL,
    key_token VARCHAR(44) NOT NULL,
    key_expiration INT UNSIGNED NOT NULL,
    PRIMARY KEY(key_id)
) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_520_ci` ENGINE = InnoDB;

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
CREATE TABLE ibexa_messenger_messages (
    id BIGSERIAL NOT NULL,
    body TEXT NOT NULL,
    headers TEXT NOT NULL,
    queue_name VARCHAR(190) NOT NULL,
    created_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL,
    available_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL,
    delivered_at TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL,
    PRIMARY KEY(id)
);

CREATE INDEX ibexa_messenger_created_at_idx ON ibexa_messenger_messages (created_at);

CREATE INDEX ibexa_messenger_available_at_idx ON ibexa_messenger_messages (available_at);

CREATE INDEX ibexa_messenger_delivered_at_idx ON ibexa_messenger_messages (delivered_at);

COMMENT ON COLUMN ibexa_messenger_messages.created_at IS '(DC2Type:datetime_immutable)';

COMMENT ON COLUMN ibexa_messenger_messages.available_at IS '(DC2Type:datetime_immutable)';

COMMENT ON COLUMN ibexa_messenger_messages.delivered_at IS '(DC2Type:datetime_immutable)';

CREATE TABLE ibexa_messenger_lock_keys (
    key_id VARCHAR(64) NOT NULL,
    key_token VARCHAR(44) NOT NULL,
    key_expiration INT NOT NULL,
    PRIMARY KEY(key_id)
);

On Commerce, run this additional update queries:

1
2
3
4
5
ALTER TABLE ibexa_discount
    ADD indexed_at DATETIME DEFAULT NULL COMMENT '(DC2Type:datetime_immutable)';

CREATE INDEX ibexa_discount_indexed_at_idx
    ON ibexa_discount (indexed_at);

1
2
3
4
5
6
7
ALTER TABLE ibexa_discount
    ADD indexed_at TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL;

COMMENT ON COLUMN ibexa_discount.indexed_at IS '(DC2Type:datetime_immutable)';

CREATE INDEX ibexa_discount_indexed_at_idx
    ON ibexa_discount (indexed_at);

v5.0.3

Form Builder performance fix: missing indexes on form submission data

In large production databases, the ibexa_form_submission and ibexa_form_submission_data tables may contain a lot of rows. Missing indexes can cause high CPU load and slow queries.

Run the provided SQL upgrade script to add the missing indexes to your database:

1
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-5.0.2-to-5.0.3.sql

1
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-5.0.2-to-5.0.3.sql

v5.0.4

Database update

From a platform first installed on v5.0.3 or updated precisely to v5.0.3, you need to execute the requests below. If the platform comes from lower than v5.0.3 and is updated to higher than v5.0.3, you don't need this part (but if you run the requests anyway, you only obtain error messages, nothing being broken or lost).

1
2
3
4
5
6
ALTER TABLE `ibexa_site_public_access` ADD COLUMN `tree_root_location_id` INT DEFAULT NULL;
ALTER TABLE `ibexa_site_public_access` ADD INDEX `ibexa_spa_trl_id` (`tree_root_location_id`);

UPDATE ibexa_site_public_access
  SET tree_root_location_id = CAST(JSON_UNQUOTE(JSON_EXTRACT(config, '$."ibexa.site_access.config.content.tree_root.location_id"')) AS SIGNED)
  WHERE tree_root_location_id IS NULL AND JSON_EXTRACT(config, '$."ibexa.site_access.config.content.tree_root.location_id"') IS NOT NULL;

1
2
3
4
5
6
ALTER TABLE ibexa_site_public_access ADD COLUMN tree_root_location_id INT DEFAULT NULL;
CREATE INDEX "ibexa_spa_trl_id" ON "ibexa_site_public_access" ("tree_root_location_id");

UPDATE ibexa_site_public_access
  SET tree_root_location_id = (config::jsonb ->> 'ibexa.site_access.config.content.tree_root.location_id')::integer
  WHERE tree_root_location_id IS NULL AND config::jsonb ? 'ibexa.site_access.config.content.tree_root.location_id';

v5.0.5

Elasticsearch 8 support

As of v5.0.5, Ibexa DXP adds support for Elasticsearch 8.19 or higher. You can continue using unsupported Elasticsearch 7.16.2+, but it's recommended to upgrade to Elasticsearch 8 for improved performance and security features.

When choosing to keep using Elasticsearch 7.16.2, adjust your configuration as described in the Update configuration section below to avoid using deprecated settings.

If you choose to upgrade to Elasticsearch 8, follow these steps:

Update Elasticsearch server

Upgrade your Elasticsearch server to version 8.19 or higher. Follow the Elasticsearch upgrade guide for detailed instructions.

When using Ibexa Cloud, see Elasticsearch service for a list of supported versions.

Update configuration

Update your configuration in config/packages/ibexa_elasticsearch.yaml.

Replace deprecated connection pool settings

The deprecated connection_pool and connection_selector settings are now ignored and don't have any effect. Replace them with appropriate node_pool_selector and node_pool_resurrect settings:

1
2
3
4
5
6
# Old configuration (Elasticsearch 7 - deprecated)
ibexa_elasticsearch:
    connections:
        default:
            connection_pool: 'Elasticsearch\ConnectionPool\StaticNoPingConnectionPool'
            connection_selector: 'Elasticsearch\ConnectionPool\Selectors\RoundRobinSelector'

1
2
3
4
5
6
# New configuration (Elasticsearch 7 and 8)
ibexa_elasticsearch:
    connections:
        default:
            node_pool_selector: 'Elastic\Transport\NodePool\Selector\RoundRobin'
            node_pool_resurrect: 'Elastic\Transport\NodePool\Resurrect\NoResurrect'

For more information, see Node pool settings.

Remove trace option

The trace debugging option is no longer available.

1
2
3
4
5
6
# Old configuration (Elasticsearch 7)
ibexa_elasticsearch:
    connections:
        default:
            debug: true
            trace: true

1
2
3
4
5
6
# New configuration (Elasticsearch 7 and 8)
ibexa_elasticsearch:
    connections:
        default:
            debug: true
            # Trace option is no longer available

Reindex content

After upgrading to Elasticsearch 8 and updating your configuration, reindex the search engine:

  1. Push the index templates:

    1
    php bin/console ibexa:elasticsearch:put-index-template --overwrite

  2. Reindex your content:

    ``` bash php bin/console ibexa:reindex

Database update

Run the provided SQL upgrade script to ensure the Messenger tables for background tasks exist in your database:

1
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-5.0.4-to-5.0.5.sql

1
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-5.0.4-to-5.0.5.sql

LTS Updates and additional packages

LTS Updates are standalone packages with their own update procedures. To use the latest features added to them, update them separately with the following commands:

Integrated help

See Integrated help for more information.

If you're already using it, run the following command to get the latest version of this feature:

1
composer require ibexa/integrated-help:5.0.4

Anthropic connector

See how to configure Anthropic connector for more information.

If you're already using it, run the following command to get the latest version of this feature:

1
composer require ibexa/connector-anthropic:5.0.4

Real-time collaborative editing

To learn more about the Real-time editing, see the installation and configuration instructions.

If you're already using it, run the following command to get the latest version of this feature:

1
composer require ibexa/fieldtype-richtext-rte:5.0.4 ibexa/ckeditor-premium:5.0.4