Skip to content

Commit

Permalink
[enh] adding and extending intro
Browse files Browse the repository at this point in the history
  • Loading branch information
xeioex committed Mar 29, 2021
1 parent d3c67e5 commit 07db6a2
Showing 1 changed file with 30 additions and 7 deletions.
37 changes: 30 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ NGINX JavaScript examples
Intro
=====

Note: the examples below work with njs >= `0.5.2 <http://nginx.org/en/docs/njs/changes.html#njs0.5.2>`_.
This repo contains complete examples for various use cases where `njs <http://nginx.org/en/docs/njs/>`_ is useful. The document as well as `njs documentation <http://nginx.org/en/docs/njs/>`_ expects some familiarity with and understanding of nginx. Beginners should refer to the official `admin guide <https://docs.nginx.com/nginx/admin-guide/>`_.

Running inside Docker:
Note: the examples below work with njs >= `0.5.2 <http://nginx.org/en/docs/njs/changes.html#njs0.5.2>`_. To see the current version run the following command: ``docker run -i -t nginx:latest /usr/bin/njs -V``.

Running inside Docker
---------------------

.. code-block:: shell
Expand All @@ -22,8 +25,31 @@ Running inside Docker:
# Stopping.
docker stop njs_example
Hello world [http/hello]
------------------------
Status
------
While njs is in active development it is production ready. Its reliability has been proven by extensive test coverage as well as a good track record with our customers.

nginx compatibility
-------------------
As njs is a `native nginx module <http://nginx.org/en/docs/dev/development_guide.html#Modules>`_ its compatibility with nginx is high. While it is developed as a separate project, it is routinely tested with latest nginx versions on various platforms and architectures.

Presentation at nginx.conf 2018
-------------------------------
https://youtu.be/Jc_L6UffFOs

Installation
------------
njs is available as a part of official nginx docker image as well as an officially supported `packet <http://nginx.org/en/linux_packages.html>`_ for major linux distributions.

Repository
----------
Please ask questions, report issues, and send patches via official `Github mirror <https://github.com/nginx/njs>`_.

HTTP
====

Hello world example [http/hello]
--------------------------------

nginx.conf:

Expand Down Expand Up @@ -72,9 +98,6 @@ Checking:
curl http://localhost/version
0.4.1
HTTP
====

Authorization
-------------

Expand Down

0 comments on commit 07db6a2

Please sign in to comment.