Skip to content

Latest commit

 

History

History
259 lines (209 loc) · 7.74 KB

README.md

File metadata and controls

259 lines (209 loc) · 7.74 KB
Raw

Docker PHP-FPM with Nginx

Introduction

This image is based on official PHP-FPM Docker image.

Additional software:

  • Nginx (with pre-made configs for Laravel, Laravel Octane, Symfony and Wordpress)
  • SQLite
  • Composer
  • Xdebug
  • NodeJS
  • Blackfire
  • Command-line clients for MySQL and PostgreSQL to support migration squashing
  • htop
  • GNU nano
  • Open SSH

Compiled in modules (according to php -m):

bcmath
blackfire
Core
ctype
curl
date
dom
exif
fileinfo
filter
ftp
gd
gmp
hash
iconv
intl
json
libxml
mbstring
mysqlnd
openssl
pcntl
pcre
PDO
pdo_mysql
pdo_pgsql
pdo_sqlite
Phar
posix
readline
redis
Reflection
session
SimpleXML
sockets
sodium
SPL
sqlite3
standard
tokenizer
xdebug
xml
xmlreader
xmlwriter
Zend OPcache
zip
zlib

Supported PHP Versions

  • 8.1 (use adiachenko/php-nginx:8.1)
  • 8.2 (use adiachenko/php-nginx:8.2)
  • 8.3 (use adiachenko/php-nginx:8.3)

Usage

Example docker-compose.yml file for Laravel project:

version: '3.8'

services:
  app:
    image: adiachenko/php-nginx
    environment:
      - NGINX_SERVER_TYPE=laravel
    ports:
      - 8000:80
    volumes:
      - ./:/opt/project:cached

You can set Nginx config suited for your framework using NGINX_SERVER_TYPE env variable (container restart required):

  • laravel
  • octane
  • symfony
  • wordpress

Apple Silicon

This image doesn't natively support Apple Silicon, because MySQL doesn't provide ARM64 version for Debian which we need in order to install a command-line client.

However, you can add --platform linux/amd64 to run this image under emulation.

Production Usage

If you don't mind the size of the image, it's perfectly suitable for production usage. Just enable opcache and adjust other settings using env variables as described in configuration section.

SSH

In some circumstances when using private Composer packages you may need SSH keys for authentication. I still recommend using tokens with Docker whenever possible, but if you setup does not allow it, you may provide base64 encoded value of your SSH private key (e.g. ~/.ssh/id_rsa) here:

You can use online base64 encoder to encode the value. Copy all the text from the id_rsa file (including comments and the last empty line). If you still get access denied errors with the key encoded in this manner, ensure that you have an empty line in the end before encoding the value.

CONTAINER_SSH_PRIVATE_KEY_BASE64=

Cron Schedule

You don't need cron for scheduled tasks in Docker. There are cleaner alternatives for containers like Ofelia. Another option is to run command like Laravel Cronless Schedule in a separate container.

Here is an example using Ofelia with a Laravel app:

version: '3.8'

services:
  app:
    image: adiachenko/php-nginx
    environment:
      - NGINX_SERVER_TYPE=laravel
    ports:
      - 8000:80
    volumes:
      - ./:/opt/project:cached
    labels:
      # See https://github.com/mcuadros/ofelia#docker-labels-configurations
      ofelia.enabled: 'true'
      ofelia.job-exec.schedule.schedule: '@every 60s'
      ofelia.job-exec.schedule.command: 'php artisan schedule:run'

  ofelia:
    depends_on:
      - app
    image: mcuadros/ofelia:v0.3.6
    command: daemon --docker
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro

Laravel Octane

This image only supports Roadrunner server.

Octane runs as PHP CLI application so we must adjust docker-compose.yml file accordingly:

version: '3.8'

services:
  app:
    image: adiachenko/php-nginx
    # Run the image without PHP-FPM
    command: >
      bash -c "envsubst < /etc/nginx/conf.d/default.template > /etc/nginx/sites-available/default && nginx"
    environment:
      - NGINX_SERVER_TYPE=octane
      - PHP_OPCACHE_ENABLE_CLI=1
    ports:
      - 8000:80
    volumes:
      - ./:/opt/project:cached

Configuration

This image ships with the default php.ini for production environments.

Default Opcache settings are adjusted with the following values to improve DX:

Make sure you disable opcache.validate_timestamps for deployed version of your image.

; If enabled, OPcache will check for updated scripts every opcache.revalidate_freq
; seconds. When this directive is disabled, you must reset OPcache manually
; by running 'kill -USR2 1' inside the container
opcache.validate_timestamps=1

; How often to check script timestamps for updates, in seconds. 0 will result
; in OPcache checking for updates on every request. This configuration
; directive is ignored if opcache.validate_timestamps is disabled.
opcache.revalidate_freq=0

You can change configuration using the following environment variables:

Envitonment Variable Default
PHP_DISPLAY_ERRORS Off
PHP_DISPLAY_STARTUP_ERRORS Off
PHP_ERROR_REPORTING E_ALL & ~E_DEPRECATED & ~E_STRICT
PHP_MEMORY_LIMIT 128M
PHP_POST_MAX_SIZE 8M
PHP_UPLOAD_MAX_SIZE 2M
PHP_REALPATH_CACHE_SIZE 4K
PHP_REALPATH_CACHE_TTL 120
PHP_OPCACHE_ENABLE_CLI 0
PHP_OPCACHE_MEMORY_CONSUMPTION 128
PHP_OPCACHE_JIT_BUFFER_SIZE 0
PHP_OPCACHE_INTERNED_STRINGS_BUFFER 8
PHP_OPCACHE_MAX_ACCELERATED_FILES 10000
PHP_OPCACHE_MAX_WASTED_PERCENTAGE 5
PHP_OPCACHE_VALIDATE_TIMESTAMPS 1
PHP_OPCACHE_SAVE_COMMENTS 1
PHP_XDEBUG_MODE off
PHP_XDEBUG_CLIENT_HOST host.docker.internal

You may also tweak process manager settings:

Envitonment Variable Default
PHP_FPM_MAX_CHILDREN 20
PHP_FPM_START_SERVERS 2
PHP_FPM_MIN_SPARE_SERVERS 1
PHP_FPM_MAX_SPARE_SERVERS 3
PHP_FPM_MAX_REQUESTS 1000

Creating Images

Build images:

docker build --platform linux/amd64 --no-cache -t adiachenko/php-nginx:8.3 .
docker build --platform linux/amd64 -t adiachenko/php-nginx:latest .

Push images to Docker Hub:

docker push adiachenko/php-nginx:8.3
docker push adiachenko/php-nginx:latest