Compared with other async programming frameworks or software such as Nginx, Tornado, Node.js, Open Swoole is a complete async solution that has built-in support for async programming via fibers/coroutines, a range of multi-threaded I/O modules (HTTP Server, WebSockets, GRPC, TaskWorkers, Process Pools) and support for popular PHP clients like PDO for MySQL, Redis and CURL. You can use sync or async, coroutine, fiber API to write the applications or create thousands of light weight fibers within one Linux process. Open Swoole enhances the efficiency of your PHP applications and brings you out of the traditional stateless model, enabling you to focus on the development of innovative products at high scale, bringing event loops and asynchronous programming to the PHP language. Important: Please make sure you have followed the prerequisites guide before trying to install Open Swoole, this ensures you have an up-to-date system and all the required third-party packages and libraries.
You can install Open Swoole binary releases via the Official Open Swoole Ubuntu PPA. For example, on Ubuntu or Debian:
You can install Open Swoole binary releases via the Remi's RPM repository. Install Epel and Remi Repo in RHEL:
Install Remi Repo in Fedora:
Open Swoole is released as a 5 package and can be installed using the command line from the binaries. This is the easiest and quickest way to get working with Open Swoole.
Or to install a specific version using PECL:
It is recommend to use Ubuntu on WSL to use Open Swoole on Windows. You must be running Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11.
When installing Open 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 0Longhand Configure Flag 1Note The Open Swoole PECL releases is later than the GitHub releases 2 3Make 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. 4The script above will clone Open Swoole from GitHub, checkout v4.6.7 and setup Open Swoole ready to compile using 6. We then use 7 to build Open Swoole with the options we want to enable, everything is then compiled using 8 and 9. You can choose which configuration options you need, see the for more information.You may need to run 9 with 1 privileges.After installing the Swoole extension to the PHP extensions directory, you will need to enable Open Swoole so that PHP can load the extension when executing code. Manually enabling Open Swoole via php.ini On most systems Open Swoole can be enabled by directly editing your 2 configuration file, you will want to add 3 to the end of the file and then Open Swoole should be enabled. 5Enabling Open Swoole via phpenmod Some Linux distributions like Debian or Ubuntu use the PHP 4 to load PHP extensions, in this case you can use 5 to enable Swoole. Follow the commands below to get Swoole enabled.Make sure to change 6 to the version of PHP that you have installed. 6You can also disable Open Swoole using 7 if you need to (this is not uninstalling, just turning Swoole off): 7These configuration options are used for enabling some features with Open Swoole, you can use these when installing via PECL or compiling from source. Enable OpenSSL support. It depends on the 8 library given by your operating system.Set the path of OpenSSL library you want to use, for example: 9.Enable the support of HTTP2. It depends on 0 library which is built into Open Swoole for you. However, you have to enable this option still if you want HTTP2 support.Enable native CURL hook support for OpenSwoole coroutines. Since v4.6.0 there is native support for CURL, you must have 1 installed.Enable Postgres Coroutine support. Enable support for asynchronous DNS support, made possible by compiling the DNS library 2. By default this feature is off, if 2 is not enabled, async DNS queries within OpenSwoole are simulated with a pool of blocking processes to process.Once 2 is enabled in OpenSwoole, all the DNS queries produced by the OpenSwoole DNS API 5, 6 or OpenSwoole coroutine clients are asynchronous, including the MySQL client, Redis Client, HTTP Client, CURL etc. Also any DNS name resolves as well.You have to install libc-ares before enabling this flag: 8Enable support for 7, for example this adds support for 8. You must also install the PHP 7 module for this option to work. However, it is more recommended to use PHP PDO MySQL instead.Or use 0 when you have postgres library installed at a custom location.Enable support for 1, this adds support for Coroutine PostgreSQL ClientEnable sockets support. It depends on the PHP sockets extension. If this configuration has been enabled, the function 2 can add the connection created by the sockets extension to the event loop of Swoole. And the function 3 depends on this configuration being enabled. However, the 4 service can do most things and may be more recommended.Turn on debugging mode for Swoole. You will need 5 installed to use this parameter.Enable the debug logs of OpenSwoole. Don't enable this configuration in a production environment. Turn on the trace log. After enabling this option, OpenSwoole will printout various details of the debug log, which is only used during kernel development. Statically compile OpenSwoole and extend it to PHP. This option is only used when compiling PHP instead of OpenSwoole. When a new OpenSwoole version is released, you can upgrade but it depends on how you installed OpenSwoole. There is no need to uninstall OpenSwoole or delete any previous files, upgrading will overwrite any files or binaries, the install/upgrade process only produces one 6 binary for PHP to use.For changelogs and updates, check out posts at https://openswoole.com/article/ If you installed via PECL, you can just run: 9Or to install a specific version using PECL: 0If you compiled OpenSwoole yourself from GitHub, you can recompile and install new changes/version again. 1If you installed OpenSwoole via the Open Swoole Ubuntu PPA, you should receive updates via your package manager. For example, on Ubuntu or Debian: 2If you are using a new version of PHP, perform a 7 to install the correct version.If you are having difficulty installing or upgrading Swoole, first check the prerequisites guide but if that does not help, checkout the common installation errors for more help. You can follow the instruction about how to debug segment fault errors with Swoole if you come across any. 3You have to install OpenSwoole Core composer library to access to a few features such as 8 and addon functions implemented with PHP: |