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

Update to latest version of v3.3

Before you start this procedure, make sure you have completed the previous step, Updating the app to v3.3.

Finally, bring your installation to the latest release of v3.3.

6. Update the database

Apply the following database update script:

Ibexa DXP

1
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ezplatform-2.5-to-ibexa-3.3.0.sql

1
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ezplatform-2.5-to-ibexa-3.3.0.sql

If you are updating from an installation based on the ezsystems/ezplatform-ee metarepository, run the following command to upgrade your database:

1
php bin/console ibexa:upgrade

Caution

You can only run this command once.

Check the Location ID of the "Components" Content item and set it as a value of the content_tree_module.contextual_tree_root_location_ids key in config/ezplatform.yaml:

1
- 60 # Components

If you are upgrading between Ibexa Commerce versions, add the content/read Policy with the Owner Limitation set to self to the "Ecommerce registered users" Role.

Ibexa Open Source

If you are upgrading to Ibexa Open Source v3.3 and have no access to ibexa/installer package, run the following SQL commands:

 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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
START TRANSACTION;
DELETE FROM `ezsite_data` WHERE `name` IN ('ezpublish-version', 'ezpublish-release', 'ezplatform-release');
INSERT INTO ezsite_data (`name`, `value`) VALUES ('ibexa-release', '3.3');
COMMIT;

ALTER TABLE `ezcontentclass_attribute` MODIFY `data_text1` VARCHAR(255);
ALTER TABLE `ezcontentclass_attribute` ADD COLUMN `is_thumbnail` BOOLEAN NOT NULL DEFAULT false;

ALTER TABLE `ezkeyword_attribute_link`
    ADD COLUMN `version` INT(11) DEFAULT '0',
    ADD KEY `ezkeyword_attr_link_oaid_ver` (`objectattribute_id`, `version`);
UPDATE `ezkeyword_attribute_link`
    SET `version` = COALESCE(
    (
        SELECT `current_version`
        FROM `ezcontentobject_attribute` AS `a`
        JOIN `ezcontentobject` AS `c`
            ON `a`.`contentobject_id` = `c`.`id` AND `a`.`version` = `c`.`current_version`
        WHERE `a`.`id` = `ezkeyword_attribute_link`.`objectattribute_id`
    ), 0);
ALTER TABLE `ezkeyword_attribute_link` MODIFY `version` INT(11) NOT NULL DEFAULT '0';

UPDATE `ezcontentclass_attribute`
    SET `data_text2` = '^[^@]+$'
WHERE `data_type_string` = 'ezuser' AND `data_text2` IS NULL;

UPDATE `ezuser`
    SET `email` =
        CASE
            WHEN `contentobject_id` = 10 THEN '[email protected]'
            WHEN `contentobject_id` = 14 THEN '[email protected]'
        END
    WHERE `contentobject_id` IN (10, 14) AND `email` IN ('[email protected]', '[email protected]');

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;

UPDATE ezcontentobject_attribute
    SET data_text=NULL
WHERE data_type_string='ezimageasset'
    AND data_text IN ('null', '{"destinationContentId":null,"alternativeText":"null"}');

 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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
START TRANSACTION;
DELETE FROM "ezsite_data" WHERE "name" IN ('ezpublish-version', 'ezpublish-release', 'ezplatform-release');
INSERT INTO "ezsite_data" ("name", "value") VALUES ('ibexa-release', '3.3');
COMMIT;

ALTER TABLE "ezcontentclass_attribute" ALTER COLUMN "data_text1" TYPE varchar(255);
ALTER TABLE "ezcontentclass_attribute" ADD "is_thumbnail" boolean DEFAULT false NOT NULL;

ALTER TABLE "ezkeyword_attribute_link" ADD COLUMN "version" INT;
UPDATE "ezkeyword_attribute_link"
    SET "version" = COALESCE(
    (
        SELECT "current_version"
        FROM "ezcontentobject_attribute" AS a
        JOIN "ezcontentobject" AS c
            ON a.contentobject_id = c.id AND a.version = c.current_version
        WHERE a.id = ezkeyword_attribute_link.objectattribute_id
    ), 0);
ALTER TABLE "ezkeyword_attribute_link" ALTER COLUMN "version" SET NOT NULL;
CREATE INDEX "ezkeyword_attr_link_oaid_ver" ON "ezkeyword_attribute_link" ("objectattribute_id", "version");

UPDATE "ezcontentclass_attribute"
    SET "data_text2" = '^[^@]+$'
WHERE "data_type_string" = 'ezuser' AND "data_text2" IS NULL;

UPDATE "ezuser"
    SET "email" =
        CASE
            WHEN "contentobject_id" = 10 THEN '[email protected]'
            WHEN "contentobject_id" = 14 THEN '[email protected]'
        END
WHERE "contentobject_id" IN (10, 14) AND "email" IN ('[email protected]', '[email protected]');

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)
);

UPDATE ezcontentobject_attribute
    SET data_text=NULL
WHERE data_type_string='ezimageasset'
    AND data_text IN ('null', '{"destinationContentId":null,"alternativeText":"null"}');

7. Update to the latest patch version

A. 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. 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

B. v3.3.7

Commerce configuration

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

1
php bin/console ibexa:migrations:migrate --file=src/bundle/Resources/install/migrations/content/Components/move_configuration_to_settings.yaml

Database update

Run the following SQL commands:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
CREATE TABLE IF NOT EXISTS `ibexa_workflow_version_lock` (
    `id` INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY,
    `content_id` INT(11) NOT NULL,
    `version` INT(11) NOT NULL,
    `user_id` INT(11) NOT NULL,
    `created` INT(11) NOT NULL DEFAULT 0,
    `modified` INT(11) NOT NULL DEFAULT 0,
    `is_locked` BOOLEAN NOT NULL DEFAULT true,
    KEY `ibexa_workflow_version_lock_content_id_index` (`content_id`) USING BTREE,
    KEY `ibexa_workflow_version_lock_user_id_index` (`user_id`) USING BTREE,
    UNIQUE KEY `ibexa_workflow_version_lock_content_id_version_uindex` (`content_id`,`version`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
CREATE TABLE IF NOT EXISTS ibexa_workflow_version_lock
(
    "id" SERIAL,
    "content_id" INTEGER,
    "version" INTEGER,
    "user_id" INTEGER,
    "created" INTEGER DEFAULT 0 NOT NULL,
    "modified" INTEGER DEFAULT 0 NOT NULL,
    "is_locked" boolean DEFAULT TRUE NOT NULL,
    CONSTRAINT "ibexa_workflow_version_lock_pk" PRIMARY KEY ("id")
);

CREATE INDEX IF NOT EXISTS "ibexa_workflow_version_lock_content_id_index"
    ON "ibexa_workflow_version_lock" ("content_id");

CREATE INDEX IF NOT EXISTS "ibexa_workflow_version_lock_user_id_index"
    ON "ibexa_workflow_version_lock" ("user_id");

CREATE UNIQUE INDEX IF NOT EXISTS "ibexa_workflow_version_lock_content_id_version_uindex"
    ON "ibexa_workflow_version_lock" ("content_id", "version");

C. 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

D. 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.

8. 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-3.3 branch:

1
2
git checkout master
git merge update-3.3

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.