https://github.com/nginxinc/nginx-wiki

ARCHIVED -- Source for the now archived NGINX Wiki section of https://www.nginx.com
https://github.com/nginxinc/nginx-wiki

Last synced: 12 days ago
JSON representation

ARCHIVED -- Source for the now archived NGINX Wiki section of https://www.nginx.com

• Host: GitHub
• URL: https://github.com/nginxinc/nginx-wiki
• Owner: nginxinc
• License: other
• Archived: true
• Created: 2015-04-28T12:04:07.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-05-24T18:37:20.000Z (over 1 year ago)
• Last Synced: 2024-08-01T19:31:49.337Z (3 months ago)
• Language: HTML
• Homepage: https://www.nginx.com/resources/wiki/
• Size: 5.6 MB
• Stars: 291
• Watchers: 53
• Forks: 311
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: https://www.repostatus.org/badges/latest/abandoned.svg

   :alt: Project Status: Abandoned – Initial development has started, but there has not yet been a stable, usable release; the project has been abandoned and the author(s) do not intend on continuing development.

   :target: https://www.repostatus.org/#abandoned

**NOTE:** The NGINX Wiki is now archived, and is longer mantained nor checked for correctness. The content will remain archived here for the time being, but it will be taken down at some stage in the near future. Please refer to the `NGINX Docs `_ for the latest NGINX documentation.

There will likely be no further development on the project and security vulnerabilities may be unaddressed.

===========================================================================================================

NGINX wiki

==========

.. image:: https://github.com/nginxinc/nginx-wiki/workflows/Linting/badge.svg

    :target: https://github.com/nginxinc/nginx-wiki/actions

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. It can be installed with Python's pip package manager:

.. code-block:: bash

   $ sudo pip install -r requirements.txt

You can then build the docs with:

.. code-block:: bash

   $ 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:

.. code-block:: bash

   $ 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:

.. code-block:: bash

   $ 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 `_.