转自:
https://github.com/nginx/unit/pull/18/
感谢:
https://www.v2ex.com/t/389528
NGINX Unit
NGINX Unit 是一个动态的网络应用服务器,它的设计初衷就是可运行多种编程语言的。通过API可以轻巧,多面化的动态配置Unit。当工程师或操作者有需要时,可以轻松重构服务器已适配特殊的应用参数。
NGINX Unit 现在是beta版本。你现在虽然可以使用它,但建议仅用于测试环境,不建议用于生产环境。
本项目的源代码及分发均使用Apache 2.0 license。
核心功能
- 使用RESTful JSON API可完整的动态重配置服务器。
- 可同时运行多语言及多版本的应用。
- 动态语言的进程管理功能。 (敬请期待)
- TLS 支持 (敬请期待)
- TCP, HTTP, HTTPS, HTTP/2 路由和代理 (敬请期待)
Supported Application Languages
- Python
- PHP
- Go
- JavaScript/Node.js (敬请期待)
- Java (敬请期待)
- Ruby (敬请期待)
安装
系统需求
NGINX Unit 已被测试通过在以下系统上运行:
- Linux 2.6 或更高
- FreeBSD 9 或更高
- MacOS X
- Solaris 11
系统架构:
- i386
- amd64
- powerpc
- arm
NGINX Unit 支持不同的编程语言,你可以选择下面列出的版本:
- Python 2.6, 2.7, 3
- PHP 5, 7
- Go 1.6 or later
你可以在一个系统上运行不同版本的相同编程语言。
安装包
你可以在CentOS 7.0 和 Ubuntu 16.04 LTS。上直接安装 NGINX Next
CentOS 安装
在 /etc/yum.repos.d/unit.repo 目录下建立文件,并包含以下内容:
1
2
3
4
5[unit]
name=unit repo
baseurl=http://nginx.org/packages/mainline/centos/7/$basearch/
gpgcheck=0
enabled=1安装Nginx Unit:
1
# yum install unit
Ubuntu 安装
下载key key 用于签名NGINX, Inc. 的源和包。
添加秘钥到
apt
程序里。程序将会认证NGINX源的签名,这样将会消除警告。1
# sudo apt-key add nginx_signing.key
将下面两行写入文件尾部。
/etc/apt/sources.list:
1 | deb http://nginx.org/packages/mainline/ubuntu/ xenial nginx |
安装NGINX Unit:
1
2# apt-get update
# apt-get install unit
源代码
本章将会完整的解释如何通过源代码安装NIGIX Unit。
获得源代码
你可以通过三种方法获得NGINX Unit的源代码: 从 NGINX, Inc.
的Mercurial源,Github,或从tarball获得源代码。
无论从那种方式获得源代码,你均可以在 unit 子目录中,找到我们的源代码。
Mercurial源
如果你没有安装Mercurial软件。你需要先下载并安装它。
示例:在 Ubuntu 系统下,运行下面的命令:1
# apt-get install mercurial
下载NIGIX Unit的源代码:
1
# hg clone http://hg.nginx.org/unit
GitHub 源
如果你没有Git,请先移步Github帮助你安装Git
GitHub 帮助文档。下载NGINX Unit源:
1
# git clone https://github.com/nginx/unit
Tarball
NGINX Unit源代码请在以下链接获得
http://unit.nginx.org/download/
安装依赖软件
在配置和安装 NGINX Unit 之前,你必须现安装依赖文件和必要的工具。以及你希望运行的编程语言。如 Go,PHP,和 Python。
Ubuntu 依赖安装
安装 build tools。
1
# apt-get install build-essential
如果想支持Go语言应用,请安装
golang
包。1
# apt-get install golang
如果想支持PHP语言应用,请安装
php-dev
和libphp-embed
包。1
2# apt-get install php-dev
# apt-get install libphp-embed如果想支持Python语言应用,请安装
python-dev
包。1
# apt-get install python-dev
CentOS 依赖
安装 build tools。
1
# yum install gcc make
如果想支持Go语言应用,请安装
golang
包。1
# yum install golang
如果想支持PHP语言应用,请安装
php-devel
和libphp-embedded
包。1
# yum install php-devel php-embedded
如果想支持Python语言应用,请安装
python-devel
包。1
# yum install python-devel
配置源代码
使用NGINX Unit,你可以同时运行不同版本的编程语言。(Go,PHP,或者Python)。你需要配置一个separate(分区)。
NGINX Unit有不同的模块。下面的命令会给不同的模块创建分区。 Makefile
配置Go语言环境
NGINX Unit 会提供Go的依赖包,供你方便配置NGINX Unit内的Go使用环境。
使用下面的设置
GOPATH
的环境变量。1
# export GOPATH=/home/user/go_apps
运行以下命令:
1
2
3
4
5# ./configure go
configuring Go package
checking for Go ... found
+ go version go1.6.2 linux/amd64
+ Go package path: "/home/user/go_apps"
建立Go应用
定义Go的源文件,以适应NGINX Unit。
a. 在
import
区域,在尾行添加"unit"
。1
2
3
4
5import {
"fmt"
"net/http"
"unit"
}b. 在
main()
功能中, 注释http.ListenandServe
功能并添加unit.ListenAndServe
功能。1
2
3
4func main() {
http.HandleFunc("/", handler)
//http.ListenAndServe(":8080", nil)
unit.ListenAndServe(":8080", nil)建立 GO应用。
1
# go build
如果你直接运行Go应用,Go将会自动使用http.ListenandServe。如果使用NGINX Unit,启动Go程序,将会自动执行unit.ListenandServe。程序将会与Unit的路由进行交互。
配置PHP模块
配置PHP模块。( php.unit.so) 运行下面的命令进行自动配置PHP:
1 | # ./configure php |
如需要配置不同版本的PHP,请使用下面的命令:
1 | # ./configure php --module=<prefix> --config=<script-name> --lib-path=<pathname> |
当
--module
设置文件名的前缀。Unit被设置为特定的版本。( <prefix>.unit.so)。--config
钦定的文件名, php-config 特定版本的PHP。--lib-path
PHP的路径。
实例:下面这个命令将会生成一个模块 php70.unit.so 已适配PHP7.0
PHP 7.0:
1 | # ./configure php --module=php70 \ |
配置Python模块
配置特定的Python模块,已适配NGINX Unit。 (叫 python.unit.so) 。
在操作系统的根目录可以找到configure,使用下面的命令。
1 | # ./configure python |
如果需要配置其他的Python版本,请使用下面的命令。
1 | # ./configure python --module=<prefix> --config=<script-name> |
当
--module
会生成一个模块,设置文件名的前缀。Unit被设置为特定的版本, (就这么简单,将会生成一个
<prefix>.unit.so).--config
钦定的文件名 python-config 将会生成特定版本的模块。
示例:下面的命令将会生成一个名为 py33.unit.so 已适配
Python 3.3:
1 | # ./configure php --module=py33 \ |
完成编译
当完成NGINX Unit的PHP, Python模块编译后, 运行下面的命令:
1 | # make all |
编译适用于Go语言的NGINX Unit:
确认
GOPATH
环境变量已被正确设置。1
2
3# go env GOPATH
# export GOPATH=<path>完成编译:
1
# make go-install
从源代码安装
如果需要安装完整的全面模块和Go包,运行下面的命令:
1 | # make install |
配置
默认情况下,Control Socket内包含的的API来控制NGINX Unit
unit.control.sock.
应用
每个单独的应用,你都可以在NGINX Unit的配置文件中,使用JSON语法来定义一个applications
。使用JSON语法来定义里面的内容,如使用的编程语言,需要的工作数,文件的本地路径,以及其他参数。
这个示例配置了一个PHP网站,名为 blogs 而这个网站的本地路径为。 /www/blogs/scripts。默认页面为 index.php。
1 | { |
监听器
当应用被通过HTTP访问时,你必须定义至少一个监听器 listeners
。监听器是一个IP地址和一个被定义的端口,当用户访问时,Unit的监听器会返回正确结果。IP地址可以是一个完整的IP地址(示例,127.0.0.1:8300
)或(示例,*:8300
).
在这个示例中,端口 8300 的请求全部会被发送至 blogs
这个应用:
1
2
3
4
5
6
7
8
{
"listeners": {
"*:8300": {
"application": "blogs"
}
},
...
}
完整的JSON语法细节,请点击下面的链接。
JSON 详细的监听器配置和应用配置.
最小化配置
配置中至少需要包含一个监听器和一个应用配置:
1 | { |
创建配置文件
你可以创建一个配置文件,并且发送一个 PUT
请求。为了减少发生错误的可能,当使用 curl
命令式,请包含 -d
选项。
示例:创建一个完整的配置文件
通过下面的命令,可以创建一个初始的配置文件
start.json :
1 | # curl -X PUT -d @/path/to/start.json \ |
示例:新建一个应用对象
通过 wiki.json 我们可以创建一个 wiki 应用。
1 | # curl -X PUT -d @/path/to/wiki.json \ |
wiki.json 里包含了:
1 | { |
显示配置的对象
要显示配置的对象,它被附加在curl
的URL内。
示例:显示完整的配置文件
如果你想显示完整的配置文件,你可以通过下面的指令来查看:
1 | # curl --unix-socket ./control.unit.sock http://localhost/ |
示例:显示一个对象
显示 wiki 这个应用的配置,只需:
1 | # curl --unix-socket ./control.unit.sock http://localhost/applications/wiki |
修改配置的对象:
要更改配置的对象,使用 curl
命令和-d
选项来实现特定的对象的JSON数据,然后发送一个PUT
请求。
示例:修改监听端口指向的应用
在端口 :8400上修改 application
应用指向 *wiki-dev**:
1 | # curl -X PUT -d '"wiki-dev"' --unix-socket ./control.unit.sock \ |
示例:修改应用的本地路径
修改root
对象的 blogs 应用的本地路径至
/www/blogs-dev/scripts:
1 | # curl -X PUT -d '"/www/blogs-dev/scripts"' \ |
删除对象
要删除配置的对象,你可以通过 curl
发送一个DELETE
请求到对象目录。
示例:删除监听器
删除对 *:8400 端口的监听:
1 | # curl -X DELETE --unix-socket ./control.unit.sock \ |
监听器和应用对象
监听器
对象 | 描述 |
---|---|
<IP地址>:<端口> |
IP地址和端口需在不同的Unit监听器上均需要配置应用的名字 ,IP地址可以是完整的 (127.0.0.1:8300 ) 或者(*:8300 ). |
application |
应用名。 |
示例:
1 | "*:8300": { |
Go语言应用
对象 | 描述 |
---|---|
type |
应用的编程语言 (go )。 |
workers |
应用的工作数量。 |
executable |
完整的本地路径。 |
user (optional) |
运行进程的用户,如未定义,则默认(nobody)。 |
group (optional) |
用户所在的用户组 。如未定义,则默认。 |
示例:
1 | "go_chat_app": { |
PHP语言应用
对象 | 描述 |
---|---|
type |
应用的编程语言 (php ). |
workers |
应用的工作数量。 |
root |
文件的本地路径。 |
index |
默认的index文件路径。 |
script (optional) |
访问Unit内任意的URL均会运行,填写路径将不要填写物理路径,请填写虚拟路径。 |
user (optional) |
运行进程的用户,如未定义,则默认(nobody)。 |
group (optional) |
用户所在的用户组 。如未定义,则默认。 |
示例:
1 | "blogs": { |
Python语言应用
Object | Description |
---|---|
type |
应用的编程语言 (python )。 |
workers |
应用的工作数量。 |
path |
wsgi.py 的路径。 |
module |
必填。目前只支持 wsgi 。 |
user (optional) |
运行进程的用户,如未定义,则默认(nobody)。 |
group (optional) |
用户所在的用户组 。如未定义,则默认。 |
示例:
1 | "shopping_cart": { |
完整示例:
1 | { |
NGINX一起使用
和NGINX一起使用
配置NGINX来进行静态文件的处理和接受代理的请求。
NGINX服务器将直接处理静态文件的访问请求,动态文件的处理将会直接转发到NGINX Unit。
新建一个上传模块,在NGINX的配置中,将http的请求转发给Unit,示例:
1 | upstream unit_backend { |
新建或修改NGINX的配置文件 server
块和 location
块 。指定的静态文件的路径和上传模块。
示例 1
这个例子适用于基于PHP编程语言开发的程序。,全部的URL请求,如已.php结尾,均会被转发至Unit服务器,其他的全部文件将会直接被服务器返回文件:
1 | server { |
示例 2
All other requests will be proxied to Unit:
下面的应用,全部都静态文件需要被放置在/var/www/files
目录下,在前端调用时,请直接使用/static
。
1 | server { |
相关的NGINX 文档将会在http://nginx.org提供。
相关的支持和更多的功能将在https://www.nginx.com上提供。
安全和代理Unit API
默认情况下,Unit的API将会在Unix domain socket下。如果你希望API可以被远程访问,你需要使用NGINX配置代理。
NGINX 可以提供安全的、可信的和可控制的API
使用下面的示例配置来配置NGINX:
1 | server { |
贡献
NGINX Unit的发布和分发均使用Apache 2.0 license。
如果想贡献自己的力量,你可以选择通过邮件[email protected]
或者在Github上提交PRhttps://github.com/nginx/unit。
如果在中文翻译方面需要改近请联系@tuzimoe。
疑难解答
Unit 日志一般在默认的位置,可以在/var/log/unit.log
中找到。
Log 文件的位置也可以通过运行 unitd --help
来快速定位。
详细的Debug日志可以通过输入命令来获得:
1 | ./configure --debug |
输入完命令后,请务必重新编译和重装NGINX Unit。
请注意,debug日志的内容将会以快速的增长。
社区邮箱的列表将会在unit@nginx.org上找到。
订阅邮箱列表,可以通过发送任何内容至订阅
[email protected]
或直接点击此处订阅
没错就是我。