Table of Contents

System setup

phpList system requirements

  1. MySQL or MariaDB
  2. Apache Note: phpList optionally uses Apache environment variables
  3. PHP 8.1 or later with the following PHP extensions:
    • Core
    • curl
    • date
    • filter
    • GD (required by CKEditor Plugin only)
    • gettext
    • hash
    • iconv
    • imap
    • json
    • mbstring
    • mysqli
    • openssl
    • pcre
    • session
    • SimpleXML
    • SPL
    • xml
    • zip

From version 3.6.0 the PHP system requirement is PHP version 7.0 and higher.
It is likely that phpList will continue to work on older versions of PHP, but the phpList core team is no longer testing that, as it has been found to be too time consuming. If you would like to ensure that phpList continues to work on older versions, you are welcome to help out with testing that, and sending pull requests for changes required for this.

It is unlikely phpList will work with PHP older than 5.3.3. However, we strongly advise to update your systems to use PHP8.1 or up, as those are the versions supported (July 2023)

Note:
phpList 3.4.0 and later feature the new REST API. PHP 7 is required to use the API. The phpList3 module requirements are the same on those versions too.

Some module dependencies are not obligatory. Some of phpList's functionality will be hidden if certain functions are not available on your system. For full phpList functionality all the above modules are required.

Plugin dependencies

phpList plugins have independent system requirements and sometimes use additional PHP features and modules. Please check the documentation of those plugins for requirements before upgrading them.

Automated installation with Puppet

If you use Puppet to manage the software on your server, there is a puppet module to automatically install phplist at https://github.com/Ecetera/ecetera-phplist.git

See also