daphne — Django HTTP/WebSocket server
Contents
Arguments
channel_layer
The ASGI channel layer instance to use as path.to.module:instance.path.
Description
This manual page documents briefly the daphne command.
This manual page was written for the Debian distribution because the original program does not have a
manual page.
daphne is a program that manages the Celery Worker Daemons and their queues.
Name
daphne — Django HTTP/WebSocket server
Options
This program follows the usual GNU command line syntax, with long options starting with two dashes (`-').
A summary of options is included below.
-h--help
Show help message and exit.
-pPORT--portPORT
Port number to listen on.
-bHOST--bindHOST
The host/address to bind to.
--websocket_timeoutWEBSOCKET_TIMEOUT
Maximum time to allow a websocket to be connected. -1 for infinite.
--websocket_connect_timeoutWEBSOCKET_CONNECT_TIMEOUT
Maximum time to allow a connection to handshake. -1 for infinite.
-uUNIX_SOCKET--unix-socketUNIX_SOCKET
Bind to a UNIX socket rather than a TCP host/port.
--fdFILE_DESCRIPTOR
Bind to a file descriptor rather than a TCP host/port or named unix socket.
-eSOCKET_STRINGS--endpointSOCKET_STRINGS
Use raw server strings passed directly to twisted.
-vVERBOSITY--verbosityVERBOSITY
How verbose to make the output.
-tHTTP_TIMEOUT--http-timeoutHTTP_TIMEOUT
How long to wait for worker server before timing out HTTP connections.
--access-logACCESS_LOG
Where to write the access log (- for stdout, the default for verbosity=1).
--ping-intervalPING_INTERVAL
The number of seconds a WebSocket must be idle before a keepalive ping is sent.
--ping-timeoutPING_TIMEOUT
The number of seconds before a WebSocket is closed if no response to a keepalive ping.
--application-close-timeoutSECONDS
The number of seconds an ASGI application has to exit after client disconnect before it is
killed (Default: 10).
--ws-protocolWS_PROTOCOLS[WS_PROTOCOLS]
The WebSocket protocols you wish to support.
--root-pathROOT_PATH
The setting for the ASGI root_path variable.
--proxy-headers
Enable parsing and using of X-Forwarded-For and X-Forwarded-Port headers and using that as the
client address.
Synopsis
daphne [-h] [-pPORT][-bHOST][--websocket_timeoutWEBSOCKET_TIME_OUT][--websocket_connect_timeoutWEBSOCKET_CONNECT_TIMEOUT][-uUNIX_SOCKET][--fdFILE_DESCRIPTOR][-eSOCKET_STRINGS][-vVERBOSITY][-tHTTP_TIMEOUT][--access-logACCESS_LOG][--ping-intervalPING_INTERVAL][--ping-timeoutPING_TIMEOUT][--application-close-timeoutSECONDS>][--ws-protocolWS_PROTOCOLS[WS_PROTOCOLS...]][--root-pathROOT_PATH][--proxy-headers][channel_layer]
