Skip to content
  • Documentation >
  • Update and migration >
  • Update from v3.3 >
  • Update to v3.3.latest

Update from v3.3.x to v3.3.latest

This update procedure applies if you are using a v3.3 installation without the latest maintenance release. To update from an 3.2 to 3.3, see Updating the app to v3.3. From older version, explore this section.

Go through the following steps to update to the latest maintenance release of v3.3 (v3.3.40).

Note

You can only update to the latest patch release of 3.3.x.

Update the application

Note

If you are using v3.3.15 or earlier v3.3 version, or encounter an error related to flex.ibexa.co, you need to update your Flex server first.

Run:

1
composer require ibexa/content:3.3.40 --with-all-dependencies --no-scripts

1
composer require ibexa/experience:3.3.40 --with-all-dependencies --no-scripts

1
composer require ibexa/commerce:3.3.40 --with-all-dependencies --no-scripts

To avoid deprecations when updating from an older PHP version to PHP 8.2 or 8.3, run the following commands:

1
2
composer config extra.runtime.error_handler "\\Ibexa\\Contracts\\Core\\MVC\\Symfony\\ErrorHandler\\Php82HideDeprecationsErrorHandler"
composer dump-autoload

Update Flex server

The flex.ibexa.co Flex server has been disabled. If you are using v3.3.15 or earlier v3.3 version, you need to update your Flex server. In your composer.json check whether the https://flex.ibexa.co endpoint is still listed in extra.symfony.endpoint. If that's the case, you need to perform the following update procedure.

First, update the symfony/flex bundle to handle the new endpoint:

1
composer update symfony/flex --no-plugins --no-scripts;

Then, replace the https://flex.ibexa.co endpoint with the new https://api.github.com/repos/ibexa/recipes/contents/index.json?ref=flex/main endpoint in composer.json under extra.symfony.endpoint.

You can do it manually, or by running the following command:

1
composer config extra.symfony.endpoint "https://api.github.com/repos/ibexa/recipes/contents/index.json?ref=flex/main"

Next, continue with updating the app:

1
2
composer recipes:install ibexa/content --force -v
composer run post-install-cmd

1
2
composer recipes:install ibexa/experience --force -v
composer run post-install-cmd

1
2
composer recipes:install ibexa/commerce --force -v
composer run post-install-cmd

Review the changes to make sure your custom configuration wasn't affected.

Remove the vendor folder to prevent issues related to the new Flex server.

Then, perform a database upgrade and other steps relevant to the version you are updating to.

Clear Redis cache

If you are using Redis as your persistence cache storage you should always clear it manually after an upgrade. You can do it by executing the following command:

1
php bin/console cache:pool:clear cache.redis

v3.3.2

Update entity managers

Version v3.3.2 introduces new entity managers. To ensure that they work in multi-repository setups, you must update the Doctrine schema. You do this manually by following this procedure:

  1. Update your project to v3.3.2 and run the php bin/console cache:clear command to generate the service container.

  2. Run the following command to discover the names of the new entity managers. Take note of the names that you discover:

    php bin/console debug:container --parameter=doctrine.entity_managers --format=json | grep ibexa_

  3. For every entity manager prefixed with ibexa_, run the following command:

    php bin/console doctrine:schema:update --em=<ENTITY_MANAGER_NAME> --dump-sql

  4. Review the queries and ensure that there are no harmful changes that could affect your data.

  5. For every entity manager prefixed with ibexa_, run the following command to run queries on the database:

    php bin/console doctrine:schema:update --em=<ENTITY_MANAGER_NAME> --force

VCL configuration for Fastly

If you use Fastly, deploy the most up-to-date VCL configuration.

Locate the vendor/ezsystems/ezplatform-http-cache-fastly/fastly/ez_main.vcl file, make sure that it has been updated with the following changes, and upload it to your Fastly:

  • Add the following lines:
1
2
3
if (req.restarts == 0 && resp.status == 301 && req.http.x-fos-original-url) {
    set resp.http.location = regsub(resp.http.location, "/_fos_user_context_hash", req.http.x-fos-original-url);
}
  • Move the #FASTLY recv macro call to a new location, right after the Preserve X-Forwarded-For in all requests section.

Optimize workflow queries

Run the following SQL queries to optimize workflow performance:

1
2
CREATE INDEX idx_workflow_co_id_ver ON ezeditorialworkflow_workflows(content_id, version_no);
CREATE INDEX idx_workflow_name ON ezeditorialworkflow_workflows(workflow_name);

Enable Commerce features

Commerce features in Experience and Content editions are disabled by default. If you use these features, after the update enable Commerce features by going to config\packages\ecommerce.yaml and setting the following:

1
2
3
4
5
ezplatform:
    system:
        default:
            commerce:
                enabled: true

Next, run the following command:

1
php bin/console ibexa:upgrade --force

Database update

If you are using MySQL, run the following update script:

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

v3.3.4

Migration Bundle

Remove Kaliop\eZMigrationBundle\eZMigrationBundle::class => ['all' => true], from config/bundles.php before running composer require.

Then, in composer.json, set minimum stability to stable:

1
"minimum-stability": "stable",

v3.3.6

Symfony 5.3

To update to Symfony 5.3, update the following package versions in your composer.json, including the Symfony version (line 9):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
"symfony/flex": "^1.3.1"
"sensio/framework-extra-bundle": "^6.1",
"symfony/runtime": "*",
"doctrine/doctrine-bundle": "^2.4"
"symfony/maker-bundle": "^1.0",

"symfony": {
    "allow-contrib": true,
    "require": "5.3.*",
    "endpoint": "https://flex.ibexa.co"
},

See https://github.com/ibexa/website-skeleton/pull/5/files for details of the package version change.

v3.3.7

Commerce configuration

If you are using Commerce, run the following migration action to update the way Commerce configuration is stored:

1
2
3
mkdir --parent src/Migrations/Ibexa/migrations
cp vendor/ibexa/installer/src/bundle/Resources/install/migrations/content/Components/move_configuration_to_settings.yaml src/Migrations/Ibexa/migrations/
php bin/console ibexa:migrations:migrate --file=move_configuration_to_settings.yaml

Database update

Run the following scripts:

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

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

Ibexa Open Source

If you have no access to Ibexa DXP's ibexa/installer package, apply the following database upgrade script:

1
2
3
4
5
6
7
8
9
DROP TABLE IF EXISTS `ibexa_setting`;
CREATE TABLE `ibexa_setting` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `group` varchar(128) COLLATE utf8mb4_unicode_520_ci NOT NULL,
  `identifier` varchar(128) COLLATE utf8mb4_unicode_520_ci NOT NULL,
  `value` text COLLATE utf8mb4_unicode_520_ci NOT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `ibexa_setting_group_identifier` (`group`, `identifier`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;

1
2
3
4
5
6
7
8
9
DROP TABLE IF EXISTS ibexa_setting;
CREATE TABLE ibexa_setting (
  id SERIAL NOT NULL,
  "group" varchar(128) NOT NULL,
  identifier varchar(128) NOT NULL,
  value json NOT NULL,
  PRIMARY KEY (id),
  CONSTRAINT ibexa_setting_group_identifier UNIQUE ("group", identifier)
);

v3.3.9

Database update

Run the following scripts:

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

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

v3.3.13

Symfony 5.4

Prior to v3.3.13, Symfony 5.3 was used by default.

If you are still using Symfony 5.3, you need to update your installation to Symfony 5.4. To do this, update your composer.json to refer to 5.4.* instead or 5.3.*.

Refer to the relevant website skeleton: content, experience, commerce.

The following sed commands should update the relevant lines. Use them with caution and properly check the result:

1
2
sed -i -E 's/"symfony\/(.+)": "5.3.*"/"symfony\/\1": "5.4.*"/' composer.json;
sed -i -E 's/"require": "5.3.*"/"require": "5.4.*"/' composer.json;

After this composer.json update, run composer update "symfony/*".

You may need to adapt configuration to fit the new minor version of Symfony. For example, you might have to remove timeout related config from nelmio_solarium bundle config:

1
2
sed -i -E '/ *timeout: [0-9]+/d' ./config/packages/nelmio_solarium.yaml ./config/packages/ezcommerce/ezcommerce_advanced.yaml
composer update "symfony/*"

Ibexa Cloud

Update Platform.sh configuration and scripts.

Generate new configuration with the following command:

1
composer ibexa:setup --platformsh

Review the changes applied to .platform.app.yaml, .platform/ and bin/platformsh_prestart_cacheclear.sh, merge with your custom settings if needed, and commit them to Git.

v3.3.14

VCL configuration

Update your Varnish VCL file to align with docs/varnish/vcl/varnish5.vcl. Make sure it contains the highlighted additions.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
// Compressing the content
// ...

// Modify xkey header to add translation suffix
if (beresp.http.xkey && beresp.http.x-lang) {
    set beresp.http.xkey = beresp.http.xkey + " " + regsuball(beresp.http.xkey, "(\S+)", "\1" + beresp.http.x-lang);
}

// ...

if (client.ip ~ debuggers) {
/// ...
} else {
    // Remove tag headers when delivering to non debug client
    unset resp.http.xkey;
    unset resp.http.x-lang;
    // Sanity check to prevent ever exposing the hash to a non debug client.
    unset resp.http.x-user-context-hash;
}

v3.3.15

Adapt your composer.json file according to manifest.json, by adding and moving the following lines:

1
2
3
4
5
6
7
8
9
  "composer-scripts": {
    "cache:clear": "symfony-cmd",
    "assets:install %PUBLIC_DIR%": "symfony-cmd",
-    "bazinga:js-translation:dump %PUBLIC_DIR%/assets --merge-domains": "symfony-cmd",
    "yarn install": "script",
+    "ibexa:encore:compile --config-name app": "symfony-cmd",
+    "bazinga:js-translation:dump %PUBLIC_DIR%/assets --merge-domains": "symfony-cmd",
    "ibexa:encore:compile": "symfony-cmd"
  }

v3.3.16

See Update Flex server.

v3.3.24

VCL configuration for Fastly

Ibexa DXP now supports Fastly shielding. If you are using Fastly and want to use shielding, you need to update your VCL files.

Tip

Even if you do not plan to use Fastly shielding, it is recommended to update the VCL files for future compatibility.

  1. Locate the vendor/ezsystems/ezplatform-http-cache-fastly/fastly/ez_main.vcl file and update your VCL file with the recent changes.
  2. Do the same with vendor/ezsystems/ezplatform-http-cache-fastly/fastly/ez_user_hash.vcl.
  3. Upload a new snippet_re_enable_shielding.vcl snippet file, based on vendor/ezsystems/ezplatform-http-cache-fastly/fastly/snippet_re_enable_shielding.vcl.

v3.3.25

Database update

On Experience or Commerce edition, run the following scripts:

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

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

v3.3.28

Ensure password safety

Following Security advisory: IBEXA-SA-2022-009, unless you can verify based on your log files that the vulnerability hasn't been exploited, you should revoke passwords for all affected users.

v3.3.34

Database update

Run the following scripts:

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

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

v3.3.40

A command to deal with duplicated database entries, as reported in IBX-8562, will be available soon.

Finish the update

A. Platform.sh changes

If you are hosting your site on Ibexa Cloud be aware of the fact that Varnish is enabled by default as of v1.13.5, v2.4.3 and v2.5.0. If you are using Fastly, read about how to disable Varnish.

B. Dump assets

Dump web assets if you are using the prod environment. In dev this happens automatically:

1
2
yarn install
yarn encore prod

If you encounter problems, additionally clear the cache and install assets:

1
2
3
4
php bin/console cache:clear -e prod
php bin/console assets:install --symlink -e prod
yarn install
yarn encore prod

C. Commit, test and merge

When you resolve all conflicts and update composer.lock, commit the merge.

You may or may not keep composer.lock, depending on your version management workflow. If you do not want to keep it, run git reset HEAD composer.lock to remove it from the changes. Run git commit, and adapt the message if necessary.

Go back to master, and merge the update-{{ target_version }} branch:

1
2
git checkout master
git merge update-{{ target_version }}

Insecure password hashes

To ensure that no users have unsupported, insecure password hashes, run the following command:

1
2
3
4
# In v1 and v2:
php bin/console ezplatform:user:validate-password-hashes
# In v3:
php bin/console ibexa:user:validate-password-hashes

This command checks if all user hashes are up-to-date and informs you if any of them need to be updated.

D. Complete the update

Complete the update by running the following commands:

1
2
3
4
5
6
# In v2.5:
php bin/console ezplatform:graphql:generate-schema
# In v3:
php bin/console ibexa:graphql:generate-schema

composer run post-install-cmd

Notify support

Please tell support that you have updated your installation. They will update your support portal to match the new version. This ensures that you receive notifications about new maintenance releases and security advisories for the correct version. You can contact support at support@ibexa.co or through your Support portal.