Usage¶
Hypercorn is invoked via the command line script hypercorn
$ hypercorn [OPTIONS] MODULE_APP
with MODULE_APP
has the pattern
$(MODULE_NAME):$(VARIABLE_NAME)
with the module name as a full
(dotted) path to a python module containing a named variable that
conforms to the ASGI framework specification.
Options¶
- The following options exist with the given usage,
-h, --help show this help message and exit --access-log ACCESS_LOG Deprecated, see access-logfile --access-logfile ACCESS_LOGFILE The target location for the access log, use - for stdout --access-logformat ACCESS_LOGFORMAT The log format for the access log, see help docs --backlog BACKLOG The maximum number of pending connections -b BINDS, --bind BINDS The TCP host/address to bind to. Should be either host:port, host, unix:path or fd://num, e.g. 127.0.0.1:5000, 127.0.0.1, unix:/tmp/socket or fd://33 respectively. --ca-certs CA_CERTS Path to the SSL CA certificate file --certfile CERTFILE Path to the SSL certificate file --cert-reqs CERT_REQS See verify mode argument --ciphers CIPHERS Ciphers to use for the SSL setup -c CONFIG, --config CONFIG Location of a TOML config file or when prefixed with python: a Python file. --debug Enable debug mode, i.e. extra logging and checks --error-log ERROR_LOG Deprecated, see error-logfile --error-logfile ERROR_LOGFILE, --log-file ERROR_LOGFILE The target location for the error log, use - for stderr -g GROUP, --group GROUP Group to own any unix sockets. -k WORKER_CLASS, --worker-class WORKER_CLASS The type of worker to use. Options include asyncio, uvloop (pip install hypercorn[uvloop]), and trio (pip install hypercorn[trio]). --keep-alive KEEP_ALIVE Seconds to keep inactive connections alive for --keyfile KEYFILE Path to the SSL key file --insecure-bind INSECURE_BINDS The TCP host/address to bind to. SSL options will not apply to these binds. See bind for formatting options. Care must be taken! See HTTP -> HTTPS redirection docs. --log-config LOG_CONFIG A Python logging configuration file. --log-level LOG_LEVEL The (error) log level, defaults to info -p PID, --pid PID Location to write the PID (Program ID) to. --quic-bind QUIC_BINDS The UDP/QUIC host/address to bind to. See bind for formatting options. --reload Enable automatic reloads on code changes --root-path ROOT_PATH The setting for the ASGI root_path variable --statsd-host STATSD_HOST The host:port of the statsd server --statsd-prefix STATSD_PREFIX Prefix for all statsd messages -m UMASK, --umask UMASK The permissions bit mask to use on any unix sockets. -u USER, --user USER User to own any unix sockets. --verify-mode VERIFY_MODE SSL verify mode for peer’s certificate, see ssl.VerifyMode enum for possible values. -w WORKERS, --workers WORKERS The number of workers to spawn and use