Installing & Updating

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+
  • BC Math or GMP PHP extensions (usually included in most server environments)
  • 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

Watch the Installing and Configuring Freeform Course tutorial on CraftQuest!

Installing Instructions

Install from the Control Panel

  1. Go to the Plugin Store area inside your Craft control panel and search for Freeform.
  2. Choose 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!
  5. See quick setup guide below.

Installation

Installing from the Terminal

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
    • If you'd like Freeform Pro, also run: composer require solspace/craft3-freeform-pro
    • If you'd like Freeform Payments, also run: composer require solspace/craft3-freeform-payments
  3. 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).
  4. See quick setup guide below.

Quick Setup

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

  1. Customize and configure Solspace Freeform settings by visiting the Settings page (Freeform > Settings).
  2. Freeform ties into regular Craft User Group Permissions. Simply visit the Craft permissions page for the applicable user group(s) (Settings > Users > User Groups) to grant/edit/remove permissions to Freeform. See Permissions documentation for more information.
  3. Install the Demo Templates (Freeform > Settings > Demo Templates) to get Freeform up and running on the front end with just a couple clicks!

Updating Instructions

Updating is easy. Freeform uses the Craft Updates Service, which means that every time there's an update available, it'll show up in the Updates area (Utilities -> Updates) of the Craft control panel. You can then review the changelog there, or view it here.

Updating from the Control Panel

  1. Go to the Craft Updates area inside the control panel (Utilities -> Updates) and review the changelog for Freeform.
  2. Simply click the Update button and Craft will do the rest.

Craft Updates Service

WARNING

Due to a limitation in the Craft 3 Plugin Store where it currently doesn't yet allow for "toggling" of editions of plugins (but is coming soon), you will see two Freeform Pro plugins to update if you have the Pro edition of Freeform installed. Make sure both get updated.

Craft 3.0.38+ / 3.1.4+ introduced an update command...

  1. Open your terminal and go to your Craft project: cd /path/to/project
  2. To see available updates, run this command: ./craft update
  3. Follow the prompts, or run ./craft update freeform
    • If you have Freeform Pro, be sure to update both at the same time by running ./craft update freeform freeform-pro
    • To update to a specific version of Calendar, run ./craft update freeform:2.5.10

Update via Terminal

Updating with Composer from the Terminal

You can also update Freeform more manually if you like, using Composer (composer update). This may also be helpful in certain scenarios where you need to workaround an issue while updating.

  1. Open your Craft site's main composer.json file and adjust the version number for the applicable plugin(s) (see guide below).
  2. Open your terminal and go to your Craft project: cd /path/to/project
  3. To run any available updates for your site, run composer update
  4. Proceed to Craft control panel and click the Finish Updates button if it shows.

Understanding versions and composer update

  • For example, under the "require" area, change "solspace/craft3-freeform": "2.3.0", to "solspace/craft3-freeform": "2.5.10",.
  • You can also use ~ and ^ to somewhat automate your updating process.
    • 1.0.0 - means exactly & only this version
    • ~1.0.0 - means this version & any patch release (up to 1.0.99̅)
    • ^1.0.0 - means this version & any minor release (up to 1.99̅.99̅)
      • Specifying "solspace/craft3-freeform": "^2.0.0", for example, would always get you the latest version of Freeform 2.x (e.g. 2.5.11), but never a next major version of Freeform like 3.x.

Your final composer.json file might have something like this:





 
 




"require": {
  "php": ">=7.0.0",
  "craftcms/cms": "^3.1.0",
  "vlucas/phpdotenv": "v2.4.0",
  "solspace/craft3-freeform": "^2.5.0",
  "solspace/craft3-freeform-pro": "^2.5.0",
  "solspace/craft3-freeform-payments": "~1.0.0",
  "solspace/craft3-calendar": "^2.0.0",
},
1
2
3
4
5
6
7
8
9
Last Updated: 2/14/2019, 5:45:53 PM