File tree Expand file tree Collapse file tree 1 file changed +19
-5
lines changed Expand file tree Collapse file tree 1 file changed +19
-5
lines changed Original file line number Diff line number Diff line change 1- # ngx-rust
1+ # Rust for NGINX
22
3- Module development kit for Nginx using Rust. This crates does 2 things:
3+ Rust bindings and wrappers for NGINX. Can be used for building dynamic modules and hacking NGINX using rust.
44
5- (1) Generates C bindings for using Nginx inside Rust module.
6- (2) Provide limited high level wrapper for Nginx C interface.
5+ ## Production Status
76
7+ This version is proof of concept. It has enough binding for building modules for [ nginmesh] ( https://github.com/nginxinc/nginmesh ) .
8+
9+ You still need to write C stub code to build the complete module. Please wait for next version which will remove this restriction.
810
911## Getting Started
1012
@@ -21,8 +23,20 @@ Next, add this to your crate:
2123extern crate ngx_rust;
2224```
2325
26+ ## Building module Example
27+
28+ Please see [ istio mixer module] ( https://github.com/nginxinc/ngx-istio-mixer ) for full example.
29+ Currently, it requires much machinery to build the module.
30+
31+ ## Roadmap
32+
33+ Please see [ roadmap] ( https://github.com/nginxinc/ngx-rust/wiki ) for future plans.
34+
35+
2436
2537## Limitation
2638
27- Currently only Darwin (Mac OSX) and Linux platform are supported
39+ Only supports these platforms:
40+ - Darwin (Mac OSX)
41+ - Linux platform
2842
You can’t perform that action at this time.
0 commit comments