Skip to content

Commit

Permalink
Add documentation for server_name
Browse files Browse the repository at this point in the history
  • Loading branch information
digitalresistor committed Nov 27, 2020
1 parent 2f2972e commit 88b0073
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/arguments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,23 @@ listen

.. versionadded:: 1.0

server_name
This is the value that will be placed in the WSGI environment as
``SERVER_NAME``, the only time that this value is used in the WSGI
environment for a request is if the client sent a HTTP/1.0 request without
a ``Host`` header set, and no other proxy headers.

The default is value is ``waitress.invalid``, if your WSGI application is
creating URL's that include this as the hostname and you are using a
reverse proxy setup, you may want to validate that your reverse proxy is
sending the appropriate headers.

In most situations you will not need to set this value.

Default: ``waitress.invalid``

.. versionadded:: 2.0

ipv4
Enable or disable IPv4 (boolean)

Expand Down

0 comments on commit 88b0073

Please sign in to comment.