diff options
| author | Bert JW Regeer <bertjw@regeer.org> | 2016-06-11 20:33:47 -0600 |
|---|---|---|
| committer | Bert JW Regeer <bertjw@regeer.org> | 2016-06-11 20:33:47 -0600 |
| commit | d66a9aa1dbcca0747bda4a9f7a5dac26895e0a8d (patch) | |
| tree | 14b30e1e9f19970a4b842a3d1cb73cc6b8f62642 /docs/arguments.rst | |
| parent | 661a6c5641980b3795bfd2299fee4415549b27f7 (diff) | |
| download | waitress-d66a9aa1dbcca0747bda4a9f7a5dac26895e0a8d.tar.gz | |
Update docs about multi socket support
Diffstat (limited to 'docs/arguments.rst')
| -rw-r--r-- | docs/arguments.rst | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/arguments.rst b/docs/arguments.rst index cc74c0c..bc67da4 100644 --- a/docs/arguments.rst +++ b/docs/arguments.rst @@ -10,9 +10,49 @@ host hostname or IP address (string) on which to listen, default ``0.0.0.0``, which means "all IP addresses on this host". + .. warning:: + May not be used with ``listen`` + + .. deprecated:: 1.0 + port TCP port (integer) on which to listen, default ``8080`` + .. warning:: + May not be used with ``listen`` + + .. deprecated:: 1.0 + +listen + Tell waitress to listen on an host/port combination. When provided on the + command line, one can pass the argument multiple times: + + Example: + + - ``--listen=127.0.0.1:8080`` + - ``--listen=[::1]:8080`` + - ``--listen=*:8080`` + + When used from an application, it has to be provided as a space delineated list of host/port: + + Example: + + - ``listen="127.0.0.1:8080 [::1]:8080"`` + - ``listen="*:8080 *:6543"`` + + A wildcard for the hostname is also supported and will bind to both + IPv4/IPv6 depending on whether they are enabled or disabled. + + IPv6 IP addresses are supported by surrounding the IP address with brackets. + + .. versionadded:: 1.0 + +ipv4 + Enable or disable IPv4 (boolean) + +ipv6 + Enable or disable IPv6 (boolean) + unix_socket Path of Unix socket (string), default is ``None``. If a socket path is specified, a Unix domain socket is made instead of the usual inet domain |