Skip to content

Installation & Configuration for Hyvä Checkout

The Hyvä Checkout is a stand-alone commercial product.

Prerequisites

  • Magento Open Source/Adobe Commerce 2.4.5, 2.4.6, 2.4.7, 2.4.8 or higher (always use the latest patch version)
  • A valid license for Hyvä Commerce or Hyvä Checkout
  • For licensees: A Private Packagist Key
  • For partners: Access to Hyvä Gitlab
  • PHP 8.1, 8.2, 8.3, 8.4
  • Hyvä Themes 1.3.12 or newer

CSP support in version 1.3.0 of Hyvä Checkout

Hyvä Checkout version 1.3.0 introduced a requirement for the CSP Nonce Provider. Therefore, Magento 2 versions as listed above, are now mandatory. More information about CSP can be found here.

Moving forward, the 1.3.x release line will be the primary release for new features and improvements. All code written from this point on will be Alpine CSP-compliant. Users unable to update to these Magento versions should use Hyvä Checkout versions prior to 1.3.0.

Hyvä Themes 1.3.12 or newer is a required dependency for using Hyvä Checkout

Hyvä Theme and the Hyvä Theme CSP variant are not added as composer requirements to Hyvä Checkout, but installing a Hyvä Theme is still required before you can install and use Hyvä Checkout. Please find the Hyvä Theme installation instructions from here.

Installation

With a License Key

  1. Require the hyva-themes/magento2-hyva-checkout package 

    composer require hyva-themes/magento2-hyva-checkout

  2. Disable the Magento HTML minification in the configuration setting
    Advanced > Developer > Template Settings > Minify Html, or run 

    bin/magento config:set dev/template/minify_html 0
    This is only required if HTML minification is currently turned on (it is turned off by default).

    HTML minification can be enabled since v1.1.6, even though we still recommend it being disabled.

  3. Run a Setup Upgrade 

    bin/magento setup:upgrade

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

    npm --prefix vendor/hyva-themes/magento2-default-theme/web/tailwind/ ci
npm --prefix vendor/hyva-themes/magento2-default-theme/web/tailwind/ run build

For Agency and Technology Partners

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

You can configure the git repositories in your root composer.json and use the repositories directly as git repo's beneath your vendor directory. You can check out tags and branches, make commits and push contributions.

This installation method is not suited for deployments, because GitLab requires SSH key authorization.

  1. Ensure 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 following repository to the Magento composer.json 

    composer config repositories.hyva-themes/hyva-checkout git git@gitlab.hyva.io:hyva-checkout/checkout.git

  4. Require the hyva-themes/magento2-hyva-checkout package using the dev-main branch version 

    composer require --prefer-source 'hyva-themes/magento2-hyva-checkout: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. 

    npm --prefix vendor/hyva-themes/magento2-default-theme/web/tailwind/ ci
npm --prefix vendor/hyva-themes/magento2-default-theme/web/tailwind/ run build-prod

Admin configuration

The admin configuration can be found at
Stores > Configuration > Hyvä Themes > Checkout.

Opt-in checkout

In the General section, the setting for "Checkout" defaults to "Magento Luma (original)".
To use the Hyvä Checkout, you need to change the selection to "Hyvä Default" and save the configuration.

If you create custom checkouts based on Hyvä Checkout, they will also be listed as options.

Mobile Checkout configuration

If the optional "Mobile" checkout is enabled in the Hyvä Checkout system configuration, it will be used when a visitor's user agent matches a known mobile device.

This allows presenting a different checkout experience that is optimized for mobile use.
For example, multiple steps can provide a better customer experience on a phone, while a one-page checkout can work better for visitors using a desktop browser.

The regular expression for matching mobile user agents can be customized in the
"Hyvä Themes > Checkout > Developer" section.

After changing any setting, be sure to flush the cache.