Skip to content

update README #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 16, 2018
Merged

update README #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 19 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# ngx-rust
# Rust for NGINX

Module development kit for Nginx using Rust. This crates does 2 things:
Rust bindings and wrappers for NGINX. Can be used for building dynamic modules and hacking NGINX using rust.

(1) Generates C bindings for using Nginx inside Rust module.
(2) Provide limited high level wrapper for Nginx C interface.
## Production Status

This version is proof of concept. It has enough binding for building modules for [nginmesh](https://github.com/nginxinc/nginmesh).

You still need to write C stub code to build the complete module. Please wait for next version which will remove this restriction.

## Getting Started

Expand All @@ -21,8 +23,20 @@ Next, add this to your crate:
extern crate ngx_rust;
```

## Building module Example

Please see [istio mixer module](https://github.com/nginxinc/ngx-istio-mixer) for full example.
Currently, it requires much machinery to build the module.

## Roadmap

Please see [roadmap](https://github.com/nginxinc/ngx-rust/wiki) for future plans.



## Limitation

Currently only Darwin (Mac OSX) and Linux platform are supported
Only supports these platforms:
- Darwin (Mac OSX)
- Linux platform