2. Administrator reference

2.1. Install a CherryPy application

2.2. Config options reference

2.2.1. List of core (ie: not for filters) config options:

  • [global] server.socketPort: port number where the server is listening (defaults to 8080)

  • [global] server.logFile: 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.

  • [global] server.logAccessFile: 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.

  • [global] server.logToScreen: 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.

  • [global] server.logTracebacks: 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.

  • [global] server.maxRequestHeaderSize: 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

  • [/path] server.maxRequestBodySize: 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

  • TODO: other config options

2.3. Configure an application

2.4. Production Setup

2.4.1. Quick overview

2.4.2. Servers

2.4.2.1. Built in server
2.4.2.2. Behind Apache
2.4.2.3. Built in server
2.4.2.4. FastCGI
2.4.2.5. mod_python