CiviFlow Documentation
  • 👋Welcome To CiviFlow
  • 🏁Getting Started - Installing the CiviFlow Extension
  • 🛠️Configuring CiviFlow
  • 👀Monitoring CiviFlow events
  • ℹ️Further Resources
Powered by GitBook
On this page
  • Requirements
  • Download CiviFlow Extension
  • Enable CiviExtension

Was this helpful?

Edit on GitHub

Getting Started - Installing the CiviFlow Extension

PreviousWelcome To CiviFlowNextConfiguring CiviFlow

Last updated 1 year ago

Was this helpful?

Assumes CiviCRM is running on Linux

Requirements

  • Requires CiviCRM 5.57 or later

  • Requires the CiviRules extension (Bundled with CiviCRM) [https://civicrm.org/extensions/civirules]

  • Optionally Requires the CiviRulesLog extension (Bundled with CiviCRM) (used for CiviFlow audit trail)

Download CiviFlow Extension

Download civi extension from here:

e.g

cd [CIVICRM-ROOT-DIR]/extentions/
wget https://lab.civicrm.org/extensions/CiviFlow/-/archive/0.4.2/CiviFlow-0.4.2.zip
unzip CiviFlow-0.4.2.zip
mv CiviFlow-0.4.2 civiflow
rm CiviFlow-0.4.2.zip

where CIVICRM-ROOT-DIR is

  • for Drupal 8+: DRUPAL-ROOT/web/sites/default/files/civicrm/

  • for Wordpress: WORDPRESS-ROOT/wp-content/uploads/civicrm/

Important: ensure that the extracted directory is renamed to civiflow i.e.:

mv CiviFlow-0.4.2 civiflow

Note: Don't forget to secure web server permissions of the extracted files, i.e. www-data group needs read permissions on all files.

Enable CiviExtension

  • Clear the CiviCache:

  • Go to the Extensions page in CiviCRM -> Administration Menu:

  • Navigate down the page to the CiviFlow Extension and click the install button:

  • On the CiviFlow Extension page, click the install button:

🏁
https://civicrm.org/extensions/civirules-logger
https://civicrm.org/extensions/civiflow