summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2018-09-22 15:03:16 -0700
committerSteve Piercy <web@stevepiercy.com>2018-09-22 15:03:16 -0700
commit87f0d9134f6ef9d4456fe7d25992262392714bc6 (patch)
treeded392d71d34ae63179f071dc0c5a4288093d238 /docs
parentcf5e04e2ed2de6de9ba7b35824bc2920c753bc1b (diff)
downloadwaitress-87f0d9134f6ef9d4456fe7d25992262392714bc6.tar.gz
Use contextual versionadded directive.
Use proper casing for nginx.
Diffstat (limited to 'docs')
-rw-r--r--docs/reverse-proxy.rst6
-rw-r--r--docs/runner.rst8
2 files changed, 6 insertions, 8 deletions
diff --git a/docs/reverse-proxy.rst b/docs/reverse-proxy.rst
index b69cbae..4fff2c3 100644
--- a/docs/reverse-proxy.rst
+++ b/docs/reverse-proxy.rst
@@ -17,7 +17,7 @@ your reverse proxy to pass along the ``Host`` header sent by the client to
Waitress, in either case, as it will be used by most applications to generate
correct URLs.
-For example, when using Nginx as a reverse proxy, you might add the following
+For example, when using nginx as a reverse proxy, you might add the following
lines in a ``location`` section::
proxy_set_header Host $host;
@@ -66,7 +66,7 @@ Passing the ``X_FORWARDED_PROTO`` header to set ``wsgi.url_scheme``
If your proxy accepts both HTTP and HTTPS URLs, and you want your application
to generate the appropriate url based on the incoming scheme, also set up
your proxy to send a ``X-Forwarded-Proto`` with the original URL scheme along
-with each proxied request. For example, when using Nginx::
+with each proxied request. For example, when using nginx::
proxy_set_header X-Forwarded-Proto $scheme;
@@ -131,7 +131,7 @@ the client to your Waitress server, as well as sending along a
If your proxy accepts both HTTP and HTTPS URLs, and you want your application
to generate the appropriate url based on the incoming scheme, also set up
your proxy to send a ``X-Forwarded-Proto`` with the original URL scheme along
-with each proxied request. For example, when using Nginx::
+with each proxied request. For example, when using nginx::
proxy_set_header X-Forwarded-Proto $scheme;
diff --git a/docs/runner.rst b/docs/runner.rst
index 4e10e95..fc424ad 100644
--- a/docs/runner.rst
+++ b/docs/runner.rst
@@ -3,13 +3,11 @@
waitress-serve
--------------
-Waitress comes bundled with a thin command-line wrapper around the
-``waitress.serve`` function called ``waitress-serve``. This is useful for
-development, and in production situations where serving of static assets is
-delegated to a reverse proxy, such as Nginx or Apache.
-
.. versionadded:: 0.8.4
+ Waitress comes bundled with a thin command-line wrapper around the ``waitress.serve`` function called ``waitress-serve``.
+ This is useful for development, and in production situations where serving of static assets is delegated to a reverse proxy, such as nginx or Apache.
+
``waitress-serve`` takes the very same :ref:`arguments <arguments>` as the
``waitress.serve`` function, but where the function's arguments have
underscores, ``waitress-serve`` uses hyphens. Thus::