This image is built for general-purpose. We have different examples included in this Git repository to help developers to get familiar with the image and Swoole.
You can get the image from here.
- Feature List
- How to Use This Image
- Image Variants
- Supported Tags and Respective Dockerfile Links
- Build Images Manually
- Credits
- Built-in scripts to manage Swoole extensions and Supervisord programs.
- Easy to manage booting scripts in Docker.
- Allow running PHP scripts and other commands directly in different environments (including ECS).
- Use one root filesystem for simplicity (one Docker
COPYcommand only in dockerfiles). - Composer included (Composer v1 for Swoole 4.5.8 and before; Composer v2 for Swoole 4.5.9 and after).
- Built for different architectures.
- Support auto-reloading for local development.
- Support code debugging for local development.
The phpswoole/swoole image is built using the official PHP image as base image, with a few changes.
For basic usage, please check the description section of the official PHP image.
Same as in the official PHP image, most PHP extensions can be installed/configured using built-in helper scripts docker-php-ext-configure, docker-php-ext-install, docker-php-ext-enable, and docker-php-source. Here are some examples.
# To install the MySQL extensions.
FROM phpswoole/swoole:4.6-php7.4-alpine
RUN docker-php-ext-install mysqli pdo_mysql# To install the Redis extension.
FROM phpswoole/swoole:4.6-php7.4-alpine
RUN set -ex \
&& pecl update-channels \
&& pecl install redis-stable \
&& docker-php-ext-enable redis# To install the Couchbase extension.
FROM phpswoole/swoole:4.6-php7.4-alpine
RUN set -ex \
&& apk update \
&& apk add --no-cache libcouchbase=2.10.6-r0 \
&& apk add --no-cache --virtual .build-deps $PHPIZE_DEPS libcouchbase-dev=2.10.6-r0 zlib-dev \
&& pecl update-channels \
&& pecl install couchbase-2.6.2 \
&& docker-php-ext-enable couchbase \
&& apk del .build-deps \
&& rm -rf /var/cache/apk/* /tmp/* /usr/share/man /usr/src/php.tar.xz*Following examples are for non-Alpine images only. We don't have examples included for the Alpine images.
You can use the image to serve an HTTP/WebSocket server, or run some one-off command with it. e.g.,
docker run --rm phpswoole/swoole "php -m"
docker run --rm phpswoole/swoole "php --ri swoole"
docker run --rm phpswoole/swoole "composer --version"We have various examples included under folder "examples/" to help developers better use the image. These examples are numerically ordered. Each example has a docker-compose.yml file included, along with some other files. To run an example, please start Docker containers using the docker-compose.yml file included, then check HTTP output from URL http://127.0.0.1 unless otherwise noted. You may use the following commands to start/stop/restart Docker containers:
./bin/example.sh start 00 # To start container(s) of the first example.
./bin/example.sh stop 00 # To stop container(s) of the first example.
./bin/example.sh restart 00 # To restart container(s) of the first example.To run another example, just replace the last command line parameter 00 with an example number (e.g., 05).
Here is a list of the examples under folder "examples/":
- Basic examples:
- 00-autoload: Restart the Swoole web server automatically if file changes detected under web root.
- 01-basic: print out "Hello, World!" using Swoole as backend HTTP server.
- 02-www: to use some customized PHP script(s) in the Docker image built.
- 03-nginx: to use Swoole behind an Nginx server.
- 04-entrypoint: to use a self-defined entrypoint script in the Docker image built.
- 05-boot: to update content in the Docker container through a booting script.
- 06-update-token: to show how to update server configurations with built-in script update-token.sh.
- 07-disable-default-server: Please check the docker-compose.yml file included to see show how to disable the default web server created with Swoole.
- Manage PHP extensions and configurations:
- 10-install-php-extension: how to install/enable PHP extensions.
- 11-customize-extension-options: how to overwrite/customize PHP extension options.
- 12-php.ini: how to overwrite/customize PHP options.
- 13-install-swoole-extension: Please check the README file included to see how to install Swoole extensions like async, orm, postgresql, and serialize.
- 14-install-phpx: Please check the README file included to see how to install PHP-X.
- 15-install-phpx-extension: Please check the README file included to see how to install PHP-X based extensions like zookeeper.
- Manage Supervisord programs:
- 20-supervisord-services: to show how to run Supervisord program(s) in Docker.
- 21-supervisord-tasks: to show how to run Supervisord program(s) when launching a one-off command with Docker. Please check the README file included to see how to run the example.
- 22-supervisord-enable-program: to show how to enable program(s) in Supervisord program.
- 23-supervisord-disable-program: to show how to disable Supervisord program(s).
- Debugging:
- 30-debug-with-gdb: Please check the README file included to see how to debug your PHP code with gdb.
- 31-debug-with-valgrind: Please check the README file included to see how to debug your PHP code with Valgrind.
- 32-debug-with-strace: Please check the README file included to see how to debug your PHP code with strace.
- 33-debug-with-blackfire: Please check the README file included to see how to debug your PHP code with Blackfire. When debugging Swoole applications, we recommend to use yasd instead of Blackfire, sdebug, or Xdebug.
- 34-debug-with-sdebug: Please check the README file included to see how to debug your PHP code in different ways with sdebug (forked from Xdebug to work with Swoole). When debugging Swoole applications, we recommend to use yasd instead of Blackfire, sdebug, or Xdebug.
- 35-debug-with-yasd: Please check the README file included to see how to debug a Swoole-based web server using yasd (Yet Another Swoole Debugger) in Phpstorm.
The phpswoole/swoole images come in three flavors, each designed for a specific use case. In production environment, we suggest using the Alpine images.
phpswoole/swoole:latestphpswoole/swoole:4.7phpswoole/swoole:4.7-php8.0phpswoole/swoole:4.7.1-php8.0
This variant is based on the php:cli images, with a few changes. It uses Supervisord to manage booting processes, and has Composer preinstalled.
phpswoole/swoole:latest-devphpswoole/swoole:4.7-devphpswoole/swoole:4.7-php8.0-devphpswoole/swoole:4.7.1-php8.0-dev
This variant is very similar to the previous one, but it has extra tools added for testing, debugging, and monitoring purpose, including gdb, git, lsof, strace, tcpdump, Valgrind, and vim.
phpswoole/swoole:latest-alpinephpswoole/swoole:4.7-alpinephpswoole/swoole:4.7-php8.0-alpinephpswoole/swoole:4.7.1-php8.0-alpine
You can use this variant in the same way as using the php:alpine image, except that we changed the default working directory to /var/www. Also, we have Composer preinstalled in the image.
Note: We don't have development tools built in for Alpine images. There is no Docker images like phpswoole/swoole:4.7.1-php8.0-alpine-dev.
Nightly images (built daily using the master branch of swoole-src)
| PHP Versions | Default Images | Dev Images | Alpine Images |
|---|---|---|---|
| PHP 8.0 | php8.0 | php8.0-dev | php8.0-alpine |
| PHP 7.4 | php7.4 | php7.4-dev | php7.4-alpine |
| PHP 7.3 | php7.3 | php7.3-dev | php7.3-alpine |
| PHP 7.2 | php7.2 | php7.2-dev | php7.2-alpine |
The Docker images are built and pushed out automatically through Travis. If you want to build some image manually, please follow these three steps.
1. Install Composer packages. If you have command "composer" installed already, just run composer update -n.
2. Use commands like following to create dockerfiles:
./bin/generate-dockerfiles.php latest # Generate dockerfiles to build images from the master branch of Swoole.
./bin/generate-dockerfiles.php 4.7.1 # Generate dockerfiles to build images for Swoole 4.7.1.3. Build Docker images with commands like:
docker build -t phpswoole/swoole -f dockerfiles/latest/php8.0/cli/Dockerfile .
docker build -t phpswoole/swoole:4.7.1-php8.0 -f dockerfiles/4.7.1/php8.0/cli/Dockerfile .
docker build -t phpswoole/swoole:4.7.1-php8.0-alpine -f dockerfiles/4.7.1/php8.0/alpine/Dockerfile .To build development images (where extra tools are included), add an argument DEV_MODE:
docker build --build-arg DEV_MODE=true -t phpswoole/swoole:latest-dev -f dockerfiles/latest/php8.0/cli/Dockerfile .
docker build --build-arg DEV_MODE=true -t phpswoole/swoole:4.7.1-php8.0-dev -f dockerfiles/4.7.1/php8.0/cli/Dockerfile .Current implementation borrows ideas from Demin's work at Glu Mobile.