diff options
author | Remi Delon <rdelon@cherrypy.org> | 2005-09-12 11:30:19 +0000 |
---|---|---|
committer | Remi Delon <rdelon@cherrypy.org> | 2005-09-12 11:30:19 +0000 |
commit | c9940b2bc8d28a5cd4e0ea8c7ec6a08a3af4aa96 (patch) | |
tree | 25fb2e8fa82f91183ec0590ef0c75b30f1d586a4 /docs | |
parent | fcd3d6e4b2b44728d7d34e940e40129555427094 (diff) | |
download | cherrypy-git-c9940b2bc8d28a5cd4e0ea8c7ec6a08a3af4aa96.tar.gz |
Started a "config options reference" in docs. Added docs for maxRequestHeaderSize and maxRequestBodySize
Diffstat (limited to 'docs')
-rw-r--r-- | docs/book/xml/adminreference.xml | 1 | ||||
-rw-r--r-- | docs/book/xml/configreference.xml | 24 |
2 files changed, 25 insertions, 0 deletions
diff --git a/docs/book/xml/adminreference.xml b/docs/book/xml/adminreference.xml index d246c27f..157793e8 100644 --- a/docs/book/xml/adminreference.xml +++ b/docs/book/xml/adminreference.xml @@ -6,6 +6,7 @@ <title>Administrator reference</title> <xi:include href="installapplication.xml"/> + <xi:include href="configreference.xml"/> <xi:include href="configureapplication.xml"/> <xi:include href="productionsetup.xml"/> </section> diff --git a/docs/book/xml/configreference.xml b/docs/book/xml/configreference.xml new file mode 100644 index 00000000..adffd317 --- /dev/null +++ b/docs/book/xml/configreference.xml @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="utf-8"?> +<section xmlns:db="http://docbook.org/docbook-ng" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xml:id="configreference"> + <title>Config options reference</title> + <section id="options"> + <title>List of core (ie: not for filters) config options:</title> + <itemizedlist> + <listitem> + <para><option>[global] server.socketPort</option>: port number where the server is listening (defaults to 8080)</para> + </listitem> + <listitem> + <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> + </listitem> + <listitem> + <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> + </listitem> + <listitem> + <para><option>TODO</option>: other config options</para> + </listitem> + </itemizedlist> + </section> +</section> |