Freeform Documentation

Learn the basics, and get to know Freeform inside and out.

Freeform 1.x Docs

Installation

Requirements #

Solspace Freeform mostly meets the same requirements as listed on the Craft Requirements page.

  • Craft 3.0.0 or later
  • PHP 7.0+
  • MySQL 5.5+ (with InnoDB) or PostgreSQL 9.5+
  • Windows and OS X browsers:
    • Chrome 29 or later
    • Firefox 28 or later
    • Safari 9.0 or later
    • Internet Explorer 11 or later
    • Microsoft Edge

Installing Instructions #

To install Freeform, simply:

  1. Go to the Plugin Store area inside your Craft control panel and search for Freeform.
  2. Choose to install Freeform Lite and/or Freeform Pro (Pro requires Lite to be installed) by clicking on them.
  3. Click on the Try button to install a trial copy of Freeform.
  4. Try things out and if Freeform is right for your site, purchase a copy of if through the Plugin Store when you're ready!

Installation

Freeform can also be installed manually through Composer:

  1. Open your terminal and go to your Craft project: cd /path/to/project
  2. Then tell Composer to require the plugin: composer require solspace/craft3-freeform
  3. If you'd like Freeform Pro, also run: composer require solspace/craft3-freeform-pro
  4. In the Craft control panel, go to Settings → Plugins and click the Install button for Freeform Lite (and Freeform Pro if you're using Pro edition).

Quick Setup #

Follow the steps below to quickly get Solspace Freeform setup in minutes.

Settings #

To customize and configure Solspace Freeform settings, visit the Settings page (Freeform > Settings).

Permissions #

Solspace Freeform ties into regular Craft User Group Permissions. Simply visit the permissions page for the applicable user group(s) (Settings > Users > User Groups) to grant/edit/remove permissions to Solspace Freeform.

  • General
    • Access Freeform - required for users to access Solspace Freeform at all.
  • Freeform
    • Access Submissions - access to the Submissions list page.
      • Manage All Submissions - can view, edit or delete any submission, regardless of per form selection below.
      • For "MY FORM NAME" - can view, edit or delete submissions for this form.
    • Access Forms - access to the Forms list page.
      • Manage Forms - can create, edit or delete forms.
    • Access Fields - access to the Fields list page.
      • Manage Fields - can create, edit or delete fields.
    • Access Email Templates - access to the Email Templates list page.
      • Manage Email Templates - can create, edit or delete email notification templates.
    • Access Export Profiles - access to the Export Profiles list page and running of exports.
      • Manage Export Profiles - can create, edit or delete export profiles.
    • Access Settings - can access and update settings area for Freeform.

Permissions

Demo Templates #

Install the Demo Templates (Freeform > Settings > Demo Templates) to get Freeform up and running on the front end with just a couple clicks!