Skip to content

Installing Form Builder

Beta release

Form Builder 0.1.0 is a beta release and requires the Hyvä CMS 1.3.0-beta2 beta release as its base. It is not suitable for production use and is pending a full security review. Follow the beta upgrade notes for the exact Composer commands, including the stability constraint your root composer.json needs.

Separate installation required

Unlike some Hyvä Commerce features, Form Builder is not bundled with the Hyvä CMS package during beta. You install it as a separate package, hyva-themes/commerce-module-form-builder, alongside Hyvä CMS. Form Builder depends on Hyvä CMS (hyva-themes/commerce-module-cms), so make sure Hyvä CMS is installed first.

This guide covers installing the Hyvä Form Builder module with Composer.

Prerequisites

Installation

With a License Key

  1. Require the hyva-themes/commerce-module-form-builder package 

    composer require hyva-themes/commerce-module-form-builder

  2. Run bin/magento setup:upgrade

  3. Make sure to clean your browser cache

For Agency and Technology Partners

If you have access to the Hyvä Commerce GitLab repositories as a Gold/Platinum Agency Partner, or a Technology Partner, you can install Form Builder 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 repos 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 Form Builder module repository to the Magento composer.json 

    composer config repositories.hyva-themes/commerce-module-form-builder git git@gitlab.hyva.io:hyva-commerce/module-form-builder.git

  4. Require the hyva-themes/commerce-module-form-builder package 

    composer require hyva-themes/commerce-module-form-builder:dev-main

  5. Run bin/magento setup:upgrade

  6. Make sure to clean your browser cache

After Installing

Once installed, a new Forms option appears under Content > Elements in the admin panel. No further steps are required to start building forms. To have submissions delivered by email and to enable CAPTCHA, see Sending and Recipients and Spam Protection.