https://github.com/kogosoftwarellc/nginx-dev-tools
A collection of tools to aid in nginx module development.
https://github.com/kogosoftwarellc/nginx-dev-tools
Last synced: 11 months ago
JSON representation
A collection of tools to aid in nginx module development.
- Host: GitHub
- URL: https://github.com/kogosoftwarellc/nginx-dev-tools
- Owner: kogosoftwarellc
- Created: 2017-08-23T23:48:07.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-29T20:31:48.000Z (over 8 years ago)
- Last Synced: 2025-01-07T05:48:47.619Z (about 1 year ago)
- Language: Shell
- Size: 6.84 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nginx-dev-tools
> A collection of tools to aid in nginx module development.
## Installation
```
git clone git@github.com:kogosoftwarellc/nginx-dev-tools
export PATH="$PWD/nginx-dev-tools:$PATH"
```
## Sample usage
```
ngx-add-source-to-project
ngx-configure
ngx-make-module
ngx-run-module
```
## Configuration
Configuration is stored in your project as a `.ngxrc` shell file. The following
variables are supported:
* `NGX_VERSION` e.g. `1.11.5`
* `NGX_TEST_SRCS` e.g. `test/fixtures/nginx.conf dist/module.so`
## Scripts
* `ngx-configure` - Configures nginx source to compile the module.
* `ngx-make-module` - Runs `make modules` in the nginx source with the module.
* `ngx-run-module` - Copies files needed to run the module to /tmp and uses docker
to run nginx inside a container with the provided files.
* `ngx-add-source-to-project` - Assumes you have the following directories in your
project: `libs/`, `include/`. Downloads nginx source code (specified by the
`--nginx-version` option). Source is placed under `libs/` and
header files are symlinked to `include/`.