diff options
| author | Bert JW Regeer <bertjw@regeer.org> | 2020-11-26 21:59:52 -0800 |
|---|---|---|
| committer | Bert JW Regeer <bertjw@regeer.org> | 2020-11-26 22:24:06 -0800 |
| commit | 88b0073da238b250de427622624632352fb9966d (patch) | |
| tree | ce6edda0bcd9b82865329103a9fc96d67e77f277 | |
| parent | 2f2972e8349d19cc36472e54fc9969b431ef1413 (diff) | |
| download | waitress-88b0073da238b250de427622624632352fb9966d.tar.gz | |
Add documentation for server_name
| -rw-r--r-- | docs/arguments.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/arguments.rst b/docs/arguments.rst index 3822f2c..f9b9310 100644 --- a/docs/arguments.rst +++ b/docs/arguments.rst @@ -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) |