Download Install Tutorial Docs FAQ Tools WikiLicense Team IRC Planet Involvement Shop Book

root/branches/cherrypy-2.1/docs/book/xml/configreference.xml

Revision 677 (checked in by dowski, 3 years ago)

Added descriptions of all the core config options that I am aware of related to logging.

Line 
1 <?xml version="1.0" encoding="utf-8"?>
2 <section xmlns:db="http://docbook.org/docbook-ng"
3          xmlns:xi="http://www.w3.org/2001/XInclude"
4          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
5          xml:id="configreference">
6   <title>Config options reference</title>
7   <section id="options">
8     <title>List of core (ie: not for filters) config options:</title>
9     <itemizedlist>
10       <listitem>
11         <para><option>[global] server.socketPort</option>: port number where the server is listening (defaults to 8080)</para>
12       </listitem>
13       <listitem>
14         <para><option>[global] server.logFile</option>: path to a file to log CherryPy server activity.  Items logged include startup config info, tracebacks and HTTP requests.  It is disabled by default and everything is logged to the screen.</para>
15       </listitem>
16       <listitem>
17         <para><option>[global] server.logAccessFile</option>: path to a file where access log data will be stored in Common Log Format.  The default is to write access log data to the screen.  If a file is specified, the access log data is no longer written to the screen.</para>
18       </listitem>
19       <listitem>
20         <para><option>[global] server.logToScreen</option>: controls whether any log data is written to the screen.  It defaults to on (True).  For performance reasons, it is best to have this option turned off on a production server.</para>
21       </listitem>
22       <listitem>
23         <para><option>[global] server.logTracebacks</option>: controls whether or not tracebacks are written to the log (screen or otherwise).  Defaults to on (True)  If set to False, only a 500 return code will be logged in the access log.</para>
24       </listitem>
25       <listitem>
26         <para><option>[global] server.maxRequestHeaderSize</option>: maximum acceptable size of a request header, in bytes (defaults to 500KB). If a longer request arrives, the server will interrupt it and return a 413 error. This setting is global (ie: doesn't depend on the path). Set it to zero to remove the limit</para>
27       </listitem>
28       <listitem>
29         <para><option>[/path] server.maxRequestBodySize</option>: maximum acceptable size of a request body, in bytes (defaults to 100MB). If a longer request body arrives, the server will interrupt it and return a 413 error. This setting can be configured per path. This is useful to limit the size of uploaded files. Set it to zero to remove the limit</para>
30       </listitem>
31       <listitem>
32         <para><option>TODO</option>: other config options</para>
33       </listitem>
34     </itemizedlist>
35   </section>
36 </section>
Note: See TracBrowser for help on using the browser.

Hosted by WebFaction

Log in as guest/cpguest to create tickets