| description | month_change |
|---|---|
Update your installation to the latest v4.6 version from an earlier v4.6 version. |
false |
Note which version you actually have before starting.
First, run:
=== "[[= product_name_headless =]]"
``` bash
composer require ibexa/headless:[[= latest_tag_4_6 =]] --with-all-dependencies --no-scripts
composer recipes:install ibexa/headless --force -v
```=== "[[= product_name_exp =]]"
``` bash
composer require ibexa/experience:[[= latest_tag_4_6 =]] --with-all-dependencies --no-scripts
composer recipes:install ibexa/experience --force -v
```=== "[[= product_name_com =]]"
``` bash
composer require ibexa/commerce:[[= latest_tag_4_6 =]] --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.
!!! caution
To avoid deprecations when using PHP 8.2 or 8.3, run the following commands:
``` bash
composer config extra.runtime.error_handler "\\Ibexa\\Contracts\\Core\\MVC\\Symfony\\ErrorHandler\\Php82HideDeprecationsErrorHandler"
composer dump-autoload
```No additional steps needed.
Run the following scripts:
=== "MySQL"
``` bash
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-4.6.1-to-4.6.2.sql
```=== "PostgreSQL"
``` bash
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-4.6.1-to-4.6.2.sql
```The configuration of the package ibexa/notifications has changed.
This package is required by other packages, such as ibexa/connector-actito for Transactional emails, ibexa/payment, or ibexa/user.
If you are customizing the configuration of the ibexa/notifications package, and using SiteAccess aware configuration to change the Notification subscriptions, you have to manually change your configuration by using the new node name notifier instead of the old notifications.
For example, the following v4.6.2 config:
ibexa:
system:
my_siteacces_name:
notifications: # old
subscriptions:
Ibexa\Contracts\Shipping\Notification\ShipmentStatusChange:
channels:
- smsbecomes the following from v4.6.3:
ibexa:
system:
my_siteacces_name:
notifier: # new
subscriptions:
Ibexa\Contracts\Shipping\Notification\ShipmentStatusChange:
channels:
- smsRun the following scripts:
=== "MySQL"
``` bash
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-4.6.3-to-4.6.4.sql
```=== "PostgreSQL"
``` bash
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-4.6.3-to-4.6.4.sql
```No additional steps needed.
No additional steps needed.
No additional steps needed.
No additional steps needed.
No additional steps needed.
No additional steps needed.
Update Platform.sh configuration for PHP and Varnish.
Generate new configuration with the following command:
composer ibexa:setup --platformshReview the changes applied to .platform.app.yaml and .platform/,
merge with your custom settings if needed, and commit them to Git.
If the new bundle ibexa/core-search has not been added by the recipes, enable it by adding the following line in config/bundles.php:
Ibexa\Bundle\CoreSearch\IbexaCoreSearchBundle::class => ['all' => true],This release comes with a command to clean up duplicated entries in the ezcontentobject_attribute table, which were created due to an issue described in IBX-8562.
If you're affected, remove the duplicated entries by running the following command:
php bin/console ibexa:content:remove-duplicate-fields!!! caution
Remember about [**proper database backup**](backup.md) before running the command in the production environment.You can customize the behavior of the command with the following options:
--batch-sizeor-b- number of attributes affected per iteration. Default value = 10000.--max-iterationsor-i- maximum iterations count. Default value = -1 (unlimited).--sleepor-s- wait time between iterations, in milliseconds. Default value = 0.
This release contains security fixes. For more information, see the published security advisory. For each of the following fixes, evaluate the vulnerability to determine whether you might have been affected. If so, take appropriate action, for example by revoking passwords for all affected users.
The BREACH attack is a security vulnerability against HTTPS when using HTTP compression.
If you're using Varnish, update the VCL configuration to stop compressing both the [[= product_name =]]'s REST API and JSON responses from your backend. Fastly users are not affected.
=== "Varnish on [[= product_name_cloud =]]"
Update Platform.sh configuration and scripts.
Generate new configuration with the following command:
```bash
composer ibexa:setup --platformsh
```
Review the changes, merge with your custom settings if needed, and commit them to Git before deployment.=== "Varnish 6"
Update your Varnish VCL file to align it with the [`vendor/ibexa/http-cache/docs/varnish/vcl/varnish6.vcl`](https://github.com/ibexa/http-cache/blob/4.6/docs/varnish/vcl/varnish6.vcl) file.=== "Varnish 7"
Update your Varnish VCL file to align it with the [`vendor/ibexa/http-cache/docs/varnish/vcl/varnish7.vcl`](https://github.com/ibexa/http-cache//blob/4.6/docs/varnish/vcl/varnish7.vcl) file.
```If you're not using a reverse proxy like Varnish or Fastly, adjust the compressed Content-Type in the web server configuration.
For more information, see the updated Apache and nginx template configuration.
There are no additional update steps to execute.
Only users of the old Commerce solution are affected. There are no additional update steps to execute.
The possibility of translating identifiers and parent information for the Categories in Product Catalog might lead to data consistency issues.
Disable it by running the following migration:
php bin/console ibexa:migrations:import vendor/ibexa/product-catalog/src/bundle/Resources/migrations/2024_07_25_07_00_non_translatable_product_categories.yaml --name=2024_07_25_07_00_non_translatable_product_categories.yaml
php bin/console ibexa:migrations:migrate --file=2024_07_25_07_00_non_translatable_product_categories.yamlAdjust the web server configuration to prevent direct access to the index.php file when using URLs consisting of multiple path segments.
See the updated Apache and nginx template files for more information.
This release no longer directly requires the symfony/orm-pack and symfony/serializer-pack Composer dependencies, which can remove some dependencies from your project during the update process.
If you rely on them in your project, for example by using Symfony's ObjectNormalizer to create your own REST endpoints, run the following command before updating [[= product_name_base =]] packages:
composer require symfony/serializer-pack symfony/orm-packThen, verify that Symfony Flex installed the versions you were using before.
No additional steps needed.
This release contains security fixes. For more information, see the published security advisory. For each of the following fixes, evaluate the vulnerability to determine whether you might have been affected. If so, take appropriate action.
This release fixes a critical vulnerability in the REST API regarding shopping carts. There are no additional update steps to execute.
This release fixes vulnerability in publish scheduling, ensures that edit/create policies are correctly checked.
There are no additional update steps to execute.
This release upgrades the requirements for Twig to v3.19 and PHPSpreadsheet to v1.29.9, resolving several vulnerabilities of varying severity in those dependencies. There are no additional update steps to execute.
No additional steps needed.
This release fixes a critical vulnerability in the RichText field type. By entering a maliciously crafted input into the RichText field type's XML, the attacker could perform an attack using XML external entity (XXE) injection. To exploit this vulnerability, an attacker would need to have edit permission to content with RichText fields.
For more information, see the published security advisory IBEXA-SA-2025-002.
Evaluate the vulnerability to determine whether you might have been affected. If so, take appropriate action. There are no additional update steps to execute.
The new Ibexa Rector package is now available. It's an optional package based on Rector and comes with additional rules for working with Ibexa code.
You can use it to get rid of PHP code deprecations and start preparing your project for the next major release.
!!! note
[[= product_name_base =]] Rector requires PHP 8.3 and you must upgrade your codebase first.
To do it, you can use Rector and the [existing PHP upgrade sets](https://getrector.com/documentation/integration-to-new-project#content-2-upgrade-php-first).To get started with [[= product_name_base =]] Rector, execute the following steps:
- Add the Composer dependency:
composer require --dev ibexa/rector:^4.6-
Adjust the created
rector.phpconfiguration file to match your project structure -
Run Rector in the dry-run mode to preview the changes:
vendor/bin/rector --dry-run- Run Rector:
vendor/bin/rectorNo additional steps needed.
This security advisory resolves XSS vulnerabilities in several parts of the back office of the DXP. Back office access and varying levels of editing and management permissions are required to exploit these vulnerabilities.
For more information, see the security advisory IBEXA-SA-2025-003.
Evaluate the vulnerability to determine whether you might have been affected. If so, take appropriate action. There are no additional update steps to execute.
Run the following scripts:
=== "MySQL"
``` bash
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-4.6.20-to-4.6.21.sql
```=== "PostgreSQL"
``` bash
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-4.6.20-to-4.6.21.sql
```This release adds support for Solr 9.
To update Solr within an existing [[= product_name =]] project, first refer to the Solr 9 upgrade planning instructions.
Then, follow the instructions for setting up Solr 9 with [[= product_name =]] and merge them with your custom configuration.
Changes include:
-
Configuration files
- the
schema.xmlconfiguration file becamemanaged-schema.xml - the removed
LatLonTypefield is replaced by theLatLonPointSpatialFieldfield
- the
Once Solr 9 is fully configured, refresh the search index.
Set character set for activity log tables [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]
When using MySQL or MariaDB, run the following script to ensure correct character set for activity log tables:
=== "MySQL"
``` bash
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-4.6.21-to-4.6.22.sql
```No additional steps needed.
=== "MySQL"
``` bash
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-4.6.23-to-4.6.24.sql
```=== "PostgreSQL"
``` bash
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-4.6.23-to-4.6.24.sql
```Form Builder performance fix: missing indexes on form submission data [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]
In large production databases, the ezform_form_submissions and ezform_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:
=== "MySQL"
``` bash
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-4.6.24-to-4.6.25.sql
```=== "PostgreSQL"
``` bash
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-4.6.24-to-4.6.25.sql
```No additional steps needed.
As of v4.6.27, [[= product_name =]] adds optional support for Elasticsearch 8.19 or higher through the new ibexa/elasticsearch8 package.
By default, [[= product_name =]] continues to support Elasticsearch 7.16.2+ with the ibexa/elasticsearch package.
To use Elasticsearch 8, follow these steps:
Replace the existing Elasticsearch package and install Elasticsearch 8:
composer require ibexa/elasticsearch8:[[= latest_tag_4_6 =]]Upgrade your Elasticsearch server to version 8.19 or higher. For detailed instructions, follow the Elasticsearch upgrade guide.
When you use [[= product_name_cloud =]], see Elasticsearch service for a list of supported versions.
Update your configuration in config/packages/ibexa_elasticsearch.yaml as decribed below:
The connection_pool and connection_selector settings are ignored when using Elasticsearch 8.
Replace them with appropriate node_pool_selector and node_pool_resurrect settings:
# Elasticsearch 7 configuration
ibexa_elasticsearch:
connections:
default:
connection_pool: 'Elasticsearch\ConnectionPool\StaticNoPingConnectionPool'
connection_selector: 'Elasticsearch\ConnectionPool\Selectors\RoundRobinSelector'# Elasticsearch 8 configuration
ibexa_elasticsearch:
connections:
default:
node_pool_selector: 'Elastic\Transport\NodePool\Selector\RoundRobin'
node_pool_resurrect: 'Elastic\Transport\NodePool\Resurrect\NoResurrect'For more information, see Connection pool and node pool settings.
The trace debugging option is no longer available in Elasticsearch 8:
# Elasticsearch 7 configuration
ibexa_elasticsearch:
connections:
default:
debug: true
trace: true# Elasticsearch 8 configuration
ibexa_elasticsearch:
connections:
default:
debug: true
# Trace option is no longer availableAfter upgrading to Elasticsearch 8 and updating your configuration, reindex the search engine:
-
Push the index templates:
php bin/console ibexa:elasticsearch:put-index-template --overwrite
-
Reindex your content:
php bin/console ibexa:reindex
The following unused Composer dependencies have been removed from ibexa/core:
guzzlehttp/guzzlephp-http/guzzle6-adapter
If your project uses Guzzle directly, you should add these dependencies to your project's composer.json file.
To check if you need to add these dependencies, run:
composer why guzzlehttp/guzzle
composer why php-http/guzzle6-adapterIf only the ibexa/core entry appears in the output, check your codebase to determine if you use Guzzle directly.
If you do, add the required dependencies to your project:
composer require guzzlehttp/guzzle:^6.5 php-http/guzzle6-adapter:^2.0If you're using CDP and haven't configured Ibexa Messenger yet, do so now. Follow the Messenger setup instructions to continue.
[[% include 'snippets/update/notify_support.md' %]]
With the product updated to the latest version, you can now finish the update process or proceed to updating the LTS Updates 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:
=== "Discounts"
### Discounts [[% include 'snippets/lts-update_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]
To install the [Discounts feature](discounts_guide.md), see the [installation instructions](https://doc.ibexa.co/en/4.6/discounts/install_discounts/).
If you're already using it, run the following command to get the latest version of this feature:
```bash
composer require ibexa/discounts:[[= latest_tag_4_6 =]] ibexa/discounts-codes:[[= latest_tag_4_6 =]]
```
Then apply manually the changes described below.
### Discounts v4.6.20
#### Policy changes
The `discount/view` policy is no longer required for the store customers to use a discount and must be removed from all users who are not managing discounts.
The policy allows to access all the discount details, including the coupon codes to activate them, which could lead to system abuse.
To learn more, see the [discounts policies overview](https://doc.ibexa.co/en/4.6/permissions/policies/).
#### Database update
Run the following scripts:
=== "MySQL"
``` sql
CREATE TABLE ibexa_discount_code_usage (
id INT AUTO_INCREMENT NOT NULL,
discount_code_id INT NOT NULL,
order_id INT NOT NULL,
discriminator VARCHAR(10) NOT NULL,
used_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)',
INDEX ibexa_discount_code_usage_discount_code_idx (discount_code_id),
INDEX ibexa_discount_code_usage_order_idx (order_id),
PRIMARY KEY(id)
) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_520_ci` ENGINE = InnoDB;
CREATE TABLE ibexa_discount_code_usage_email (
id INT NOT NULL,
user_email VARCHAR(190) DEFAULT NULL,
INDEX ibexa_discount_code_usage_email_idx (user_email),
UNIQUE INDEX ibexa_discount_codes_usage_email_uidx (id, user_email),
PRIMARY KEY(id)
) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_520_ci` ENGINE = InnoDB;
CREATE TABLE ibexa_discount_code_usage_user (
id INT NOT NULL,
user_id INT DEFAULT NULL,
INDEX ibexa_discount_code_usage_user_idx (user_id),
UNIQUE INDEX ibexa_discount_codes_usage_user_uidx (id, user_id),
PRIMARY KEY(id)
) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_520_ci` ENGINE = InnoDB;
ALTER TABLE ibexa_discount_code_usage
ADD CONSTRAINT ibexa_discount_code_usage_code_fk FOREIGN KEY (discount_code_id)
REFERENCES ibexa_discount_code (id) ON UPDATE CASCADE ON DELETE CASCADE;
ALTER TABLE ibexa_discount_code_usage
ADD CONSTRAINT ibexa_discount_code_usage_order_fk FOREIGN KEY (order_id)
REFERENCES ibexa_order (id) ON UPDATE CASCADE ON DELETE CASCADE;
ALTER TABLE ibexa_discount_code_usage_email
ADD CONSTRAINT ibexa_discount_code_usage_email_fk FOREIGN KEY (id)
REFERENCES ibexa_discount_code_usage (id) ON UPDATE CASCADE ON DELETE CASCADE;
ALTER TABLE ibexa_discount_code_usage_user
ADD CONSTRAINT ibexa_discount_code_usage_user_fk FOREIGN KEY (id)
REFERENCES ibexa_discount_code_usage (id) ON UPDATE CASCADE ON DELETE CASCADE;
ALTER TABLE ibexa_discount_code_usage_user
ADD CONSTRAINT ibexa_discount_code_usage_user_content_fk FOREIGN KEY (user_id)
REFERENCES ezuser (contentobject_id) ON UPDATE CASCADE ON DELETE CASCADE;
```
=== "PostgreSQL"
``` sql
CREATE TABLE ibexa_discount_code_usage
(
id SERIAL NOT NULL,
discount_code_id INT NOT NULL,
order_id INT NOT NULL,
discriminator VARCHAR(10) NOT NULL,
used_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL,
PRIMARY KEY(id)
);
CREATE INDEX ibexa_discount_code_usage_discount_code_idx
ON ibexa_discount_code_usage (discount_code_id);
CREATE INDEX ibexa_discount_code_usage_order_idx
ON ibexa_discount_code_usage (order_id);
COMMENT ON COLUMN ibexa_discount_code_usage.used_at IS '(DC2Type:datetime_immutable)';
CREATE TABLE ibexa_discount_code_usage_email (
id INT NOT NULL,
user_email VARCHAR(190) DEFAULT NULL,
PRIMARY KEY(id)
);
CREATE INDEX ibexa_discount_code_usage_email_idx
ON ibexa_discount_code_usage_email (user_email);
CREATE UNIQUE INDEX ibexa_discount_codes_usage_email_uidx
ON ibexa_discount_code_usage_email (id, user_email);
CREATE TABLE ibexa_discount_code_usage_user
(
id INT NOT NULL,
user_id INT DEFAULT NULL,
PRIMARY KEY(id)
);
CREATE INDEX ibexa_discount_code_usage_user_idx
ON ibexa_discount_code_usage_user (user_id);
CREATE UNIQUE INDEX ibexa_discount_codes_usage_user_uidx
ON ibexa_discount_code_usage_user (id, user_id);
ALTER TABLE ibexa_discount_code_usage
ADD CONSTRAINT ibexa_discount_code_usage_code_fk FOREIGN KEY (discount_code_id)
REFERENCES ibexa_discount_code (id) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE;
ALTER TABLE ibexa_discount_code_usage
ADD CONSTRAINT ibexa_discount_code_usage_order_fk FOREIGN KEY (order_id)
REFERENCES ibexa_order (id) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE;
ALTER TABLE ibexa_discount_code_usage_email
ADD CONSTRAINT ibexa_discount_code_usage_email_fk FOREIGN KEY (id)
REFERENCES ibexa_discount_code_usage (id) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE;
ALTER TABLE ibexa_discount_code_usage_user
ADD CONSTRAINT ibexa_discount_code_usage_user_fk FOREIGN KEY (id)
REFERENCES ibexa_discount_code_usage (id) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE;
ALTER TABLE ibexa_discount_code_usage_user
ADD CONSTRAINT ibexa_discount_code_usage_user_content_fk FOREIGN KEY (user_id)
REFERENCES ezuser (contentobject_id) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE;
```
### Discounts v4.6.22
#### Database update
Run the following scripts:
=== "MySQL"
``` sql
ALTER TABLE ibexa_discount ADD override_prioritization tinyint(1) NOT NULL DEFAULT 0;
CREATE INDEX ibexa_discount_prioritization_idx ON ibexa_discount (override_prioritization, type, priority);
ALTER TABLE ibexa_discount_code ADD global_limit INT DEFAULT NULL;
```
=== "PostgreSQL"
``` sql
ALTER TABLE ibexa_discount ADD override_prioritization tinyint(1) NOT NULL DEFAULT 0;
CREATE INDEX ibexa_discount_prioritization_idx ON ibexa_discount (override_prioritization, type, priority);
ALTER TABLE ibexa_discount_code ADD global_limit INT DEFAULT NULL;
```
### Discounts v4.6.24
#### Database update
Run the following scripts:
=== "MySQL"
``` sql
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);
```
=== "PostgreSQL"
``` sql
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);
```=== "AI Actions"
### AI Actions [[% include 'snippets/lts-update_badge.md' %]]
To install the [AI actions feature](ai_actions_guide.md), see the [installation instructions](https://doc.ibexa.co/en/4.6/ai_actions/install_ai_actions/).
If you're already using it, run the following command to get the latest version of this feature:
```bash
composer require ibexa/connector-ai:[[= latest_tag_4_6 =]] ibexa/connector-openai:[[= latest_tag_4_6 =]]
```=== "Date and time attribute"
### Date and time attribute [[% include 'snippets/lts-update_badge.md' %]]
To install the [Date and time attribute](date_and_time.md), see the [installation instructions](https://doc.ibexa.co/en/4.6/pim/attributes/date_and_time/#installation).
If you're already using it, run the following command to get the latest version of this feature:
```bash
composer require ibexa/product-catalog-date-time-attribute:[[= latest_tag_4_6 =]]
```=== "Symbol attribute"
### Symbol attribute [[% include 'snippets/lts-update_badge.md' %]]
To install the [Symbol attribute](symbol_attribute_type.md), see the [installation instructions](https://doc.ibexa.co/en/4.6/pim/attributes/symbol_attribute_type/#installation).
If you're already using it, run the following command to get the latest version of this feature:
```bash
composer require ibexa/product-catalog-symbol-attribute:[[= latest_tag_4_6 =]]
```=== "Integrated help"
### Integrated help [[% include 'snippets/lts-update_badge.md' %]]
See [Integrated help](integrated_help.md) for more information.
If you're already using it, run the following command to get the latest version of this feature:
```bash
composer require ibexa/integrated-help:[[= latest_tag_4_6 =]]
```=== "Collaborative editing"
### Collaborative editing [[% include 'snippets/lts-update_badge.md' %]]
To learn more about the [Collaborative editing](https://doc.ibexa.co/en/latest/content_management/collaborative_editing/collaborative_editing_guide/), see the [installation instructions](https://doc.ibexa.co/en/4.6/content_management/collaborative_editing/install_collaborative_editing).
If you're already using it, run the following command to get the latest version of this feature:
```bash
composer require ibexa/share:[[= latest_tag_4_6 =]] ibexa/collaboration:[[= latest_tag_4_6 =]]
```
If you're using the Real-time collaborative editing, in addition run:
```bash
composer require ibexa/fieldtype-richtext-rte:[[= latest_tag_4_6 =]] ibexa/ckeditor-premium:[[= latest_tag_4_6 =]]
```