Skip to content

Commit d648334

Browse files
avahahnava-affine
authored andcommitted
* expand on docker instructions
* identify API documentation * identify WASM documentation Signed-off-by: Ava Hahn <[email protected]>
1 parent a4dbee1 commit d648334

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,22 @@ For details and available language packages, see the
4242

4343
``` console
4444
$ docker pull unit
45+
$ mkdir /tmp/unit-control # customize as needed.
46+
$ docker run -d \
47+
--mount type=bind,src=/tmp/unit-control,dst=/var/run \
48+
--mount type=bind,src=.,dst=/www \
49+
--network host \
50+
unit
4551
```
4652

4753
For a description of image tags, see the
4854
[docs](https://unit.nginx.org/installation/#docker-images).
4955

5056

57+
Your current working directory will now be mounted to the Unit image at `/www`.
58+
You can reach its socket at `/tmp/unit-control/control.unit.sock` assuming no
59+
further customizations have been made.
60+
5161
### Amazon Linux, Fedora, Red Hat
5262

5363
``` console
@@ -71,6 +81,15 @@ $ wget https://raw.githubusercontent.com/nginx/unit/master/tools/setup-unit && c
7181
For details and available language packages, see the
7282
[docs](https://unit.nginx.org/installation/#official-packages).
7383

84+
## Configuration
85+
86+
NGINX Unit provides a RESTful API for dynamic configuration.
87+
See the [control API documentation](https://unit.nginx.org/controlapi/)
88+
for more information on what endpoints are available and how to use them.
89+
90+
91+
For full details of configuration management, see the
92+
[docs](https://unit.nginx.org/configuration/#configuration-management).
7493

7594
## Running a Hello World App
7695

@@ -161,8 +180,10 @@ Unit's output should contain both snippets, neatly organized:
161180
}
162181
```
163182

164-
For full details of configuration management, see the
165-
[docs](https://unit.nginx.org/configuration/#configuration-management).
183+
## WebAssembly
184+
Unit supports running WebAssembly Components (WASI 0.2).
185+
For more information see the
186+
[Unit Configuration Docs](https://unit.nginx.org/configuration/#configuration-wasm).
166187

167188
## OpenAPI Specification
168189

0 commit comments

Comments
 (0)