Skip to content
This repository was archived by the owner on Oct 8, 2025. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,24 @@ For details and available language packages, see the
### Docker

``` console
$ docker pull unit
$ docker pull unit:<TAG>
$ mkdir /tmp/unit-control # customize as needed.
$ docker run -d \
--mount type=bind,src=/tmp/unit-control,dst=/var/run \
--mount type=bind,src=.,dst=/www \
--network host \
unit
```

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

WARNING: latest image tag may not provide support for specific language modules,
*do* check the available image tags from the link above before pulling your image.

Your current working directory will now be mounted to the Unit image at `/www`.
You can reach its socket at `/tmp/unit-control/control.unit.sock` assuming no
further customizations have been made.

### Amazon Linux, Fedora, Red Hat

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

## Configuration

NGINX Unit provides a RESTful API for dynamic configuration.
See the [control API documentation](https://unit.nginx.org/controlapi/)
for more information on what endpoints are available and how to use them.


For full details of configuration management, see the
[docs](https://unit.nginx.org/configuration/#configuration-management).

## Running a Hello World App

Expand Down Expand Up @@ -161,8 +182,10 @@ Unit's output should contain both snippets, neatly organized:
}
```

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

## OpenAPI Specification

Expand Down