README.rst

NGINX wiki

This is the source repository for the new NGINX wiki. It is written in reStructuredText format as intended to be compiled into HTML using Sphinx Documentation Generator.

Compiling

To compile a local copy of the documentation you will need Sphinx installed. Most Linux distributions have this in their repositories and can be installed with commands such as:

$ sudo apt-get install python-sphinx

or

$ sudo yum install python-sphinx

Alternatively it can be installed with Python's pip package manager:

$ sudo pip install Sphinx

There are a couple of extra dependencies you will also need to build the Markdown parts of the documentation:

$ sudo pip install recommonmark commonmark

You can then build the docs with:

$ make dirhtml

The HTML output is stored in the build/dirhtml directory. You can view this any way you desire, a very easy way to do it is to use NGINX. The build system can execute NGINX using:

$ make serve

Or if you have NGINX in a non-standard path (for example /opt/nginx/) you can point to the path of the NGINX binary with:

$ NGINX_PATH=/opt/nginx/sbin make serve

NGINX will be started on port 8080 so you can view the wiki by browsing to http://localhost:8080/

When you are done, CTRL-C will exit NGINX.

Contributing

We welcome edits and additions to this wiki. To find out more about how to do this please see out Submitting Contributions page. If you spot any problems please file a GitHub Issue.

If you have any questions or require any help with this wiki please use the NGINX Mailing List.