# 安装说明
## docker安装
docker中安装可以使用以下镜像，已经安装了必须的扩展
docker pull flysnow/workerman
~~~
docker run -dit --name flysocket -p 8282:8282 -v /home/www/wwwroot:/www flysnow/workerman
~~~
Dockerfile如下
```
~~~
FROM php:7.3-cli
LABEL maintainer="waxiongfeifei@gmail.com" version="1.0"
RUN sed -i s@/deb.debian.org/@/mirrors.aliyun.com/@g /etc/apt/sources.list \
&& apt-get clean \
&& apt-get update \
&& apt-get install -y openssl libssl-dev \
&& apt-get install libevent-dev -y \
&& docker-php-ext-install pcntl sockets pdo_mysql \
&& sh -c '/bin/echo -e "no\nyes\n/usr\nno\nyes\nno\nyes\nno" | pecl install event' \
&& docker-php-ext-enable event \
&& pecl install redis \
&& docker-php-ext-enable redis \
&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin --filename=composer
EXPOSE 8282 8283 7273 1238
CMD /bin/bash
~~~
```
## 本机安装
# Linux系统环境检测
Linux系统可以使用以下脚本测试本机PHP环境是否满足WorkerMan运行要求。`curl -Ss http://www.workerman.net/check.php | php`
上面脚本如果全部显示ok，则代表满足WorkerMan要求，直接到[官网](http://www.workerman.net/)下载例子即可运行。
如果不是全部ok，则参考下面文档安装缺失的扩展即可。
（注意：检测脚本中没有检测event扩展或者libevent扩展，如果业务并发连接数大于1024必须安装event扩展或者libevent扩展，并且[优化Linux内核](http://doc.workerman.net/appendices/kernel-optimization.html)，扩展安装方法参照下面说明）
# 已有PHP环境安装缺失扩展
## 安装pcntl和posix扩展：
**centos系统**
如果php是通过yum安装的，则命令行运行`yum install php-process`即可安装pcntl和posix扩展。
如果安装失败或者php本身不是用yum安装的请参考手册[附录-安装扩展](http://doc.workerman.net/appendices/install-extension.html)一节中方法三源码编译安装。
**debian/ubuntu/mac os系统**
参考手册[附录-安装扩展](http://doc.workerman.net/appendices/install-extension.html)一节中方法三源码编译安装。
## 安装event或者libevent扩展：
为了能支持更大的并发连接数，必须安装event扩展或者libevent扩展(二者作用相同，二选一即可)，并且[优化Linux内核](http://doc.workerman.net/appendices/kernel-optimization.html)。以Event为例，安装方法如下:
**centos系统**
1、安装event扩展依赖的libevent-devel包，命令行运行
~~~
yum install libevent-devel -y
# 如果无法安装，尝试使用下面的命令
# yum install libevent2-devel -y
~~~
2、安装event扩展，命令行运行
(event扩展要求PHP>=5.4，PHP5.3用户请安装libevent扩展，见本页面底部)
~~~
pecl install event
~~~
注意提示：`Include libevent OpenSSL support [yes] :`时输入`no`回车，
注意提示：`PHP Namespace for all Event classes :`时输入`yes`，其它直接敲回车就行
如果安装失败请参考页面底部常见问题或者跳过以下步骤尝试安装libevent扩展，见本页面底部。
3、命令行运行（如果ini文件位置不对，可以通过运行`php --ini`找到实际加载的ini文件路径）
~~~
echo extension=event.so > /etc/php.d/30-event.ini
~~~
**debian/ubuntu系统安装**
1、安装event扩展依赖的libevent-dev包，命令行运行
~~~
apt-get install libevent-dev -y
# 如果无法安装，请尝试以下命令
# apt-get install libevent2-dev -y
~~~
2、安装event扩展，命令行运行
(注意：event扩展要求PHP>=5.4，PHP5.3用户请安装libevent扩展，见本页面底部)
~~~
pecl install event
~~~
注意提示：`Include libevent OpenSSL support [yes] :`时输入`no`回车，
注意提示：`PHP Namespace for all Event classes :`时输入`yes`，其它直接敲回车就行
如果安装失败请参考页面底部常见问题或者跳过以下步骤尝试安装libevent扩展，见本页面底部。
3、命令行运行(需要切换到root用户。如果ini文件位置不对，可以通过运行`php --ini`找到实际加载的ini文件路径)
~~~
echo extension=event.so > /etc/php5/cli/conf.d/30-event.ini
~~~
**mac os 系统安装教程**
mac 系统一般作为开发机，不必安装event扩展。
# 全新系统安装（全新安装PHP+扩展）
## centos系统安装教程
1、命令行运行（此步骤包含了安装php-cli主程序以及pcntl、posix、libevent库及git程序）
~~~
yum install php-cli php-process git gcc php-devel php-pear libevent-devel -y
~~~
2、安装event扩展，命令行运行
(注意：event扩展要求PHP>=5.4，PHP5.3用户请安装libevent扩展(libevent扩展也支持php5.4-5.6)，见本页面底部)
~~~
pecl install event
~~~
注意提示：`Include libevent OpenSSL support [yes] :`时输入`no`回车，
注意提示：`PHP Namespace for all Event classes :`时输入`yes`，其它直接敲回车就行
如果安装失败请参考页面底部常见问题或者跳过以下步骤3，尝试安装libevent扩展，见本页面底部。
3、命令行运行（此步骤是配置event扩展的ini配置，如果ini文件位置不对，可以通过运行`php --ini`找到实际加载的ini文件路径）
~~~
echo extension=event.so > /etc/php.d/30-event.ini
~~~
4、命令行运行（此步骤是通过github下载WorkerMan主程序）
~~~
git clone https://github.com/walkor/Workerman
~~~
5、参考[入门指引--简单开发实例部分](http://doc.workerman.net/getting-started/simple-example.html)写入口文件运行。
或者从[官网](http://www.workerman.net/)下载打包好的demo运行。
## debian/ubuntu系统安装教程
1、命令行运行（此步骤包含了安装php-cli主程序、libevent库及git程序）
~~~
apt-get install php5-cli git gcc php-pear php5-dev libevent-dev -y
~~~
2、安装event扩展，命令行运行
(注意：event扩展要求PHP>=5.4，PHP5.3用户请安装libevent扩展(libevent扩展也支持php5.4-5.6)，见本页面底部)
~~~
pecl install event
~~~
注意提示：`Include libevent OpenSSL support [yes] :`时输入`no`回车，
注意提示：`PHP Namespace for all Event classes :`时输入`yes`，其它直接敲回车就行
如果安装失败请参考页面底部常见问题或者跳过以下步骤3，尝试安装libevent扩展，见本页面底部。
3、命令行运行（需要切换到root用户。此步骤是配置Event扩展的ini配置，如果ini文件位置不对，可以通过运行`php --ini`找到实际加载的ini文件路径）
~~~
echo extension=event.so > /etc/php5/cli/conf.d/30-event.ini
~~~
4、命令行运行（此步骤是通过github下载WorkerMan主程序）
~~~
git clone https://github.com/walkor/Workerman
~~~
5、参考[入门指引--简单开发实例部分](http://doc.workerman.net/getting-started/simple-example.html)写入口文件运行。
或者从[官网](http://www.workerman.net/)下载打包好的demo运行。
## mac os 系统安装教程
**方法1：**mac系统自带PHP Cli，但是可能缺少`pcntl`扩展。
1、参考手册[附录-安装扩展](http://doc.workerman.net/appendices/install-extension.html)一节中方法三源码编译安装`pcntl`扩展。
2、参考手册[附录-安装扩展](http://doc.workerman.net/appendices/install-extension.html)一节中方法四利用phpize安装`event`扩展（作为开发机此可省略）。
3、通过[http://www.workerman.net/download/workermanzip](http://www.workerman.net/download/workermanzip)下载WorkerMan主程序，或者到[官网](http://www.workerman.net/)下载例子运行。
**方法2：**通过`brew`命令安装php及对应扩展
1、命令行运行以下命令安装`brew`工具(如果已经安装过`brew`可以跳过此步骤)
~~~
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
~~~
2、命令行运行以下命令安装`php7`
~~~
brew install php70
~~~
3、命令行运行以下命令安装`event`扩展
~~~
brew install php70-event
~~~
4、到[官网](http://www.workerman.net/)下载例子运行
# Event扩展说明
[Event扩展](http://php.net/manual/zh/book.event.php)不是必须的，当业务需要支撑大于1000的并发连接时，推荐安装Event，能够支持巨大的并发连接。如果业务并发连接比较低，例如1000以下并发连接，则可以不用安装。
如果无法安装[Event扩展](http://php.net/manual/zh/book.event.php)，可以用[libevent扩展](http://php.net/manual/zh/book.libevent.php)代替，注意目前libevent扩展不支持php7，php7用户只能使用Event扩展。
## 安装libevent扩展方法如下：
**注意：**1、libevent扩展也同样依赖libevent库，所以首先需要安装libevent-devel包(并非扩展)。 2、libevent扩展支持php5.3-5.6，目前还不支持php7。php7用户请使用event扩展，php7用户请不要装libevent扩展，否则会出现coredump错误。
**centos系统**
~~~
yum install libevent-devel
pecl install channel://pecl.php.net/libevent-0.1.0 //提示libevent installation [autodetect]: 时按回车
echo extension=libevent.so > /etc/php.d/libevent.ini
~~~
如果ini文件位置不对，可以通过运行`php --ini`找到实际加载的ini文件路径
**debian/ubuntu系统**
~~~
apt-get install libevent-dev
pecl install channel://pecl.php.net/libevent-0.1.0 //提示libevent installation [autodetect]: 时按回车
echo extension=libevent.so > /etc/php5/cli/conf.d/libevent.ini
~~~
如果ini文件位置不对，可以通过运行`php --ini`找到实际加载的ini文件路径
## 常见问题
1、如果出现如下报错`checking for include/event2/event.h... not found`，请先尝试删除libevent-dev(el)库安并装libevent2-dev(el)。 centos系统：yum remove libevent-devel && yum install libevent2-devel debian/ubuntu系统：apt-get remove libevent-dev && apt-get install libevent2-dev
2、如果出现如下报错`NOTICE: PHP message: PHP Warning: PHP Startup: Unable to load dynamic library '.../event.so' - ..../event.so: undefined symbol: php_sockets_le_socket in Unknown on line 0`。 请更改event.so 和socket.so的加载顺序，既在php.ini中将`extension=socket.so`写在`extension=event.so`前面，让socket扩展先加载。
