/usr/share/doc/python-waitress-doc/html/arguments.html is in python-waitress-doc 0.8.10-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Arguments to waitress.serve — waitress 0.8.10 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.8.10',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="waitress 0.8.10 documentation" href="index.html" />
<link rel="next" title="Support for wsgi.file_wrapper" href="filewrapper.html" />
<link rel="prev" title="waitress API" href="api.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="arguments-to-waitress-serve">
<span id="arguments"></span><h1>Arguments to <code class="docutils literal"><span class="pre">waitress.serve</span></code><a class="headerlink" href="#arguments-to-waitress-serve" title="Permalink to this headline">ΒΆ</a></h1>
<p>Here are the arguments you can pass to the <cite>waitress.serve`</cite> function or use
in <a class="reference internal" href="glossary.html#term-pastedeploy"><span class="xref std std-term">PasteDeploy</span></a> configuration (interchangeably):</p>
<dl class="docutils">
<dt>host</dt>
<dd>hostname or IP address (string) on which to listen, default <code class="docutils literal"><span class="pre">0.0.0.0</span></code>,
which means “all IP addresses on this host”.</dd>
<dt>port</dt>
<dd>TCP port (integer) on which to listen, default <code class="docutils literal"><span class="pre">8080</span></code></dd>
<dt>unix_socket</dt>
<dd><p class="first">Path of Unix socket (string), default is <code class="docutils literal"><span class="pre">None</span></code>. If a socket path is
specified, a Unix domain socket is made instead of the usual inet domain
socket.</p>
<p class="last">Not available on Windows.</p>
</dd>
<dt>unix_socket_perms</dt>
<dd>Octal permissions to use for the Unix domain socket (string), default is
<code class="docutils literal"><span class="pre">600</span></code>. Only used if <code class="docutils literal"><span class="pre">unix_socket</span></code> is not <code class="docutils literal"><span class="pre">None</span></code>.</dd>
<dt>threads</dt>
<dd>number of threads used to process application logic (integer), default
<code class="docutils literal"><span class="pre">4</span></code></dd>
<dt>trusted_proxy</dt>
<dd>IP address of a client allowed to override <code class="docutils literal"><span class="pre">url_scheme</span></code> via the
<code class="docutils literal"><span class="pre">X_FORWARDED_PROTO</span></code> header.</dd>
<dt>url_scheme</dt>
<dd>default <code class="docutils literal"><span class="pre">wsgi.url_scheme</span></code> value (string), default <code class="docutils literal"><span class="pre">http</span></code>; can be
overridden per-request by the value of the <code class="docutils literal"><span class="pre">X_FORWARDED_PROTO</span></code> header,
but only if the client address matches <code class="docutils literal"><span class="pre">trusted_proxy</span></code>.</dd>
<dt>ident</dt>
<dd>server identity (string) used in “Server:” header in responses, default
<code class="docutils literal"><span class="pre">waitress</span></code></dd>
<dt>backlog</dt>
<dd>backlog is the value waitress passes to pass to socket.listen()
(integer), default <code class="docutils literal"><span class="pre">1024</span></code>. This is the maximum number of incoming TCP
connections that will wait in an OS queue for an available channel. From
listen(1): “If a connection request arrives when the queue is full, the
client may receive an error with an indication of ECONNREFUSED or, if the
underlying protocol supports retransmission, the request may be ignored
so that a later reattempt at connection succeeds.”</dd>
<dt>recv_bytes</dt>
<dd>recv_bytes is the argument waitress passes to socket.recv() (integer),
default <code class="docutils literal"><span class="pre">8192</span></code></dd>
<dt>send_bytes</dt>
<dd>send_bytes is the number of bytes to send to socket.send() (integer),
default <code class="docutils literal"><span class="pre">18000</span></code>. Multiples of 9000 should avoid partly-filled TCP
packets, but don’t set this larger than the TCP write buffer size. In
Linux, /proc/sys/net/ipv4/tcp_wmem controls the minimum, default, and
maximum sizes of TCP write buffers.</dd>
<dt>outbuf_overflow</dt>
<dd>A tempfile should be created if the pending output is larger than
outbuf_overflow, which is measured in bytes. The default is 1MB
(<code class="docutils literal"><span class="pre">1048576</span></code>). This is conservative.</dd>
<dt>inbuf_overflow</dt>
<dd>A tempfile should be created if the pending input is larger than
inbuf_overflow, which is measured in bytes. The default is 512K
(<code class="docutils literal"><span class="pre">524288</span></code>). This is conservative.</dd>
<dt>connection_limit</dt>
<dd>Stop creating new channels if too many are already active (integer).
Default is <code class="docutils literal"><span class="pre">100</span></code>. Each channel consumes at least one file descriptor,
and, depending on the input and output body sizes, potentially up to
three, plus whatever file descriptors your application logic happens to
open. The default is conservative, but you may need to increase the
number of file descriptors available to the Waitress process on most
platforms in order to safely change it (see <code class="docutils literal"><span class="pre">ulimit</span> <span class="pre">-a</span></code> “open files”
setting). Note that this doesn’t control the maximum number of TCP
connections that can be waiting for processing; the <code class="docutils literal"><span class="pre">backlog</span></code> argument
controls that.</dd>
<dt>cleanup_interval</dt>
<dd>Minimum seconds between cleaning up inactive channels (integer), default
<code class="docutils literal"><span class="pre">30</span></code>. See “channel_timeout”.</dd>
<dt>channel_timeout</dt>
<dd>Maximum seconds to leave an inactive connection open (integer), default
<code class="docutils literal"><span class="pre">120</span></code>. “Inactive” is defined as “has received no data from a client
and has sent no data to a client”.</dd>
<dt>log_socket_errors</dt>
<dd>Boolean: turn off to not log premature client disconnect tracebacks.
Default: <code class="docutils literal"><span class="pre">True</span></code>.</dd>
<dt>max_request_header_size</dt>
<dd>maximum number of bytes of all request headers combined (integer), 256K
(<code class="docutils literal"><span class="pre">262144</span></code>) default)</dd>
<dt>max_request_body_size</dt>
<dd>maximum number of bytes in request body (integer), 1GB (<code class="docutils literal"><span class="pre">1073741824</span></code>)
default.</dd>
<dt>expose_tracebacks</dt>
<dd>Boolean: expose tracebacks of unhandled exceptions to client. Default:
<code class="docutils literal"><span class="pre">False</span></code>.</dd>
<dt>asyncore_loop_timeout</dt>
<dd>The <code class="docutils literal"><span class="pre">timeout</span></code> value (seconds) passed to <code class="docutils literal"><span class="pre">asyncore.loop</span></code> to run the
mainloop. Default: 1. (New in 0.8.3.)</dd>
<dt>asyncore_use_poll</dt>
<dd>Boolean: switch from using select() to poll() in <code class="docutils literal"><span class="pre">asyncore.loop</span></code>.
By default asyncore.loop() uses select() which has a limit of 1024
file descriptors. Select() and poll() provide basically the same
functionality, but poll() doesn’t have the file descriptors limit.
Default: False (New in 0.8.6)</dd>
<dt>url_prefix</dt>
<dd>String: the value used as the WSGI <code class="docutils literal"><span class="pre">SCRIPT_NAME</span></code> value. Setting this to
anything except the empty string will cause the WSGI <code class="docutils literal"><span class="pre">SCRIPT_NAME</span></code> value
to be the value passed minus any trailing slashes you add, and it will
cause the <code class="docutils literal"><span class="pre">PATH_INFO</span></code> of any request which is prefixed with this value to
be stripped of the prefix. Default: the empty string.</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="api.html" title="previous chapter"><code class="docutils literal"><span class="pre">waitress</span></code> API</a></li>
<li>Next: <a href="filewrapper.html" title="next chapter">Support for <code class="docutils literal"><span class="pre">wsgi.file_wrapper</span></code></a></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/arguments.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2012, Agendaless Consulting <chrism@plope.com>.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.7</a>
|
<a href="_sources/arguments.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
|