Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rryqszq4/ngx-php

ngx-php - Embedded php7 or php8 scripting language for nginx module. Mainline development version of the ngx-php.
https://github.com/rryqszq4/ngx-php

module nginx nginx-module php php7 php8

Last synced: 6 days ago
JSON representation

ngx-php - Embedded php7 or php8 scripting language for nginx module. Mainline development version of the ngx-php.

Host: GitHub
URL: https://github.com/rryqszq4/ngx-php
Owner: rryqszq4
License: bsd-2-clause
Created: 2016-03-25T09:49:21.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2024-12-19T05:43:05.000Z (15 days ago)
Last Synced: 2024-12-21T05:06:03.995Z (13 days ago)
Topics: module, nginx, nginx-module, php, php7, php8
Language: C
Homepage:
Size: 1.49 MB
Stars: 650
Watchers: 27
Forks: 55
Open Issues: 48
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: LICENSE

Awesome Lists containing this project

README

ngx-php
========
[![Build](https://github.com/rryqszq4/ngx-php/actions/workflows/build.yml/badge.svg)](https://github.com/rryqszq4/ngx-php/actions/workflows/build.yml)
[![GitHub release](https://img.shields.io/github/release/rryqszq4/ngx-php.svg)](https://github.com/rryqszq4/ngx-php/releases/latest)
[![license](https://img.shields.io/badge/license-BSD--2--Clause-blue.svg)](https://github.com/rryqszq4/ngx-php/blob/master/LICENSE)
[![QQ group](https://img.shields.io/badge/QQ--group-558795330-26bcf5.svg)](https://github.com/rryqszq4/ngx-php)

ngx-php is an extension module of high-performance web server nginx, which implements embedded PHP7 and PHP8 script to process nginx location and variables.

ngx-php draws on the design of [ngx_lua](https://github.com/openresty/lua-nginx-module) and is committed to providing non-blocking web services with significant performance advantages over php-cgi, mod_php, php-fpm and hhvm.

ngx-php doesn't want to replace anything, just want to provide a solution.

There is a legacy version of [ngx_php5](https://github.com/rryqszq4/ngx_php/tree/ngx_php5), which records some of my past code practices and is also valuable.

[Benchmarks about ngx-php and php](https://www.techempower.com/benchmarks/#section=data-r19&hw=ph&test=fortune)

Table of contents
-----------------
* [What's different with official php](#Whats-different-with-official-php)
* [Requirement](#Requirement)
* [Installation](#Installation)
* [Synopsis](#Synopsis)
* [Test](#Test)
* [Directives](#Directives)
* [Nginx API for php](#Nginx-API-for-php)
* [Nginx non-blocking API for php](#Nginx-non-blocking-API-for-php)
* [Nginx constants](#Nginx-constants)
* [Copyright and License](#Copyright-and-License)

What's different with official php
----------------------------------
* Global variable is unsafe in per request
* Static variable of a class is unsafe in per request
* Do not design singleton mode
* The native IO function works fine, but it slows down nginx

Requirement
-----------
- Linux only
- PHP-7.* ~ PHP-8.3
- nginx-1.4.7 ~ nginx-1.25.x

Installation
------------

### Compile install

```sh
$ wget 'http://php.net/distributions/php-7.3.10.tar.gz'
$ tar xf php-7.3.10.tar.gz
$ cd php-7.3.10

$ ./configure --prefix=/path/to/php --enable-embed
$ make && make install

$ git clone https://github.com/rryqszq4/ngx-php.git

$ wget 'http://nginx.org/download/nginx-1.12.2.tar.gz'
$ tar -zxvf nginx-1.12.2.tar.gz
$ cd nginx-1.12.2

$ export PHP_CONFIG=/path/to/php/bin/php-config
$ export PHP_BIN=/path/to/php/bin
$ export PHP_INC=/path/to/php/include/php
$ export PHP_LIB=/path/to/php/lib

$ ./configure --user=www --group=www \
$ --prefix=/path/to/nginx \
$ --with-ld-opt="-Wl,-rpath,$PHP_LIB" \
$ --add-module=/path/to/ngx-php/third_party/ngx_devel_kit \
$ --add-module=/path/to/ngx-php
$ make && make install
```

### CentOS / RedHat 7

```sh
yum -y install https://extras.getpagespeed.com/release-el7-latest.rpm
yum -y install http://rpms.remirepo.net/enterprise/remi-release-7.rpm yum-utils
yum-config-manager --enable remi-php73
yum install nginx-module-php7
```

Edit `nginx.conf` and load the required modules at the top:

load_module modules/ndk_http_module.so;
load_module modules/ngx_http_php_module.so;

### Ubuntu
```sh
apt-get update -yqq && apt-get install -yqq software-properties-common
LC_ALL=C.UTF-8 add-apt-repository ppa:ondrej/php
apt-get update -yqq
apt-get install -yqq wget git unzip libxml2-dev cmake make systemtap-sdt-dev \
zlib1g-dev libpcre3-dev libargon2-0-dev libsodium-dev libkrb5-dev \
php7.4-cli php7.4-dev libphp7.4-embed php7.4-mysql

git clone https://github.com/rryqszq4/ngx-php.git

wget 'http://nginx.org/download/nginx-1.18.0.tar.gz'
tar -zxvf nginx-1.18.0.tar.gz
cd nginx-1.18.0

export PHP_LIB=/usr/lib

./configure --user=www --group=www \
--prefix=/path/to/nginx \
--with-ld-opt="-Wl,-rpath,$PHP_LIB" \
--add-module=/path/to/ngx-php/third_party/ngx_devel_kit \
--add-module=/path/to/ngx-php
make && make install
```

### Mac osx
[https://github.com/rryqszq4/ngx-php/blob/master/docs/zh-cn/osx_install.md](https://github.com/rryqszq4/ngx-php/blob/master/docs/zh-cn/osx_install.md)

### Docker

```sh
$ docker build -t nginx-php7 .
$ : "app.conf: Create nginx config"
$ docker run -p 80:80 -v $PWD/app.conf:/etc/nginx/conf.d/default.conf nginx-php7
```

Synopsis
--------

```nginx
worker_processes auto;

events {
worker_connections 102400;
}

http {
include mime.types;
default_type application/octet-stream;

keepalive_timeout 65;

client_max_body_size 64k;
client_body_buffer_size 64k;

php_ini_path /usr/local/php/etc/php.ini;

server {
listen 80;
server_name localhost;
default_type 'application/json; charset=UTF-8';

location /php {
content_by_php_block {
echo "hello ngx-php";
}
}

location = /ngx_request {
content_by_php_block {
echo ngx_request_document_uri();
}
}

# curl /ngx_get?a=1&b=2
location = /ngx_get {
content_by_php_block {
echo "ngx_query_args()\n";
var_dump(ngx_query_args());
}
}

# curl -d 'a=1&b=2' /ngx_post
location = /ngx_post {
content_by_php_block {
echo "ngx_post_args()\n";
var_dump(ngx_post_args());
}
}

location = /ngx_sleep {
content_by_php_block {
echo "ngx_sleep start\n";
yield ngx_sleep(1);
echo "ngx_sleep end\n";
}
}

location = /ngx_socket2 {
default_type 'application/json;charset=UTF-8';
content_by_php_block {
$fd = ngx_socket_create();

yield ngx_socket_connect($fd, "httpbin.org", 80);

$send_buf = "GET /get HTTP/1.1\r\n
Host: httpbin.org\r\n
Connection: close\r\n\r\n";
yield ngx_socket_send($fd, $send_buf, strlen($send_buf));

$recv_buf = "";
yield ngx_socket_recv($fd, $recv_buf);
var_dump($recv_buf);

yield ngx_socket_close($fd);
}
}

location = /ngx_var {
set $a 1234567890;
content_by_php_block {
$a = ngx_var_get("a");
var_dump($a);
}
}

# set content-type of response headers
location = /ngx_header {
content_by_php_block {
ngx_header_set("Content-Type", "text/html; charset=UTF-8");
}
}

# run a php file
location = /php {
content_by_php_block {
include "name_of_php_file.php";
}
}

# run any php file in root
location = / {
content_by_php_block {
include ngx_var_get("uri");
}
}

}
}
```

Test
----
Using the perl of [Test::Nginx](https://github.com/openresty/test-nginx) module to testing, searching and finding out problem in ngx-php.
```sh
Ngx-php test ...
nginx version: nginx/1.22.1
built by gcc 9.4.0 (Ubuntu 9.4.0-1ubuntu1~20.04.1)
configure arguments: --prefix=/home/runner/work/ngx-php/ngx-php/nginx --with-ld-opt=-Wl,-rpath,/usr/lib --add-module=../third_party/ngx_devel_kit --add-module=..
/home/runner/work/ngx-php/ngx-php
t/001-hello.t ..................... ok
t/002-ini.t ....................... ok
t/003-error.t ..................... ok
t/004-ngx_request.t ............... ok
t/005-ngx_log.t ................... ok
t/006-ngx_sleep.t ................. ok
t/007-ngx_socket.t ................ ok
t/008-ngx_exit.t .................. ok
t/009-ngx_query_args.t ............ ok
t/010-ngx_post_args.t ............. ok
t/011-ngx_constants.t ............. ok
t/012-function.t .................. ok
t/013-class.t ..................... ok
t/014-ngx_var.t ................... ok
t/015-ngx_header.t ................ ok
t/016-rewrite_by_php.t ............ ok
t/017-ngx_redirect.t .............. ok
t/018-ngx_mysql.t ................. skipped: Fix later
t/019-php_set.t ................... ok
t/020-ngx_cookie.t ................ ok
t/021-content_by_php_block.t ...... ok
t/022-init_worker_by_php_block.t .. ok
t/023-ngx_redis.t ................. ok
t/024-ngx_request_body.t .......... ok
t/025-opcache.t ................... ok
All tests successful.
Files=25, Tests=92, 16 wallclock secs ( 0.08 usr 0.04 sys + 4.56 cusr 0.93 csys = 5.61 CPU)
Result: PASS
```

Directives
----------
* [php_ini_path](#php_ini_path)
* [init_worker_by_php](#init_worker_by_php)
* [init_worker_by_php_block](#init_worker_by_php_block)
* [rewrite_by_php](#rewrite_by_php)
* [rewrite_by_php_block](#rewrite_by_php_block)
* [access_by_php](#access_by_php)
* [access_by_php_block](#access_by_php_block)
* [content_by_php](#content_by_php)
* [content_by_php_block](#content_by_php_block)
* [log_by_php](#log_by_php)
* [log_by_php_block](#log_by_php_block)
* [header_filter_by_php](#header_filter_by_php)
* [header_filter_by_php_block](#header_filter_by_php_block)
* [body_filter_by_php](#body_filter_by_php)
* [body_filter_by_php_block](#body_filter_by_php_block)
* [php_keepalive](#php_keepalive)
* [php_set](#php_set)
* [php_socket_keepalive](#php_socket_keepalive)
* [php_socket_buffer_size](#php_socket_buffer_size)

php_ini_path
------------
**syntax:** `php_ini_path`_``_

**context:** `http`

**phase:** `loading-config`

This directive allows loading the official php configuration file php.ini, which will be used by subsequent PHP code.

init_worker_by_php
------------------
**syntax:** `init_worker_by_php`_``_

**context:** `http`

**phase:** `starting-worker`

init_worker_by_php_block
------------------------
**syntax:** `init_worker_by_php_block`_`{php script code}`_

**context:** `http`

**phase:** `starting-worker`

rewrite_by_php
--------------
**syntax:** `rewrite_by_php`_``_

**context:** `http, server, location, location if`

**phase:** `rewrite`

In the rewrite phase of nginx, you can execute inline php code.

rewrite_by_php_block
--------------------
**syntax:** `rewrite_by_php_block`_`{php script code}`_

**context:** `location, location if`

**phase:** `rewrite`

In the rewrite phase of nginx, you can execute inline php code.

access_by_php
-------------
**syntax:** `access_by_php`_``_

**context:** `http, server, location, location if`

**phase:** `access`

In the access phase of nginx, you can execute inline php code.

access_by_php_block
-------------------
**syntax:** `access_by_php_block`_`{php script code}`_

**context:** `location, location if`

**phase:** `access`

In the access phase of nginx, you can execute inline php code.

content_by_php
--------------
**syntax:** `content_by_php`_``_

**context:** `http, server, location, location if`

**phase:** `content`

In the content phase of nginx, you can execute inline php code.

content_by_php_block
--------------------
**syntax:** `content_by_php_block`_`{php script code}`_

**context:** `location, location if`

**phase:** `content`

In the content phase of nginx, you can execute inline php code.

log_by_php
----------
**syntax:** `log_by_php`_``_

**context:** `http, server, location, location if`

**phase:** `log`

log_by_php_block
----------------
**syntax:** `log_by_php_block`_`{php script code}`_

**context:** `location, location if`

**phase:** `log`

header_filter_by_php
--------------------
**syntax:** `header_filter_by_php`_``_

**context:** `http, server, location, location if`

**phase:** `output-header-filter`

header_filter_by_php_block
--------------------------
**syntax:** `header_filter_by_php_block`_`{php script code}`_

**context:** `location, location if`

**phase:** `output-header-filter`

body_filter_by_php
------------------
**syntax:** `body_filter_by_php`_``_

**context:** `http, server, location, location if`

**phase:** `output-body-filter`

body_filter_by_php_block
------------------------
**syntax:** `body_filter_by_php_block`_`{php script code}`_

**context:** `location, location if`

**phase:** `output-body-filter`

php_keepalive
-------------
**syntax:** `php_keepalive`_``_

**default:** `0`

**context:** `http, server`

In php, set upstream connection pool size.

php_set
-------
**syntax:** `php_set`_`$variable`_ _``_

**context:** `http, server, location, location if`

**phase:** `loading-config`

Installs a php handler for the specified variable.

php_socket_keepalive
--------------------
**syntax:** `php_socket_keepalive`_``_

**default:** `0`

**context:** `http, server`

php_socket_buffer_size
----------------------
**syntax:** `php_socket_buffer_size`_``_

**default:** `4k`

**context:** `http, server, location, location if`

Nginx API for php
-----------------
* [ngx_exit](#ngx_exit)
* [ngx_query_args](#ngx_query_args)
* [ngx_post_args](#ngx_post_args)
* [ngx_log_error](#ngx_log_error)
* [ngx_request_method](#ngx_request_method)
* [ngx_request_document_root](#ngx_request_document_root)
* [ngx_request_document_uri](#ngx_request_document_uri)
* [ngx_request_script_name](#ngx_request_script_name)
* [ngx_request_script_filename](#ngx_request_script_filename)
* [ngx_request_query_string](#ngx_request_query_string)
* [ngx_request_uri](#ngx_request_uri)
* [ngx_request_server_protocol](#ngx_request_server_protocol)
* [ngx_request_remote_addr](#ngx_request_remote_addr)
* [ngx_request_server_addr](#ngx_request_server_addr)
* [ngx_request_remote_port](#ngx_request_remote_port)
* [ngx_request_server_port](#ngx_request_server_port)
* [ngx_request_server_name](#ngx_request_server_name)
* [ngx_request_headers](#ngx_request_headers)
* [ngx_var_get](#ngx_var_get)
* [ngx_var_set](#ngx_var_set)
* [ngx_header_set](#ngx_header_set)
* [ngx_header_get](#ngx_header_get)
* [ngx_header_get_all](#ngx_header_get_all)
* [ngx_redirect](#ngx_redirect)
* [ngx_cookie_get_all](#ngx_cookie_get_all)
* [ngx_cookie_get](#ngx_cookie_get)
* [ngx_cookie_set](#ngx_cookie_set)

ngx_exit
--------
**syntax:** `ngx_exit(int $status) : void`

**parameters:**
- `status: int`