Home

Awesome

nginx-rs

crates.io MIT License

Note [Nov 2023] Nginx now provides official Rust support with the ngx crate.

See Nginx's blog post Extending NGINX with Rust (an Alternative to C).

[Feb 2023] I haven't had a chance to work on this recently, but you might be interested in Cloudflare's blog post ROFL with a LOL: rewriting an NGINX module in Rust, which takes some inspiration from this module.

A framework for writing Nginx modules in pure Rust.

This module is in early stages. It lacks documentation and the API is still quite unstable. But it can be used to write simple request handlers for content or access control.

Building Modules

Building modules requires a checkout of the Nginx sources configured for building dynamic modules:

export NGINX_DIR=/path/to/nginx
cd "${NGINX_DIR}"
auto/configure --with-compat

Once Nginx is configured, you can then build your module:

cd /path/to/module
cargo build --release

The resulting .so in target/release can then be loaded using the load_module directive.

Examples

Licence

This project is licensed under the terms of the MIT license.