PHP-FPM Docker images

This repository will provide you fully functional PHP-FPM Docker images in different flavours, versions and packed with different types of integrated PHP modules. It also solves the problem of syncronizing file permissions of mounted volumes between the host and the container.

Docker Hub	Upstream Project

Base Images

Have a look at the following Devilbox base images for which no official versions exist yet, but are required to serve as a foundation for this repository:

• PHP-FPM 5.2
• PHP-FPM 5.3
• PHP-FPM 7.4
• PHP-FPM 8.0
• PHP-FPM 8.1

Documentation

In case you seek help, go and visit the community pages.

Documentation	Chat	Forum
devilbox.readthedocs.io	gitter.im/devilbox	devilbox.discourse.group

Table of Contents

1. Motivation
   1. Unsynchronized permissions
   2. It gets even worse
   3. The solution
2. PHP-FPM Flavours
   1. Assembly
   2. Available Images
   3. Tagging
   4. PHP Modules
3. PHP-FPM Features
   1. Image: base
   2. Image: mods
   3. Image: prod
   4. Image: work
4. PHP-FPM Options
   1. Environment variables
   2. Volumes
   3. Ports
5. PHP Default Configuration
6. Integrated Development Environment
   1. What toos can you expect
   2. What else is available
7. Examples
   1. Provide PHP-FPM port to host
   2. Alter PHP-FPM and system timezone
   3. Load custom PHP configuration
   4. Load custom PHP modules
   5. MySQL connect via 127.0.0.1 (via port-forward)
   6. MySQL and Redis connect via 127.0.0.1 (via port-forward)
   7. Launch Postfix for mail-catching
   8. Webserver and PHP-FPM
   9. Create MySQL Backups
8. Automated builds
9. Contributing
10. Credits
11. License

Motivation

One main problem with a running Docker container is to synchronize the ownership of files in a mounted volume in order to preserve security (Not having to use chmod 0777).

Unsynchronized permissions

Consider the following directory structure of a mounted volume. Your hosts computer uid/gid are 1000 which does not have a corresponding user/group within the container. Fortunately the tmp/ directory allows everybody to create new files in it.

                  [Host]                   |             [Container]
------------------------------------------------------------------------------------------
 $ ls -l                                   | $ ls -l
 -rw-r--r-- user group index.php           | -rw-r--r-- 1000 1000 index.php
 drwxrwxrwx user group tmp/                | drwxrwxrwx 1000 1000 tmp/

Your web application might now have created some temporary files (via the PHP-FPM process) inside the tmp/ directory:

                  [Host]                   |             [Container]
------------------------------------------------------------------------------------------
 $ ls -l tmp/                              | $ ls -l tmp/
 -rw-r--r-- 96 96 _tmp_cache01.php         | -rw-r--r-- www www _tmp_cache01.php
 -rw-r--r-- 96 96 _tmp_cache02.php         | -rw-r--r-- www www _tmp_cache01.php

On the Docker container side everything is still fine, but on your host computers side, those files now show a user id and group id of 96, which is in fact the uid/gid of the PHP-FPM process running inside the container. On the host side you will now have to use sudo in order to delete/edit those files.

It gets even worse

Consider your had created the tmp/ directory on your host only with 0775 permissions:

                  [Host]                   |             [Container]
------------------------------------------------------------------------------------------
 $ ls -l                                   | $ ls -l
 -rw-r--r-- user group index.php           | -rw-r--r-- 1000 1000 index.php
 drwxrwxr-x user group tmp/                | drwxrwxr-x 1000 1000 tmp/

If your web application now wants to create some temporary files (via the PHP-FPM process) inside the tmp/ directory, it will fail due to lacking permissions.

The solution

To overcome this problem, it must be made sure that the PHP-FPM process inside the container runs under the same uid/gid as your local user that mouns the volumes and also wants to work on those files locally. However, you never know during Image build time what user id this would be. Therefore it must be something that can be changed during startup of the container.

This is achieved by two environment variables that can be provided during startup in order to change the uid/gid of the PHP-FPM user prior starting up PHP-FPM.

$ docker run -e NEW_UID=1000 -e NEW_GID=1000 -it devilbox/php-fpm:7.2-base
[INFO] Changing user 'devilbox' uid to: 1000
root $ usermod -u 1000 devilbox
[INFO] Changing group 'devilbox' gid to: 1000
root $ groupmod -g 1000 devilbox
[INFO] Starting PHP 7.2.0 (fpm-fcgi) (built: Oct 30 2017 12:05:19)

When NEW_UID and NEW_GID are provided to the startup command, the container will do a usermod and groupmod prior starting up in order to assign new uid/gid to the PHP-FPM user. When the PHP-FPM process finally starts up it actually runs with your local system user and making sure permissions will be in sync from now on.

At a minimum those two environment variables are offered by all flavours and types of the here provided PHP-FPM images.

Note:

To tackle this on the PHP-FPM side is only half a solution to the problem. The same applies to a web server Docker container when you offer file uploads. They will be uploaded and created by the web servers uid/gid. Therefore the web server itself must also provide the same kind of solution. See the following Web server Docker images for how this is done:

Apache 2.2 | Apache 2.4 | Nginx stable | Nginx mainline

PHP-FPM Flavours

Assembly

The provided Docker images heavily rely on inheritance to guarantee smallest possible image size. Each of them provide a working PHP-FPM server and you must decide what version works best for you. Look at the sketch below to get an overview about the two provided flavours and each of their different types.

        [PHP]            # Base FROM image (Official PHP-FPM image)
          ^              #
          |              #
          |              #
        [base]           # Introduces env variables and adjusts entrypoint
          ^              #
          |              #
          |              #
        [mods]           # Installs additional PHP modules
          ^              # via pecl, git and other means
          |              #
          |              #
        [prod]           # Devilbox flavour for production
          ^              # (locales, postifx, socat and injectables)
          |              # (custom modules and *.ini files)
          |              #
        [work]           # Devilbox flavour for local development
                         # (includes backup and development tools)
                         # (sudo, custom bash and tool configs)

Available Images

The following table shows a more complete overview about the offered Docker images and what they should be used for.

Type	Docker Image	Description
base	devilbox/php-fpm:5.2-base
	devilbox/php-fpm:5.3-base		devilbox/php-fpm:5.4-base
	devilbox/php-fpm:5.5-base
	devilbox/php-fpm:5.6-base
	devilbox/php-fpm:7.0-base
	devilbox/php-fpm:7.1-base
	devilbox/php-fpm:7.2-base
	devilbox/php-fpm:7.3-base
	devilbox/php-fpm:7.4-base
	devilbox/php-fpm:8.0-base
	devilbox/php-fpm:8.1-base
	mods	devilbox/php-fpm:5.2-mods
devilbox/php-fpm:5.3-mods
devilbox/php-fpm:5.4-mods
devilbox/php-fpm:5.5-mods
devilbox/php-fpm:5.6-mods
devilbox/php-fpm:7.0-mods
devilbox/php-fpm:7.1-mods
devilbox/php-fpm:7.2-mods
devilbox/php-fpm:7.3-mods
devilbox/php-fpm:7.4-mods
devilbox/php-fpm:8.0-mods
devilbox/php-fpm:8.1-mods
prod	devilbox/php-fpm:5.2-prod
	devilbox/php-fpm:5.3-prod
	devilbox/php-fpm:5.4-prod
	devilbox/php-fpm:5.5-prod
	devilbox/php-fpm:5.6-prod
	devilbox/php-fpm:7.0-prod
	devilbox/php-fpm:7.1-prod
	devilbox/php-fpm:7.2-prod
	devilbox/php-fpm:7.3-prod
	devilbox/php-fpm:7.4-prod
	devilbox/php-fpm:8.0-prod
	devilbox/php-fpm:8.1-prod
work	devilbox/php-fpm:5.2-work
	devilbox/php-fpm:5.3-work
	devilbox/php-fpm:5.4-work
	devilbox/php-fpm:5.5-work
	devilbox/php-fpm:5.6-work
	devilbox/php-fpm:7.0-work
	devilbox/php-fpm:7.1-work
	devilbox/php-fpm:7.2-work
	devilbox/php-fpm:7.3-work
	devilbox/php-fpm:7.4-work
	devilbox/php-fpm:8.0-work
	devilbox/php-fpm:8.1-work

Tagging

This repository uses Docker tags to refer to different flavours and types of the PHP-FPM Docker image. Therefore :latest and :<git-branch-name> as well as :<git-tag-name> must be presented differently. Refer to the following table to see how tagged Docker images are produced at Docker hub:

PHP Modules

Check out this table to see which Docker image provides what PHP modules.

PHP-FPM Features

Image: base

docker pull devilbox/php-fpm:5.2-base
docker pull devilbox/php-fpm:5.3-base
docker pull devilbox/php-fpm:5.4-base
docker pull devilbox/php-fpm:5.5-base
docker pull devilbox/php-fpm:5.6-base
docker pull devilbox/php-fpm:7.0-base
docker pull devilbox/php-fpm:7.1-base
docker pull devilbox/php-fpm:7.2-base
docker pull devilbox/php-fpm:7.3-base
docker pull devilbox/php-fpm:7.4-base
docker pull devilbox/php-fpm:8.0-base
docker pull devilbox/php-fpm:8.1-base

Generic PHP-FPM base image. Use it to derive your own php-fpm docker image from it and add more extensions, tools and injectables.

_{(Does not offer any environment variables except for NEW_UID and NEW_GID)}

Image: mods

docker pull devilbox/php-fpm:5.2-mods
docker pull devilbox/php-fpm:5.3-mods
docker pull devilbox/php-fpm:5.4-mods
docker pull devilbox/php-fpm:5.5-mods
docker pull devilbox/php-fpm:5.6-mods
docker pull devilbox/php-fpm:7.0-mods
docker pull devilbox/php-fpm:7.1-mods
docker pull devilbox/php-fpm:7.2-mods
docker pull devilbox/php-fpm:7.3-mods
docker pull devilbox/php-fpm:7.4-mods
docker pull devilbox/php-fpm:8.0-mods
docker pull devilbox/php-fpm:8.1-mods

Generic PHP-FPM image with fully loaded extensions. Use it to derive your own php-fpm docker image from it and add more extensions, tools and injectables.

_{(Does not offer any environment variables except for NEW_UID and NEW_GID)}

Image: prod

docker pull devilbox/php-fpm:5.2-prod
docker pull devilbox/php-fpm:5.3-prod
docker pull devilbox/php-fpm:5.4-prod
docker pull devilbox/php-fpm:5.5-prod
docker pull devilbox/php-fpm:5.6-prod
docker pull devilbox/php-fpm:7.0-prod
docker pull devilbox/php-fpm:7.1-prod
docker pull devilbox/php-fpm:7.2-prod
docker pull devilbox/php-fpm:7.3-prod
docker pull devilbox/php-fpm:7.4-prod
docker pull devilbox/php-fpm:8.0-prod
docker pull devilbox/php-fpm:8.1-prod

Devilbox production image. This Docker image comes with many injectables, port-forwardings, mail-catch-all and user/group rewriting.

Image: work

docker pull devilbox/php-fpm:5.2-work
docker pull devilbox/php-fpm:5.3-work
docker pull devilbox/php-fpm:5.4-work
docker pull devilbox/php-fpm:5.5-work
docker pull devilbox/php-fpm:5.6-work
docker pull devilbox/php-fpm:7.0-work
docker pull devilbox/php-fpm:7.1-work
docker pull devilbox/php-fpm:7.2-work
docker pull devilbox/php-fpm:7.3-work
docker pull devilbox/php-fpm:7.4-work
docker pull devilbox/php-fpm:8.0-work
docker pull devilbox/php-fpm:8.1-work

Devilbox development image. Same as prod, but comes with lots of locally installed tools to make development inside the container as convenient as possible. See Integrated Development Environment for more information about this.

PHP-FPM Options

Environment variables

Have a look at the following table to see all supported environment variables for each Docker image flavour.

Volumes

Have a look at the following table to see all offered volumes for each Docker image flavour.

Ports

Have a look at the following table to see all offered exposed ports for each Docker image flavour.

PHP Default Configuration

Each PHP version is using the same sane default php.ini values, making it pain-free to switch versions and not having to worry about different php.ini settings. Note: Flavours alway inherit the settings from its parent flavour if they have no own configuration.

Integrated Development Environment

If you plan to use the PHP-FPM image for development, hence being able to execute common commands inside the container itself, you should go with the work Image.

The work Docker image has many common tools already installed which on one hand increases its image size, but on the other hand removes the necessity to install those tools locally.

You want to use tools such as git, drush, composer, npm, eslint, phpcs as well as many others, simply do it directly inside the container. As all Docker images are auto-built every night by GitHub Actions it is assured that you are always at the latest version of your favorite dev tool.

What tools can you expect

What else is available

Apart from the provided tools, you will also be able to use the container similar as you would do with your host system. Just a few things to mention here:

• Mount custom bash configuration files so your config persists between restarts
• Use password-less sudo to become root and do whatever you need to do

If there is anything else you'd like to be able to do, drop me an issue.

Examples

Provide PHP-FPM port to host

$ docker run -d \
    -p 127.0.0.1:9000:9000 \
    -t devilbox/php-fpm:7.2-prod

Alter PHP-FPM and system timezone

$ docker run -d \
    -p 127.0.0.1:9000:9000 \
    -e TIMEZONE=Europe/Berlin \
    -t devilbox/php-fpm:7.2-prod

Load custom PHP configuration

config/ is a local directory that will hold the PHP *.ini files you want to load into the Docker container.

# Create config directory to be mounted with dummy configuration
$ mkdir config
# Xdebug 2
$ echo "xdebug.enable = 1" > config/xdebug.ini
# Xdebug 3
$ echo "xdebug.mode = debug" > config/xdebug.ini

# Run container and mount it
$ docker run -d \
    -p 127.0.0.1:9000:9000 \
    -v config:/etc/php-custom.d \
    -t devilbox/php-fpm:7.2-prod

Load custom PHP modules

modules/ is a local directory that will hold the PHP modules you want to mount into the Docker container. config/ is a local directory that will hold the PHP *.ini files you want to load into the Docker container.

# Create module directory and place module into it
$ mkdir modules
$ cp /my/module/phalcon.so modules/

# Custom php config to load this module
$ mkdir config
$ echo "extension=/etc/php-modules.d/phalcon.so" > config/phalcon.ini

# Run container and mount it
$ docker run -d \
    -p 127.0.0.1:9000:9000 \
    -v config:/etc/php-custom.d \
    -v modules:/etc/php-modules.d \
    -t devilbox/php-fpm:7.2-prod

MySQL connect via 127.0.0.1 (via port-forward)

Forward MySQL Port from 172.168.0.30 (or any other IP address/hostname) and Port 3306 to the PHP docker on 127.0.0.1:3306. By this, your PHP files inside the docker can use 127.0.0.1 to connect to a MySQL database.

$ docker run -d \
    -p 127.0.0.1:9000:9000 \
    -e FORWARD_PORTS_TO_LOCALHOST='3306:172.168.0.30:3306' \
    -t devilbox/php-fpm:7.2-prod

MySQL and Redis connect via 127.0.0.1 (via port-forward)

Forward MySQL Port from 172.168.0.30:3306 and Redis port from redis:6379 to the PHP docker on 127.0.0.1:3306 and 127.0.0.1:6379. By this, your PHP files inside the docker can use 127.0.0.1 to connect to a MySQL or Redis database.

$ docker run -d \
    -p 127.0.0.1:9000:9000 \
    -e FORWARD_PORTS_TO_LOCALHOST='3306:172.168.0.30:3306, 6379:redis:6379' \
    -t devilbox/php-fpm:7.2-prod

Launch Postfix for mail-catching

Once you set $ENABLE_MAIL=2, all mails sent via any of your PHP applications no matter to which domain, are catched locally into the devilbox account. You can also mount the mail directory locally to hook in with mutt and read those mails.

$ docker run -d \
    -p 127.0.0.1:9000:9000 \
    -v /tmp/mail:/var/mail \
    -e ENABLE_MAIL=2 \
    -t devilbox/php-fpm:7.2-prod

Webserver and PHP-FPM

~/my-host-www will be the directory that serves the php files (your document root). Make sure to mount it into both, php and the webserver.

# Start PHP-FPM container
$ docker run -d \
    -v ~/my-host-www:/var/www/default/htdocs \
    --name php \
    -t devilbox/php-fpm:7.2-prod

# Start webserver and link with PHP-FPM
$ docker run -d \
    -p 80:80 \
    -v ~/my-host-www:/var/www/default/htdocs \
    -e PHP_FPM_ENABLE=1 \
    -e PHP_FPM_SERVER_ADDR=php \
    -e PHP_FPM_SERVER_PORT=9000 \
    --link php \
    -t devilbox/nginx-mainline

Create MySQL Backups

Note: This will only work with work Docker images.

The MySQL server could be another Docker container linked to the PHP-FPM container. Let's assume the PHP-FPM container is able to access the MySQL container by the hostname mysql.

# Start container
$ docker run -d \
    -e MYSQL_BACKUP_USER=root \
    -e MYSQL_BACKUP_PASS=somepass \
    -e MYSQL_BACKUP_HOST=mysql \
    -v ~/backups:/shared/backups \
    --name php \
    -t devilbox/php-fpm:7.2-work

# Run database dump
$ docker exec -it php mysqldump-secure

Automated builds

Docker images are built and tested every night by GitHub Actions and pushed to Docker hub on success. This is all done automatically to ensure that sources as well as base images are always fresh and in case of security updates always have the latest patches.

Contributing

Contributors are welcome. Feel free to star and clone this repository and submit issues and pull-requests. Add examples and show what you have created with the provided images. If you see any errors or ways to improve this repository in any way, please do so.

Credits

• cytopia

License

MIT License

Copyright (c) 2017 cytopia