GitHub - nginxinc/nginx-wiki: ARCHIVED -- Source for the now archived NGINX Wiki section of https://www.nginx.com · GitHub
Skip to content
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
This repository was archived by the owner on Jul 6, 2023. It is now read-only.
nginxinc
nginx-wiki
Public archive
Notifications
You must be signed in to change notification settings
Fork
305
Star
307
Branches
Tags
Open more actions menu
Folders and files
Name
Name
Last commit message
Last commit date
Latest commit
History
969 Commits
969 Commits
.ci
.ci
.github/
workflows
.github/
workflows
source
source
.gitignore
.gitignore
Dockerfile
Dockerfile
LICENSE
LICENSE
Makefile
Makefile
README.rst
README.rst
docker-compose.yml
docker-compose.yml
linkfix.py
linkfix.py
make.bat
make.bat
requirements.txt
requirements.txt
serve.sh
serve.sh
Repository files navigation
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
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:
$ sudo pip install -r requirements.txt
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
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
About
ARCHIVED -- Source for the now archived NGINX Wiki section of
www.nginx.com/resources/wiki/
Resources
Readme
License
View license
Code of conduct
Code of conduct
Security policy
Security policy
Uh oh!
There was an error while loading.
Please reload this page
Activity
Custom properties
Stars
307
stars
Watchers
48
watching
Forks
305
forks
Report repository
Uh oh!
There was an error while loading.
Please reload this page
Contributors
Uh oh!
There was an error while loading.
Please reload this page
Languages
HTML
37.8%
CSS
32.1%
Python
17.4%
JavaScript
7.6%
Batchfile
2.6%
XSLT
1.4%
Other
1.1%
You can’t perform that action at this time.