From a28c484d5d74f2508758044508735500f5afc877 Mon Sep 17 00:00:00 2001 From: "Paul J. Davis" Date: Mon, 27 Sep 2010 11:10:40 -0400 Subject: [PATCH] Fixed a typo in the docs. --- doc/htdocs/configure.html | 90 +++++++++++++++++++-------------------- gunicorn/config.py | 2 +- 2 files changed, 46 insertions(+), 46 deletions(-) diff --git a/doc/htdocs/configure.html b/doc/htdocs/configure.html index ff8e8b30..47e52bb4 100644 --- a/doc/htdocs/configure.html +++ b/doc/htdocs/configure.html @@ -116,8 +116,8 @@ for reference on setting at the command line.

config

The path to a Gunicorn config file.

Only has an effect when specified on the command line or as part of an @@ -129,8 +129,8 @@ application specific configuration.

bind

    -
  • -b ADDRESS, --bind ADDRESS
    • -
  • 127.0.0.1:8000
    • +
  • -b ADDRESS, --bind ADDRESS
    • +
  • 127.0.0.1:8000

The socket to bind.

A string of the form: 'HOST', 'HOST:PORT', 'unix:PATH'. An IP is a valid @@ -139,8 +139,8 @@ HOST.

backlog

    -
  • --backlog INT
    • -
  • 2048
    • +
  • --backlog INT
    • +
  • 2048

The maximum number of pending connections.

This refers to the number of clients that can be waiting to be served. @@ -155,8 +155,8 @@ load.

workers

    -
  • -w INT, --workers INT
    • -
  • 1
    • +
  • -w INT, --workers INT
    • +
  • 1

The number of worker process for handling requests.

A positive integer generally in the 2-4 x $(NUM_CORES) range. You'll @@ -166,30 +166,30 @@ application's work load.

worker_class

    -
  • -k STRING, --worker-class STRING
    • -
  • sync
    • +
  • -k STRING, --worker-class STRING
    • +
  • sync

The type of workers to use.

The default class (sync) should handle most 'normal' types of workloads. -You'll want to read http://gunicorn.org/design.hml for information on +You'll want to read http://gunicorn.org/design.html for information on when you might want to choose one of the other worker classes.

A string referring to one of the following bundled classes:

    -
  • sync
    • -
  • eventlet - Requires eventlet >= 0.9.7
    • -
  • gevent - Requires gevent >= 0.12.2 (?)
    • -
  • tornado - Requires tornado >= 0.2
    • +
  • sync
    • +
  • eventlet - Requires eventlet >= 0.9.7
    • +
  • gevent - Requires gevent >= 0.12.2 (?)
    • +
  • tornado - Requires tornado >= 0.2

Optionally, you can provide your own worker by giving gunicorn a MODULE:CLASS pair where CLASS is a subclass of gunicorn.workers.base.Worker. This alternative syntax will load the -gevent class: egg:gunicorn#gevent

+gevent class: egg:gunicorn#gevent

worker_connections

    -
  • --worker-connections INT
    • -
  • 1000
    • +
  • --worker-connections INT
    • +
  • 1000

The maximum number of simultaneous clients.

This setting only affects the Eventlet and Gevent worker types.

@@ -197,8 +197,8 @@ gevent class: egg:gunicorn#gevent

max_requests

    -
  • --max-requests INT
    • -
  • 0
    • +
  • --max-requests INT
    • +
  • 0

The maximum number of requests a worker will process before restarting.

Any value greater than zero will limit the number of requests a work @@ -210,8 +210,8 @@ restarts are disabled.

timeout

    -
  • -t INT, --timeout INT
    • -
  • 30
    • +
  • -t INT, --timeout INT
    • +
  • 30

Workers silent for more than this many seconds are killed and restarted.

Generally set to thirty seconds. Only set this noticeably higher if @@ -222,8 +222,8 @@ is not tied to the length of time required to handle a single request.

keepalive

    -
  • --keep-alive INT
    • -
  • 2
    • +
  • --keep-alive INT
    • +
  • 2

The number of seconds to wait for requests on a Keep-Alive connection.

Generally set in the 1-5 seconds range.

@@ -235,7 +235,7 @@ is not tied to the length of time required to handle a single request.

debug

  • --debug
    • -
  • False
    • +
  • False

Turn on debugging in the server.

This limits the number of worker processes to 1 and changes some error @@ -245,7 +245,7 @@ handling that's sent to clients.

spew

  • --spew
    • -
  • False
    • +
  • False

Install a trace function that spews every line executed by the server.

This is the nuclear option.

@@ -257,7 +257,7 @@ handling that's sent to clients.

preload_app

  • --preload
    • -
  • False
    • +
  • False

Load application code before the worker processes are forked.

By preloading an application you can save some RAM resources as well as @@ -269,7 +269,7 @@ restarting workers.

daemon

  • -D, --daemon
    • -
  • False
    • +
  • False

Daemonize the Gunicorn process.

Detaches the server from the controlling terminal and enters the @@ -278,8 +278,8 @@ background.

pidfile

    -
  • -p FILE, --pid FILE
    • -
  • None
    • +
  • -p FILE, --pid FILE
    • +
  • None

A filename to use for the PID file.

If not set, no PID file will be written.

@@ -287,8 +287,8 @@ background.

user

    -
  • -u USER, --user USER
    • -
  • None
    • +
  • -u USER, --user USER
    • +
  • None

Switch worker processes to run as this user.

A valid user id (as an integer) or the name of a user that can be @@ -298,8 +298,8 @@ the worker process user.

group

    -
  • -g GROUP, --group GROUP
    • -
  • None
    • +
  • -g GROUP, --group GROUP
    • +
  • None

Switch worker process to run as this group.

A valid group id (as an integer) or the name of a user that can be @@ -309,8 +309,8 @@ the worker processes group.

umask

    -
  • -m INT, --umask INT
    • -
  • 0
    • +
  • -m INT, --umask INT
    • +
  • 0

A bit mask for the file mode on files written by Gunicorn.

Note that this affects unix socket permissions.

@@ -321,7 +321,7 @@ int(value, 0) (0 means Python guesses the base, so values like "0",

tmp_upload_dir

    -
  • None
    • +
  • None

Directory to store temporary request data as they are read.

This may disappear in the near future.

@@ -335,8 +335,8 @@ temporary directory.

logfile

    -
  • --log-file FILE
    • -
  • -
    • +
  • --log-file FILE
    • +
  • -

The log file to write to.

"-" means log to stdout.

@@ -344,8 +344,8 @@ temporary directory.

loglevel

    -
  • --log-level LEVEL
    • -
  • info
    • +
  • --log-level LEVEL
    • +
  • info

The granularity of log outputs.

Valid level names are:

@@ -363,11 +363,11 @@ temporary directory.

proc_name

    -
  • -n STRING, --name STRING
    • -
  • gunicorn
    • +
  • -n STRING, --name STRING
    • +
  • None

A base to use with setproctitle for process naming.

-

This affects things like ps and top. If you're going to be +

This affects things like ps and top. If you're going to be running more than one instance of Gunicorn you'll probably want to set a name to tell them apart. This requires that you install the setproctitle module.

@@ -376,7 +376,7 @@ module.

default_proc_name

    -
  • gunicorn
    • +
  • gunicorn

Internal setting that is adjusted for each type of application.

diff --git a/gunicorn/config.py b/gunicorn/config.py index 69681faf..6872b794 100644 --- a/gunicorn/config.py +++ b/gunicorn/config.py @@ -291,7 +291,7 @@ class WorkerClass(Setting): The type of workers to use. The default class (sync) should handle most 'normal' types of workloads. - You'll want to read http://gunicorn.org/design.hml for information on + You'll want to read http://gunicorn.org/design.html for information on when you might want to choose one of the other worker classes. A string referring to one of the following bundled classes: