README

About phpList

phpList is an open source newsletter manager. This project is a rewrite of the original phpList.

About this package

This module is the basis for a phpList 4 installation. It will pull in the phplist/core module (the phpList 4 core) and by default also the phplist/rest-api module (the new REST API package). The rest-api dependency is optional.

This package is intended to be cloned and then modified. It is not intended to be updated via Composer after the initial install (although updating the dependencies via composer update is fine).

This (i.e., the downloaded package) is also the place where configuration files will be stored (or symlinked to).

Installation

Download and install composer.
Run composer create-project -s dev --no-dev phplist/base-distribution your-project (use any name you like for the your-project directory).
Switch to the your-project directory.
If you would like to not have the REST API, edit the composer.json, remove the corresponding phplist/rest-api requirement, and run composer update.

Configuring and running phpList on a web server

The phpList application is configured so that the built-in PHP web server can run in development and testing mode, while Apache can run in production mode.

Production on Apache

In the Apache virtual host configuration, set the directory public/ as the document root.
Set a random 40-character hex secret and the phpList database credentials in the Apache virtual host configuration. Your Apache 2.4 configuration then could look like this:

<VirtualHost *:80>
    ServerName domain.tld
    ServerAlias www.domain.tld

    DocumentRoot /var/www/project/public
    <Directory /var/www/project/public>
        AllowOverride All
        Require all granted
    </Directory>

    # uncomment the following lines if you install assets as symlinks
    # or run into problems when compiling LESS/Sass/CoffeeScript assets
    # <Directory /var/www/project>
    #     Options FollowSymlinks
    # </Directory>

    SetEnv PHPLIST_SECRET f75365ecb07c725ba05d5361e415a328880360e5
    SetEnv PHPLIST_DATABASE_NAME phplist
    SetEnv PHPLIST_DATABASE_USER phplist
    SetEnv PHPLIST_DATABASE_PASSWORD correctHorseBatteryStaple

    ErrorLog /var/log/apache2/project_error.log
    CustomLog /var/log/apache2/project_access.log combined
</VirtualHost>

Then reload or restart Apache to activate the configuration changes.

If you cannot set any environment variables in your Apache configuration, you can also set the database credentials in config/parameters.yml. However, this should only be used as a last resort as this reduces security (as an attacker with read access to the files on the web server then could read that file, whereas they then still would not be able to access the environment variables).

Use the following optimized configuration to disable .htaccess support and increase web server performance:

<VirtualHost *:80>
    ServerName domain.tld
    ServerAlias www.domain.tld

    DocumentRoot /var/www/project/public
    <Directory /var/www/project/public>
        AllowOverride None
        Order Allow,Deny
        Allow from All

        <IfModule mod_rewrite.c>
            Options -MultiViews
            RewriteEngine On
            RewriteCond %{REQUEST_FILENAME} !-f
            RewriteRule ^(.*)$ app.php [QSA,L]
        </IfModule>
    </Directory>

    SetEnv PHPLIST_SECRET f75365ecb07c725ba05d5361e415a328880360e5
    SetEnv PHPLIST_DATABASE_NAME phplist
    SetEnv PHPLIST_DATABASE_USER phplist
    SetEnv PHPLIST_DATABASE_PASSWORD correctHorseBatteryStaple

    ErrorLog /var/log/apache2/project_error.log
    CustomLog /var/log/apache2/project_access.log combined
</VirtualHost>

Development

For running the application in development mode using the built-in PHP server, use this command:

bin/console server:run -d public/

The server will then listen on http://127.0.0.1:8000 (or, if port 8000 is already in use, on the next free port after 8000).

You can stop the server with CTRL + C.

Testing

To run the server in testing mode (which normally will only be needed for the automated tests, provide the --env option:

bin/console server:run -d public/ --env=test

Useful Composer scripts

You can get a list of all installed phpList modules with this command:

composer run-script list-modules

Creating a .tar.gz package of this distribution

These are the steps to create a package for version 4.0.x-dev with the file name phplist-base-distribution-4.0.x-dev.tar.gz:

composer create-project phplist/base-distribution phplist 4.0.x-dev --prefer-dist --no-dev -s dev
tar -cvzf phplist-base-distribution-4.0.x-dev.tar.gz phplist

These steps assume that tar and composer are installed on your machine, and that composer is in your path (and that it is named composer, not composer.phar).

Contributing to this package

Please read the contribution guide on how to contribute and how to run the unit tests and style checks locally.

Code of Conduct

This project adheres to a Contributor Code of Conduct. By participating in this project and its community, you are expected to uphold this code.

phplist / base-distribution

Maintainers

Details