nginxinc / nginx-wiki Goto Github PK

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

Home Page: https://www.nginx.com/resources/wiki/

License: Other

Makefile 0.76% Python 17.37% HTML 37.96% Batchfile 2.57% Shell 0.22% CSS 32.05% JavaScript 7.59% XSLT 1.37% Dockerfile 0.12%

nginx-wiki's Introduction

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 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.

nginx-wiki's People

Contributors

Stargazers

Watchers

Forkers

aluttik linuxjedi ottenhoff lyhabc max2501 maurosteel danifbento javdl kyanagimoto slavapopov rkbmmmec manoharank wandenberg erikdubbelboer agentzh pmvd dedok mansil greg-1-anderson vfaris rehsack miteshshah roni5 dangreenisrael slact pastudan pnommensen pasquale12 tonyta runt18 shakespears jeitzen dinkin ryd994 vo0doo mfb oquile davidjb cloudxtreme anthonymayer osokin hvnsweeting hoangdoanh n5ke pleshakov kmjones1979 veruu visionscaper igorsysoev omosofe xgqelite sherzader blueprint-marketing duchengnan cornorr esemeniuc atul-ojha kwojtek slashrsm onetarek chris2000sp colans 8detect theofidry jakethesnake3p0 nginx-training aseques xiaokai-wang fager 4levels remingtonc gagarine cjmayo zaszab floydsm8 y82 jason790 th3mouk phpzc apidmeyh46 sto bouttier kkein lizhli fsalvato tanc mre digideskio dannote rryqszq4 jeffkaufman xandersoft lcrilly johnaxel the-noob svitlanako erankor piixiiees hfm bayfero

nginx-wiki's Issues

Add section about 2fa contributing

Contributing with 2fa enabled is a little different (SSH instead). Content need to be updated to reflect that.

Migrate JavaServers

Should probably be in quick start: http://wiki.nginx.org/JavaServers

Migrate LikeApache

Probably into quick start: http://wiki.nginx.org/LikeApache

Add Travis CI hooks

Once this tree goes public.

Should execute:

make html
make linkcheck

I've already modified the default Makefile to be stricter (warnings to errors and nitpick mode on)

Add a favicon

Migrate the SSL Offloader page

This should probably be moved to the Quick Start section: http://wiki.nginx.org/SSL-Offloader

Add authors section

There should be a page somewhere for everyone who contributes to name themselves along with any links about themselves.

Migrate Getting Started

This needs migrating, probably somewhere in the new Getting Started section: http://wiki.nginx.org/GettingStarted

Migrate Debugging

Not sure where to yet: http://wiki.nginx.org/Debugging

comments on wiki

Disqus?

Migrate FAQ page

This needs migrating and probably a heavy cleanup: http://wiki.nginx.org/Faq

Add icons for noscript

Request from Michael Lustfield. He wants the icons to load on noscript. The answers here show how to make it happen: https://stackoverflow.com/questions/23653708/fallback-from-fontawesome-if-font-download-blocked

Migrate Install page

This needs migrating, probably into the Getting Started section: http://wiki.nginx.org/Install

Need 404 page

Should be funky, sharks with fricking laser beams or something

Migrate ImapAuthenticateWithApacheAndPhpScript

Probably to quick start: http://wiki.nginx.org/ImapAuthenticateWithApachePhpScript

Migrate Fcgiwrap

Probably into quickstart: http://wiki.nginx.org/Fcgiwrap

Remove Extended Status module

It is orphaned according to one of our internal teams so we need to:

Remove from the old wiki
Remove from the new wiki
Point people in the direction of the NGINX Plus extended status module instead

Migrate FullExample2

Probably to quick start: http://wiki.nginx.org/FullExample2

Make sure title and description metatags are generated

Migrate ReverseProxyCachingExample

Probably to quick start: http://wiki.nginx.org/ReverseProxyCachingExample

Create build system around i18n

At the moment each language needs to be manually built.

We should auto build all translations so the dir structure is something like:

build/html
build/html/ru
build/html/fr

The index page or right hand column should have a language selector.

In addition "make gettext" needs to be required before committing. Not sure if this should be a git hook, built into "make html" or made a soft requirement.

And make sure the CI system uses this.