jingrow/gunicorn
1
0
Fork 0
mirror of https://github.com/frappe/gunicorn.git synced 2026-01-14 11:09:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

sync doc

Browse Source
This commit is contained in:
benoitc 2012-02-29 14:12:10 +01:00
parent ce907348ef
commit 005b70ac23
1 changed files with 136 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

173
doc/htdocs/configure.html
View File

@ -235,6 +235,48 @@ is not tied to the length of time required to handle a single request.</p>
<p>Generally set in the 1-5 seconds range.</p>
</div>
</div>
<div class="section" id="security">
<h3><a class="toc-backref" href="#contents">Security</a></h3>
<div class="section" id="limit-request-line">
<h4><a class="toc-backref" href="#contents">limit_request_line</a></h4>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">--limit-request-line</span> INT</tt></li>
<li><tt class="docutils literal">4094</tt></li>
</ul>
<p>The maximum size of HTTP request line in bytes.</p>
<p>This parameter is used to limit the allowed size of a client's
HTTP request-line. Since the request-line consists of the HTTP
method, URI, and protocol version, this directive places a
restriction on the length of a request-URI allowed for a request
on the server. A server needs this value to be large enough to
hold any of its resource names, including any information that
might be passed in the query part of a GET request. By default
this value is 4094 and can't be larger than 8190.</p>
<p>This parameter can be used to prevent any DDOS attack.</p>
</div>
<div class="section" id="limit-request-fields">
<h4><a class="toc-backref" href="#contents">limit_request_fields</a></h4>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">--limit-request-fields</span> INT</tt></li>
<li><tt class="docutils literal">100</tt></li>
</ul>
<p>Limit the number of HTTP headers fields in a request.</p>
<p>Value is a number from 0 (unlimited) to 32768. This parameter is
used to limit the number of headers in a request to prevent DDOS
attack. Used with the <cite>limit_request_field_size</cite> it allows more
safety.</p>
</div>
<div class="section" id="limit-request-field-size">
<h4><a class="toc-backref" href="#contents">limit_request_field_size</a></h4>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">--limit-request-field_size</span> INT</tt></li>
<li><tt class="docutils literal">8190</tt></li>
</ul>
<p>Limit he allowed size of an HTTP request header field.</p>
<p>Value is a number from 0 (unlimited) to 8190. to set the limit
on the allowed size of an HTTP request header field.</p>
</div>
</div>
<div class="section" id="debugging">
<h3><a class="toc-backref" href="#contents">Debugging</a></h3>
<div class="section" id="debug">
@ -256,6 +298,14 @@ handling that's sent to clients.</p>
<p>Install a trace function that spews every line executed by the server.</p>
<p>This is the nuclear option.</p>
</div>
<div class="section" id="check-config">
<h4><a class="toc-backref" href="#contents">check_config</a></h4>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">--check-config</span></tt></li>
<li><tt class="docutils literal">False</tt></li>
</ul>
<p>Check the configuration..</p>
</div>
</div>
<div class="section" id="server-mechanics">
<h3><a class="toc-backref" href="#contents">Server Mechanics</a></h3>
@ -375,12 +425,14 @@ address of the client connection to gunicorn via a proxy.</p>
<h4><a class="toc-backref" href="#contents">access_log_format</a></h4>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">--access-logformat</span> STRING</tt></li>
<li><tt class="docutils literal">%(h)s %(l)s %(u)s %(t)s <span class="pre">&quot;%(r)s&quot;</span> %(s)s %(b)s <span class="pre">&quot;%(f)s&quot;</span> <span class="pre">&quot;%(a)s&quot;</span></tt></li>
<li><tt class="docutils literal"><span class="pre">&quot;%(h)s</span> %(l)s %(u)s %(t)s <span class="pre">&quot;%(r)s&quot;</span> %(s)s %(b)s <span class="pre">&quot;%(f)s&quot;</span> <span class="pre">&quot;%(a)s&quot;</span></tt></li>
</ul>
<p>The Access log format .</p>
<p>By default:</p>
<p>%(h)s %(l)s %(u)s %(t)s &quot;%(r)s&quot; %(s)s %(b)s &quot;%(f)s&quot; &quot;%(a)s&quot;</p>
<p>h: remote address
l: '-'
u: currently '-', may be user name in future releases
t: date of the request
r: status line (ex: GET / HTTP/1.1)
s: status
@ -388,9 +440,10 @@ b: response length or '-'
f: referer
a: user agent
T: request time in seconds
D: request time in microseconds</p>
<p>You can also pass any WSGI request header as a parameter.
(ex '%(HTTP_HOST)s').</p>
D: request time in microseconds,
p: process ID
{Header}i: request header
{Header}o: response header</p>
</div>
<div class="section" id="errorlog">
<h4><a class="toc-backref" href="#contents">errorlog</a></h4>
@ -431,6 +484,16 @@ python path to a subclass like gunicorn.glogging.Logger.
Alternatively the syntax can also load the Logger class
with <cite>egg:gunicorn#simple</cite></p>
</div>
<div class="section" id="logconfig">
<h4><a class="toc-backref" href="#contents">logconfig</a></h4>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">--log-config</span> FILE</tt></li>
<li><tt class="docutils literal">None</tt></li>
</ul>
<p>The log config file to use.
Gunicorn uses the standard Python logging module's Configuration
file format.</p>
</div>
</div>
<div class="section" id="process-naming">
<h3><a class="toc-backref" href="#contents">Process Naming</a></h3>
@ -455,6 +518,29 @@ module.</p>
<p>Internal setting that is adjusted for each type of application.</p>
</div>
</div>
<div class="section" id="django">
<h3><a class="toc-backref" href="#contents">Django</a></h3>
<div class="section" id="django-settings">
<h4><a class="toc-backref" href="#contents">django_settings</a></h4>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">--settings</span> STRING</tt></li>
<li><tt class="docutils literal">None</tt></li>
</ul>
<p>The Python path to a Django settings module.</p>
<p>e.g. 'myproject.settings.main'. If this isn't provided, the
DJANGO_SETTINGS_MODULE environment variable will be used.</p>
</div>
<div class="section" id="pythonpath">
<h4><a class="toc-backref" href="#contents">pythonpath</a></h4>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">--pythonpath</span> STRING</tt></li>
<li><tt class="docutils literal">None</tt></li>
</ul>
<p>A directory to add to the Python path for Django.</p>
<p>e.g.
'/home/djangoprojects/myproject'.</p>
</div>
</div>
<div class="section" id="server-hooks">
<h3><a class="toc-backref" href="#contents">Server Hooks</a></h3>
<div class="section" id="on-starting">
@ -486,7 +572,7 @@ def on_reload(server):
<h4><a class="toc-backref" href="#contents">when_ready</a></h4>
<ul>
<li><pre class="first literal-block">
def start_server(server):
def when_ready(server):
pass
</pre>
</li>
@ -605,46 +691,59 @@ the just-exited Worker.</p>
<li><a class="reference internal" href="#keepalive" id="id18">keepalive</a></li>
</ul>
</li>
<li><a class="reference internal" href="#debugging" id="id19">Debugging</a><ul>
<li><a class="reference internal" href="#debug" id="id20">debug</a></li>
<li><a class="reference internal" href="#spew" id="id21">spew</a></li>
<li><a class="reference internal" href="#security" id="id19">Security</a><ul>
<li><a class="reference internal" href="#limit-request-line" id="id20">limit_request_line</a></li>
<li><a class="reference internal" href="#limit-request-fields" id="id21">limit_request_fields</a></li>
<li><a class="reference internal" href="#limit-request-field-size" id="id22">limit_request_field_size</a></li>
</ul>
</li>
<li><a class="reference internal" href="#server-mechanics" id="id22">Server Mechanics</a><ul>
<li><a class="reference internal" href="#preload-app" id="id23">preload_app</a></li>
<li><a class="reference internal" href="#daemon" id="id24">daemon</a></li>
<li><a class="reference internal" href="#pidfile" id="id25">pidfile</a></li>
<li><a class="reference internal" href="#user" id="id26">user</a></li>
<li><a class="reference internal" href="#group" id="id27">group</a></li>
<li><a class="reference internal" href="#umask" id="id28">umask</a></li>
<li><a class="reference internal" href="#tmp-upload-dir" id="id29">tmp_upload_dir</a></li>
<li><a class="reference internal" href="#secure-scheme-headers" id="id30">secure_scheme_headers</a></li>
<li><a class="reference internal" href="#x-forwarded-for-header" id="id31">x_forwarded_for_header</a></li>
<li><a class="reference internal" href="#debugging" id="id23">Debugging</a><ul>
<li><a class="reference internal" href="#debug" id="id24">debug</a></li>
<li><a class="reference internal" href="#spew" id="id25">spew</a></li>
<li><a class="reference internal" href="#check-config" id="id26">check_config</a></li>
</ul>
</li>
<li><a class="reference internal" href="#logging" id="id32">Logging</a><ul>
<li><a class="reference internal" href="#accesslog" id="id33">accesslog</a></li>
<li><a class="reference internal" href="#access-log-format" id="id34">access_log_format</a></li>
<li><a class="reference internal" href="#errorlog" id="id35">errorlog</a></li>
<li><a class="reference internal" href="#loglevel" id="id36">loglevel</a></li>
<li><a class="reference internal" href="#logger-class" id="id37">logger_class</a></li>
<li><a class="reference internal" href="#server-mechanics" id="id27">Server Mechanics</a><ul>
<li><a class="reference internal" href="#preload-app" id="id28">preload_app</a></li>
<li><a class="reference internal" href="#daemon" id="id29">daemon</a></li>
<li><a class="reference internal" href="#pidfile" id="id30">pidfile</a></li>
<li><a class="reference internal" href="#user" id="id31">user</a></li>
<li><a class="reference internal" href="#group" id="id32">group</a></li>
<li><a class="reference internal" href="#umask" id="id33">umask</a></li>
<li><a class="reference internal" href="#tmp-upload-dir" id="id34">tmp_upload_dir</a></li>
<li><a class="reference internal" href="#secure-scheme-headers" id="id35">secure_scheme_headers</a></li>
<li><a class="reference internal" href="#x-forwarded-for-header" id="id36">x_forwarded_for_header</a></li>
</ul>
</li>
<li><a class="reference internal" href="#process-naming" id="id38">Process Naming</a><ul>
<li><a class="reference internal" href="#proc-name" id="id39">proc_name</a></li>
<li><a class="reference internal" href="#default-proc-name" id="id40">default_proc_name</a></li>
<li><a class="reference internal" href="#logging" id="id37">Logging</a><ul>
<li><a class="reference internal" href="#accesslog" id="id38">accesslog</a></li>
<li><a class="reference internal" href="#access-log-format" id="id39">access_log_format</a></li>
<li><a class="reference internal" href="#errorlog" id="id40">errorlog</a></li>
<li><a class="reference internal" href="#loglevel" id="id41">loglevel</a></li>
<li><a class="reference internal" href="#logger-class" id="id42">logger_class</a></li>
<li><a class="reference internal" href="#logconfig" id="id43">logconfig</a></li>
</ul>
</li>
<li><a class="reference internal" href="#server-hooks" id="id41">Server Hooks</a><ul>
<li><a class="reference internal" href="#on-starting" id="id42">on_starting</a></li>
<li><a class="reference internal" href="#on-reload" id="id43">on_reload</a></li>
<li><a class="reference internal" href="#when-ready" id="id44">when_ready</a></li>
<li><a class="reference internal" href="#pre-fork" id="id45">pre_fork</a></li>
<li><a class="reference internal" href="#post-fork" id="id46">post_fork</a></li>
<li><a class="reference internal" href="#pre-exec" id="id47">pre_exec</a></li>
<li><a class="reference internal" href="#pre-request" id="id48">pre_request</a></li>
<li><a class="reference internal" href="#post-request" id="id49">post_request</a></li>
<li><a class="reference internal" href="#worker-exit" id="id50">worker_exit</a></li>
<li><a class="reference internal" href="#process-naming" id="id44">Process Naming</a><ul>
<li><a class="reference internal" href="#proc-name" id="id45">proc_name</a></li>
<li><a class="reference internal" href="#default-proc-name" id="id46">default_proc_name</a></li>
</ul>
</li>
<li><a class="reference internal" href="#django" id="id47">Django</a><ul>
<li><a class="reference internal" href="#django-settings" id="id48">django_settings</a></li>
<li><a class="reference internal" href="#pythonpath" id="id49">pythonpath</a></li>
</ul>
</li>
<li><a class="reference internal" href="#server-hooks" id="id50">Server Hooks</a><ul>
<li><a class="reference internal" href="#on-starting" id="id51">on_starting</a></li>
<li><a class="reference internal" href="#on-reload" id="id52">on_reload</a></li>
<li><a class="reference internal" href="#when-ready" id="id53">when_ready</a></li>
<li><a class="reference internal" href="#pre-fork" id="id54">pre_fork</a></li>
<li><a class="reference internal" href="#post-fork" id="id55">post_fork</a></li>
<li><a class="reference internal" href="#pre-exec" id="id56">pre_exec</a></li>
<li><a class="reference internal" href="#pre-request" id="id57">pre_request</a></li>
<li><a class="reference internal" href="#post-request" id="id58">post_request</a></li>
<li><a class="reference internal" href="#worker-exit" id="id59">worker_exit</a></li>
</ul>
</li>
</ul>