1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
# NGINX Unit
## Universal Web App Server
NGINX Unit is a lightweight and versatile open-source server that has
two primary capabilities:
- serves static media assets,
- runs application code in seven languages.
Unit compresses several layers of the modern application stack into a potent,
coherent solution with a focus on performance, low latency, and scalability. It
is intended as a universal building block for any web architecture regardless
of its complexity, from enterprise-scale deployments to your pet's homepage.
Its native [RESTful JSON API](#openapi-specification) enables dynamic
updates with zero interruptions and flexible configuration, while its
out-of-the-box productivity reliably scales to production-grade workloads. We
achieve that with a complex, asynchronous, multithreading architecture
comprising multiple processes to ensure security and robustness while getting
the most out of today's computing platforms.
## Quick Installation
### macOS
``` console
$ brew install nginx/unit/unit
```
For details and available language packages, see the
[docs](https://unit.nginx.org/installation/#homebrew).
### Docker
``` console
$ docker pull docker.io/nginx/unit
```
For a description of image tags, see the
[docs](https://unit.nginx.org/installation/#docker-images).
### Amazon Linux, Fedora, RedHat
``` console
$ wget https://raw.githubusercontent.com/nginx/unit/master/tools/setup-unit && chmod +x setup-unit
# ./setup-unit repo-config && yum install unit
# ./setup-unit welcome
```
For details and available language packages, see the
[docs](https://unit.nginx.org/installation/#official-packages).
### Debian, Ubuntu
``` console
$ wget https://raw.githubusercontent.com/nginx/unit/master/tools/setup-unit && chmod +x setup-unit
# ./setup-unit repo-config && apt install unit
# ./setup-unit welcome
```
For details and available language packages, see the
[docs](https://unit.nginx.org/installation/#official-packages).
## Running a Hello World App
Suppose you saved a PHP script as `/www/helloworld/index.php`:
``` php
<?php echo "Hello, PHP on Unit!"; ?>
```
To run it on Unit with the `unit-php` module installed, first set up an
application object. Let's store our first config snippet in a file called
`config.json`:
``` json
{
"helloworld": {
"type": "php",
"root": "/www/helloworld/"
}
}
```
Saving it as a file isn't necessary, but can come in handy with larger objects.
Now, `PUT` it into the `/config/applications` section of Unit's control API,
usually available by default via a Unix domain socket:
``` console
# curl -X PUT --data-binary @config.json --unix-socket \
/path/to/control.unit.sock http://localhost/config/applications
```
``` json
{
"success": "Reconfiguration done."
}
```
Next, reference the app from a listener object in the `/config/listeners`
section of the API. This time, we pass the config snippet straight from the
command line:
``` console
# curl -X PUT -d '{"127.0.0.1:8000": {"pass": "applications/helloworld"}}' \
--unix-socket /path/to/control.unit.sock http://localhost/config/listeners
```
``` json
{
"success": "Reconfiguration done."
}
```
Now Unit accepts requests at the specified IP and port, passing them to the
application process. Your app works!
``` console
$ curl 127.0.0.1:8080
Hello, PHP on Unit!
```
Finally, query the entire `/config` section of the control API:
``` console
# curl --unix-socket /path/to/control.unit.sock http://localhost/config/
```
Unit's output should contain both snippets, neatly organized:
``` json
{
"listeners": {
"127.0.0.1:8080": {
"pass": "applications/helloworld"
}
},
"applications": {
"helloworld": {
"type": "php",
"root": "/www/helloworld/"
}
}
}
```
For full details of configuration management, see the
[docs](https://unit.nginx.org/configuration/#configuration-management).
## OpenAPI Specification
Our [OpenAPI specification](docs/unit-openapi.yaml) aims to simplify
configuring and integrating NGINX Unit deployments and provide an authoritative
source of knowledge about the control API.
Although the specification is still in the early beta stage, it is a promising
step forward for the NGINX Unit community. While working on it, we kindly ask
you to experiment and provide feedback to help improve its functionality and
usability.
## Community
- The go-to place to start asking questions and share your thoughts is
our [Slack channel](https://community.nginx.org/joinslack).
- Our [GitHub issues page](https://github.com/nginx/unit/issues) offers
space for a more technical discussion at your own pace.
- The [project map](https://github.com/orgs/nginx/projects/1) on
GitHub sheds some light on our current work and plans for the future.
- Our [official website](https://unit.nginx.org/) may provide answers
not easily found otherwise.
- Get involved with the project by contributing! See the
[contributing guide](CONTRIBUTING.md) for details.
- To reach the team directly, subscribe to the
[mailing list](https://mailman.nginx.org/mailman/listinfo/unit).
- For security issues, [email us](security-alert@nginx.org), mentioning
NGINX Unit in the subject and following the [CVSS
v3.1](https://www.first.org/cvss/v3.1/specification-document) spec.
|
