waitress-serve

waitress-serve

TLDR

Run a Python web app

$ waitress-serve [import.path:wsgi_func]
copy


Listen on port 8080 on localhost
$ waitress-serve --listen=[localhost]:[8080] [import.path:wsgi_func]
copy


Start waitress on a Unix socket
$ waitress-serve --unix-socket=[path/to/socket] [import.path:wsgi_func]
copy


Use 4 threads to process requests
$ waitress-serve --threads=[4] [import.path:wsgifunc]
copy


Call a factory method that returns a WSGI object
$ waitress-serve --call [import.path.wsgi_factory]
copy


Set the URL scheme to HTTPS
$ waitress-serve --url-scheme=[https] [import.path:wsgi_func]
copy

Help

Usage:

    waitress-serve [OPTS] MODULE:OBJECT 

Standard options:

    --help 
        Show this information. 

    --call 
        Call the given object to get the WSGI application. 

    --host=ADDR 
        Hostname or IP address on which to listen, default is '0.0.0.0', 
        which means "all IP addresses on this host". 

        Note: May not be used together with --listen 

    --port=PORT 
        TCP port on which to listen, default is '8080' 

        Note: May not be used together with --listen 

    --listen=ip:port 
        Tell waitress to listen on an ip port combination. 

        Example: 

            --listen=127.0.0.1:8080 
            --listen=[::1]:8080 
            --listen=*:8080 

        This option may be used multiple times to listen on multiple sockets. 
        A wildcard for the hostname is also supported and will bind to both 
        IPv4/IPv6 depending on whether they are enabled or disabled. 

    --[no-]ipv4 
        Toggle on/off IPv4 support. 

        Example: 

            --no-ipv4 

        This will disable IPv4 socket support. This affects wildcard matching 
        when generating the list of sockets. 

    --[no-]ipv6 
        Toggle on/off IPv6 support. 

        Example: 

            --no-ipv6 

        This will turn on IPv6 socket support. This affects wildcard matching 
        when generating a list of sockets. 

    --unix-socket=PATH 
        Path of Unix socket. If a socket path is specified, a Unix domain 
        socket is made instead of the usual inet domain socket. 

        Not available on Windows. 

    --unix-socket-perms=PERMS 
        Octal permissions to use for the Unix domain socket, default is 
        '600'. 

    --url-scheme=STR 
        Default wsgi.url_scheme value, default is 'http'. 

   --url-prefix=STR 
        The ``SCRIPT_NAME`` WSGI environment value.  Setting this to anything 
        except the empty string will cause the WSGI ``SCRIPT_NAME`` value to be 
        the value passed minus any trailing slashes you add, and it will cause 
        the ``PATH_INFO`` of any request which is prefixed with this value to 
        be stripped of the prefix.  Default is the empty string. 

    --ident=STR 
        Server identity used in the 'Server' header in responses. Default 
        is 'waitress'. 

Tuning options:

    --threads=INT 
        Number of threads used to process application logic, default is 4. 

    --backlog=INT 
        Connection backlog for the server. Default is 1024. 

    --recv-bytes=INT 
        Number of bytes to request when calling socket.recv(). Default is 
        8192. 

    --send-bytes=INT 
        Number of bytes to send to socket.send(). Default is 18000. 
        Multiples of 9000 should avoid partly-filled TCP packets. 

    --outbuf-overflow=INT 
        A temporary file should be created if the pending output is larger 
        than this. Default is 1048576 (1MB). 

    --outbuf-high-watermark=INT 
        The app_iter will pause when pending output is larger than this value 
        and will resume once enough data is written to the socket to fall below 
        this threshold. Default is 16777216 (16MB). 

    --inbuf-overflow=INT 
        A temporary file should be created if the pending input is larger 
        than this. Default is 524288 (512KB). 

    --connection-limit=INT 
        Stop creating new channels if too many are already active. 
        Default is 100. 

    --cleanup-interval=INT 
        Minimum seconds between cleaning up inactive channels. Default 
        is 30. See '--channel-timeout'. 

    --channel-timeout=INT 
        Maximum number of seconds to leave inactive connections open. 
        Default is 120. 'Inactive' is defined as 'has received no data 
        from the client and has sent no data to the client'. 

    --[no-]log-socket-errors 
        Toggle whether premature client disconnect tracebacks ought to be 
        logged. On by default. 

    --max-request-header-size=INT 
        Maximum size of all request headers combined. Default is 262144 
        (256KB). 

    --max-request-body-size=INT 
        Maximum size of request body. Default is 1073741824 (1GB). 

    --[no-]expose-tracebacks 
        Toggle whether to expose tracebacks of unhandled exceptions to the 
        client. Off by default. 

    --asyncore-loop-timeout=INT 
        The timeout value in seconds passed to asyncore.loop(). Default is 1. 

    --asyncore-use-poll 
        The use_poll argument passed to ``asyncore.loop()``. Helps overcome 
        open file descriptors limit. Default is False. 

    --channel-request-lookahead=INT 
        Allows channels to stay readable and buffer more requests up to the 
        given maximum even if a request is already being processed. This allows 
        detecting if a client closed the connection while its request is being 
        processed. Default is 0. 

Copied to clipboard