Skip to content

Installing Hyvä CMS

This guide covers installing Hyvä CMS with Composer, both with a license key and via the Hyvä Commerce GitLab repositories for agency and technology partners.

Installing Hyvä CMS with Composer

For prerequisites, see Hyvä Commerce Installation Page.

Installation via Hyvä Commerce Metapackage Recommended

These steps install Hyvä CMS on its own. While this is supported to provide greater flexibility and control over installed features, in most cases, we recommend installing all Hyvä Commerce features using our metapackage.

  1. Require the hyva-themes/commerce-module-cms package:

    composer require hyva-themes/commerce-module-cms

  2. Run a setup upgrade:

    bin/magento setup:upgrade

  3. Run Tailwind to generate storefront styles, replacing vendor/hyva-themes/magento2-default-theme/web/tailwind/ with the path to your theme's web/tailwind folder:

    bin/magento hyva:config:generate
npm --prefix vendor/hyva-themes/magento2-default-theme/web/tailwind/ ci --ignore-scripts
npm --prefix vendor/hyva-themes/magento2-default-theme/web/tailwind/ run build
Installing as an Agency or Technology Partner

If you have access to the Hyvä Commerce GitLab repositories as a Gold/Platinum Agency Partner or a Technology Partner, you can install Hyvä Commerce in development environments using SSH key authentication.

You can configure the Git repositories in your root composer.json and use them directly as Git repos beneath your vendor directory. This lets you check out tags and branches, make commits, and push contributions.

Development Environments Only

This installation method is not suited for deployments, because GitLab requires SSH key authorization and project changes can break production deployments.

  1. Make sure your public SSH key is added to your account on gitlab.hyva.io.

  2. Set minimum-stability to dev in the Magento composer.json:

    composer config minimum-stability dev

  3. Add the Hyvä CMS and base Hyvä Commerce module repositories to the Magento composer.json:

    composer config repositories.hyva-themes/commerce-module-commerce git git@gitlab.hyva.io:hyva-commerce/module-commerce.git
composer config repositories.hyva-themes/commerce-module-cms git git@gitlab.hyva.io:hyva-commerce/module-cms.git
composer config repositories.hyva-themes/commerce-module-cms-tailwind-jit-bridge git git@gitlab.hyva.io:hyva-commerce/commerce-module-cms-tailwind-jit-bridge.git
composer config repositories.hyva-themes/commerce-module-cms-google-maps git git@gitlab.hyva.io:hyva-commerce/module-cms-google-maps.git

  4. Require the hyva-themes/commerce-module-cms package using the dev-main branch:

    composer require --prefer-source 'hyva-themes/commerce-module-cms:dev-main'

  5. Run a setup upgrade:

    bin/magento setup:upgrade

  6. Run Tailwind to generate storefront styles, replacing vendor/hyva-themes/magento2-default-theme/web/tailwind/ with the path to your theme's web/tailwind folder:

    bin/magento hyva:config:generate
npm --prefix vendor/hyva-themes/magento2-default-theme/web/tailwind/ ci --ignore-scripts
npm --prefix vendor/hyva-themes/magento2-default-theme/web/tailwind/ run build

Additional Hyvä CMS Setup

Hyvä CMS only supports the 'New' Media Gallery, for handling image selection and editing (using the Image Editor). Enabling the 'New' Media Gallery can be configured in the admin panel.

Confirm Magento Cron

Hyvä CMS scheduling depends on Magento cron. Make sure cron is configured and running before relying on scheduled publication.

Default scheduling jobs check for due releases every 5 minutes and clean old completed scheduling history weekly. See Content Scheduling.

Review Content Type Configuration

CMS pages, CMS blocks, product attributes, and category attributes are enabled by default in the core Hyvä CMS modules. Review the admin configuration if a content type should be disabled for a project.

Relevant configuration areas are all found in the Magento admin under Stores → Settings → Configuration → Hyvä Commerce:

  • Hyvä CMS → Magento CMS
  • Hyvä CMS → Attributes
  • Hyvä CMS → Templates
  • Hyvä CMS → Scheduling

Multi-Store and Custom Admin Domain Setup

Since version 1.0.2 the required CSP frame policies for multi-domain setups are automatically applied in the Hyvä CMS Liveview Editor context.

This feature is enabled by default and requires no additional configuration.

Configuration Path: hyva_cms/general/auto_csp_frame_policies, found in the admin under Stores → Settings → Configuration → Hyvä Commerce → Hyvä CMS → General → Enable Multi Domain CSP Frame Policies.

Manual CSP Configuration (Legacy)

If you're using an older Hyvä CMS version, need to disable automatic CSP frame policies, or require custom configuration, you can configure Magento CSP manually:

  1. Disable automatic policies in the admin configuration: hyva_cms/general/auto_csp_frame_policies, found under Stores → Settings → Configuration → Hyvä Commerce → Hyvä CMS → General → Enable Multi Domain CSP Frame Policies.
  2. Add CSP Whitelist Rules in a csp_whitelist.xml file: 
    <?xml version="1.0"?>
<csp_whitelist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Csp:etc/csp_whitelist.xsd">
    <policies>
        <policy id="frame-ancestors">
            <values>
                <value id="magento-admin-domain" type="host">admin.example.com</value>
            </values>
        </policy>
        <policy id="frame-src">
            <values>
                <value id="store-domain-uk" type="host">example-uk.com</value>
                <value id="store-domain-fr" type="host">example-fr.com</value>
            </values>
        </policy>
    </policies>
</csp_whitelist>
  3. Enable CSP strict Mode by adding the following to config.xml: 
    <?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
    <default>
        <csp>
            <mode>
                <storefront>
                    <report_only>0</report_only>
                </storefront>
            </mode>
        </csp>
    </default>
</config>

or the following to app/etc/env.php: 

'system' => [
    'default' => [
        'csp' => [
            'mode' => [
                'storefront' => [
                    'report_only' => '0'
                ]
            ]
        ]
    ]
]

Note: frame-ancestors overrides X-Frame-Options only in strict mode (Content-Security-Policy). In report-only mode, X-Frame-Options still applies (see spec).

Why do we need CSP frame policies?

For the Hyvä CMS Liveview Editor to be able to display the preview in a cross domain iframe, it requires the correct Content Security Policy (CSP) frame policies to be applied in the editor context.

For more information about CSP and Magento, see CSP and Magento.

Handling the Hyvä CMS Cache

The hyva_cms cache stores component declarations from components.json files for improved performance. It is automatically enabled in production environments and disabled in developer mode.

Depending on your deployment strategy, you may need to clear this cache on each deployment:

bin/magento cache:clean hyva_cms

Tailwind CSS Compilation

Hyvä CMS generates Tailwind CSS for the classes used in CMS content, so components produce styles without a full theme rebuild. Compilation runs either in-browser (the default) or server-side through a Node-based Tailwind compiler. For new projects, server-side compilation is recommended, since it produces the smallest inline CSS payload.

See Tailwind CSS Compilation for the full details: choosing the strategy, the in-browser compiler version, server-side setup, when styles are compiled, style priority (theme styles always win), and backward compatibility.