Notice: the documentation is suitable for PHP extension
swooleuntil v4.7.1, we only support PHP extension
Important: Please make sure you have followed the prerequisites guide before trying to install Swoole, this ensures you have an up-to-date system and all the required third-party packages and libraries. You should also have PHP installed first, refer to the PHP manual for this; in general though PHP can be installed via:
Either compile PHP directly or use your Unix like package installation system, for example on Ubuntu:
#!/bin/bash $ sudo apt-get update && sudo apt-get upgrade # Update your server $ sudo apt-get install php # Install default PHP package # Check installed version and info $ php -v
Open Swoole is released as a
PECL package and can be installed using the command line from the binaries. This is the easiest and quickest way to get working with Swoole.
#!/bin/bash # Make sure PECL is available... $ sudo apt install php-dev # Latest relese of Swoole via PECL $ sudo pecl install openswoole
Or to install a specific version using PECL:
#!/bin/bash $ sudo pecl install openswoole-4.7.1
When installing Swoole via PECL, during the installation it will ask you if you would like to enable certain features, this can be provided before running the installation, this helps with automating the installation of Swoole or for when you don't want the installation to stop and wait for input. Some options require third party libraries to be installed, see prerequisites.
Shorthand Configure Flag
#!/bin/bash $ pecl install -D 'enable-sockets="no" enable-openssl="yes" enable-http2="yes" enable-mysqlnd="yes" enable-swoole-json="no" enable-swoole-curl="yes" enable-cares="yes"' openswoole
Longhand Configure Flag
#!/bin/bash $ pecl install --configureoptions 'enable-sockets="no" enable-openssl="yes" enable-http2="yes" enable-mysqlnd="yes" enable-swoole-json="no" enable-swoole-curl="yes" enable-cares="yes"' openswoole
Note The Swoole PECL releases is later than the GitHub releases
#!/bin/bash # If you haven't got PHP installed $ brew install php $ pecl install openswoole
Make sure to read the prerequisites first before compiling Swoole.
To compile and install the Swoole extension for PHP, we can clone the repository from GitHub where Swoole is developed, checkout the version you want to compile and manually install it.
Download the source package from GitHub Releases or clone from the git repository.
#!/bin/bash # Install git to access the source code from GitHub $ sudo apt install git $ cd /tmp && git clone https://github.com/openswoole/swoole-src.git && \ cd swoole-src && \ git checkout v4.7.1 && \ phpize && \ ./configure --enable-openssl \ --enable-mysqlnd \ --enable-sockets \ --enable-http2 \ --enable-swoole-curl \ --enable-swoole-json \ --enable-cares && \ sudo make && sudo make install
The script above will clone Swoole from GitHub, checkout v4.6.7 and setup Swoole ready to compile using
phpize. We then use
./configure to build Swoole with the options we want to enable, everything is then compiled using
make install. You can choose which configuration options you need, see the configuration parameters for more information.
You may need to run
make install with
After installing the Swoole extension to the PHP extensions directory, you will need to enable Swoole so that PHP can load the extension when executing code.
Manually enabling Swoole via php.ini
On most systems Swoole can be enabled by directly editing your
php.ini configuration file, you will want to add
extension=openswoole to the end of the file and then Swoole should be enabled.
#!/bin/bash # Check the loaded CLI php.ini config file location $ php -i | grep php.ini # Add the openswoole.so extension to the end of your loaded cli php.ini $ sudo bash -c "echo 'extension=openswoole' >> $(php -i | grep /.+/php.ini -oE)" # Manually set the path of your php.ini file $ sudo bash -c 'echo "extension=openswoole" >> /etc/php/7.4/cli/php.ini' # Check if the Swoole extension has been enabled $ php -m | grep openswoole
Enabling Swoole via phpenmod
Some Linux distributions like Debian or Ubuntu use the PHP
mods-available to load PHP extensions, in this case you can use
phpenmod to enable Swoole. Follow the commands below to get Swoole enabled.
Make sure to change
<PHP_VERSION> to the version of PHP that you have installed.
#!/bin/bash # Create a Swoole extension PHP ini file, letting PHP know which modules to load $ sudo bash -c "cat > /etc/php/<PHP_VERSION>/mods-available/openswoole.ini << EOF ; Configuration for Swoole ; priority=25 extension=openswoole EOF" # Enable the Swoole PHP extension only on CLI mode $ sudo phpenmod -s cli openswoole # Optional: Enable Swoole for specific version of PHP CLI $ sudo phpenmod -s cli -v 7.4 openswoole # Check if the Swoole extension has been enabled $ php -m | grep openswoole
You can also disable Swoole using
phpdismod if you need to (this is not uninstalling, just turning Swoole off):
#!/bin/bash # Turn off Swoole for CLI or a specific PHP install sudo phpdismod -s cli openswoole sudo phpdismod -s cli -v 7.4 openswoole
These configuration options are used for enabling some features with Swoole, you can use these when installing via PECL or compiling from source.
Enable OpenSSL support. It depends on the
libssl.so library given by your operating system.
Set the path of OpenSSL library you want to use, for example:
Enable the support of HTTP2. It depends on
nghttp2 library which is built into Swoole for you. However, you have to enable this option still if you want HTTP2 support.
Enable Swoole JSON support, this enables the Swoole JSON functions. You must also install PHP-JSON as well.
Enable native CURL hook support for Swoole coroutines. Since v4.6.0 there is native support for CURL, you must have
Enable support for asynchronous DNS support, made possible by compiling the DNS library
C-ares. By default this feature is off, if
C-ares is not enabled, async DNS queries within Swoole are simulated with a pool of blocking processes to process.
C-ares is enabled in Swoole, all the DNS queries produced by the Swoole DNS API
System::gethostbyname or Swoole coroutine clients are asynchronous, including the MySQL client, Redis Client, HTTP Client, CURL etc. Also any DNS name resolves as well.
Enable support for
mysqlnd, for example this adds support for
$mysql->escape(...). You must also install the PHP
mysqlnd module for this option to work. However, it is more recommended to use PHP PDO MySQL instead.
Enable sockets support. It depends on the PHP sockets extension. If this configuration has been enabled, the function
Swoole\Event::add() can add the connection created by the sockets extension to the event loop of Swoole. And the function
getSocket() depends on this configuration being enabled. However, the
Coroutine\Socket service can do most things and may be more recommended.
Turn on debugging mode for Swoole. You will need
gdb installed to use this parameter.
Enable the debug logs of Swoole. Don't enable this configuration in a production environment.
Turn on the trace log. After enabling this option, Swoole will printout various details of the debug log, which is only used during kernel development.
Statically compile Swoole and extend it to PHP. This option is only used when compiling PHP instead of Swoole.
When a new Swoole version is released, you can upgrade but it depends on how you installed Swoole.
There is no need to uninstall Swoole or delete any previous files, upgrading will overwrite any files or binaries, the install/upgrade process only produces one
openswoole.so binary for PHP to use.
For changelogs and updates, check out posts at https://www.swoole.co.uk/article/
If you installed via PECL, you can just run:
#!/bin/bash $ sudo pecl upgrade openswoole
Or to install a specific version using PECL:
#!/bin/bash $ sudo pecl upgrade openswoole-4.5.5
If you compiled Swoole yourself from GitHub, you can recompile and install new changes/version again.
#!/bin/bash # Enter the directory where you cloned Swoole cd swoole-src # Pull down any new changes or checkout a new tag git pull | git checkout v4.6.7 | git checkout master # Reconfigure the build for PHP again phpize clean && phpize # Configure Swoole features again ./configure --enable-openssl \ --enable-mysqlnd \ --enable-sockets \ --enable-http2 \ --enable-swoole-curl ... # Perform a clean so we can recompile make clean # Build and Compile new version sudo make && sudo make install
If you installed Swoole via the ondrej/php PPA, you should receive updates via your package manager. For example, on Ubuntu or Debian:
#!/bin/bash sudo apt update sudo apt upgrade # Upgrade Swoole package only, change to what you have installed sudo apt update sudo apt install --only-upgrade php-openswoole
If you are using a new version of PHP, perform a
apt search openswoole to install the correct version.
You can follow the instruction about how to debug segment fault errors with Swoole if you come across any.
#!/bin/bash # Show Swoole installed options and information $ php --ri openswoole ... # Example output from command above... Open Swoole => enabled Author => Swoole Development Group <[email protected]> Version => 4.7.2-dev Built => Oct 15 2021 22:41:25 coroutine => enabled with boost asm context kqueue => enabled rwlock => enabled sockets => enabled openssl => OpenSSL 3.0.0 7 sep 2021 dtls => enabled http2 => enabled json => enabled curl-native => enabled pcre => enabled c-ares => 1.17.2 zlib => 1.2.11 brotli => E16777225/D16777225 mysqlnd => enabled async_redis => enabled Directive => Local Value => Master Value swoole.enable_coroutine => On => On swoole.enable_library => On => On swoole.enable_preemptive_scheduler => Off => Off swoole.display_errors => On => On swoole.use_shortname => On => On swoole.unixsock_buffer_size => 262144 => 262144