NJS Learning Materials

List some learning materials to help you step into the world of njs. Thanks to these open source authors and engineer of Nginx/F5, inc.

Docs / Repo

• nginx.org/en/docs/njs/ An official nginx docs for njs.
• github.com/nginx/njs An official read-only mirror of http://hg.nginx.org/njs/ which is updated hourly.

Example

• xeioex/njs-examples Maintained by nginx,inc engineer @Dmitry Volyntsev, contains examples from official documentation. Project started at 24 Sep 2018.
• zongzw-nginx/nginx-njs-usecases Maintained by F5,inc engineer @zongzw, use docker and docker-compose to demonstrate some usage scenarios of njs.Project started at Mar 9, 2020.
• nginxinc/nginx-s3-gateway Maintained by nginx,inc engineer @Elijah Zupancic, illustrates setting up a S3 Gateway using njs and creating njs unit tests.

Project

• Nginx RSA Encryption by @soulteary
• Nginx DNS by @TuxInvader
• Nginx DDNS by @soulteary
• LDAP Auth by @floffel
• S3 Proxy by @Vasiliy Soshnikov
• JWT by @lombax85
• Mod Security by @ihironao
• OAuth/OIDC Proxy by @kaz
• NJS TypeScript Definition by @Patrick Nelson
• MQTT Client Auth by @Chris Sandberg
• Nginx/NJS Binares by @Jakub Jirutka
• Docker v2 Registry by @Skitsanos
• Babel Preset by @Jakub Jirutka
• OpenResty with NJS by @Skitsanos
• UML Diagram Renderer
  • Docker Nomnoml is a simple but elegant self-hosted UML Generator & UML Sharing solution. This Project use NJS to provide server-side generation function.
  • NJS compatible: 0.5.0+
• JSONRPC gateway by @sah4ez

Docker Image

• nginxinc/docker-nginx An official nginx docker images, contains njs executable files.
  • Registry: https://hub.docker.com/_/nginx
• soulteary/docker-njs Maintained by soulteary, minimal image containing only njs executable files for development and debugging.
  • Registry: https://hub.docker.com/r/soulteary/docker-njs
  • HowTo: https://soulteary.com/2021/01/10/let-us-start-with-the-mirroring-of-the-nginx-njs-tool-package.html

Alternative

Independent project maintained by nginx fans.

• Maintained by @Peter Leonov at 4 Dec 2008, full port of ngx_http_perl_module: peter-leonov/ngx_http_js_module
• Maintained by @webcpp at Apr 6, 2017, use various languages to extend nginx as an application server: webcpp/hi-nginx