Skip to content

ChurchCRM Application Platform Prerequisites

James G edited this page Jul 14, 2024 · 9 revisions

ChurchCRM Application Platform Prerequisites

ChurchCRM has a few platform prerequisites, and a built-in mechanism to ensure that all prerequisites are met. If there are any unmet prerequisites, a message will be displayed during setup and a notification will be displayed during run time.

Prerequisites are validated at every page load, so if the hosting environment is changed to an incomplete / unsupported model, a notification will appear

Validation occurs in the getApplicationPrerequisites() function.

Prerequisites

PHP 8.1+

Synopsis

ChurchCRM makes use of many features added with PHP 8.1. Lower versions will not work.

Symptoms of failure

  • Errors and warnings about missing functions (especially random_bytes())
  • As of ChurchCRM 5.3.0, the setup process will display a message indicating installation with anything below PHP 8.1 is not possible and will halt the installation.

Steps for Resolution

  • Shared Hosting (CPanel)
    • Ensure that you have PHP 8.1 or higher selected for this site.
  • Self-Hosted Linux:

PCRE and UTF-8 Support

Multibyte Encoding

PHP Phar

PHP Session

PHP XML

PHP EXIF

PHP iconv

Mcrypt

Mod Rewrite

ChurchCRM relies on Apache's mod_rewrite for functionality at the moment. We would like to depreciate this requirement but it still exists for now. Testing for the presence/absence of mod_rewrite from inside the PHP code can be difficult to reliablably detect on all hosting configurations. If you know for certain that this module is loaded and working on your Apache setup, it is SAFE to ignore this prerequisite during setup.

GD Library for image manipulation

FileInfo Extension for image manipulation

cURL

locale gettext

Include/Config file is writeable

Images directory is writeable

PHP ZipArchive

Mysqli Functions

Clone this wiki locally