HYPERCORN(1)

πŸ‘‘ HYPERCORN πŸ‘‘

okay bestie, you found it β€” this is the manual page for hypercorn 0.18.0, living in section 1 of the manual (User Commands, the classic). she's a whole ASGI server and she's iconic. let's get into it πŸ’…βœ¨


🌸 NAME 🌸

hypercorn β€” manual page for hypercorn 0.18.0


✨ DESCRIPTION ✨

so like, the whole vibe is: you point hypercorn at your app and it serves it. that's the tea. πŸ«– here's the full usage situation, character for character, no cap:

usage: hypercorn [-h] [--access-log ACCESS_LOG]

       [--access-logfile ACCESS_LOGFILE] [--access-logformat
       ACCESS_LOGFORMAT] [--backlog BACKLOG] [-b BINDS] [--ca-certs
       CA_CERTS] [--certfile CERTFILE] [--cert-reqs CERT_REQS]
       [--ciphers CIPHERS] [-c CONFIG] [-D] [--debug] [--error-log
       ERROR_LOG] [--error-logfile ERROR_LOGFILE] [--graceful-timeout
       GRACEFUL_TIMEOUT] [--read-timeout READ_TIMEOUT] [--max-requests
       MAX_REQUESTS] [--max-requests-jitter MAX_REQUESTS_JITTER] [-g
       GROUP] [-k WORKER_CLASS] [--keep-alive KEEP_ALIVE] [--keyfile
       KEYFILE] [--keyfile-password KEYFILE_PASSWORD] [--insecure-bind
       INSECURE_BINDS] [--log-config LOG_CONFIG] [--log-level LOG_LEVEL]
       [-p PID] [--quic-bind QUIC_BINDS] [--reload] [--root-path
       ROOT_PATH] [--server-name SERVER_NAMES] [--statsd-host
       STATSD_HOST] [--statsd-prefix STATSD_PREFIX] [-m UMASK] [-u USER]
       [--verify-mode VERIFY_MODE] [--websocket-ping-interval
       WEBSOCKET_PING_INTERVAL] [-w WORKERS] application

yeah it's a lot. that's just how she is. lowkey slay πŸ’–


🫢 positional arguments:

  • application β€” the app you're dispatching to, written as path.to.module:instance.path. that's literally the whole thing, bestie, and you cannot skip her.

πŸ’… options:

  • -h, --help β€” shows this help message and dips. the classic. ✨
  • --access-log ACCESS_LOG β€” deprecated πŸ’€ go look at access-logfile instead, okay?
  • --access-logfile ACCESS_LOGFILE β€” where the access log goes. use - for stdout.
  • --access-logformat ACCESS_LOGFORMAT β€” the log format for the access log. see help docs for the deets.
  • --backlog BACKLOG β€” the maximum number of pending connections. she's got a queue and it has a limit.
  • -b, --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. pick your fighter πŸŽ€
  • --ca-certs CA_CERTS β€” path to the SSL CA certificate file
  • --certfile CERTFILE β€” path to the SSL certificate file
  • --cert-reqs CERT_REQS β€” see the verify mode argument, iykyk
  • --ciphers CIPHERS β€” ciphers to use for the SSL setup πŸ”
  • -c, --config CONFIG β€” location of a TOML config file, or when prefixed with file: a Python file, or when prefixed with python: a Python module. three formats, one flag, versatility queen πŸ‘‘
  • -D, --daemon β€” run the workers as daemons
  • --debug β€” enable debug mode, i.e. extra logging and checks. she gets chatty and nosy. 🐈
  • --error-log ERROR_LOG β€” deprecated, see error-logfile
  • --error-logfile, --log-file ERROR_LOGFILE β€” the target location for the error log. use - for stderr.
  • --graceful-timeout GRACEFUL_TIMEOUT β€” time to wait after SIGTERM or Ctrl-C for any remaining requests (tasks) to complete. she's not gonna ghost mid-request, she's polite. 🫢
  • --read-timeout READ_TIMEOUT β€” seconds to wait before timing out reads on TCP sockets
  • --max-requests MAX_REQUESTS β€” maximum number of requests a worker will process before restarting. little refresh, little reset. 🌱
  • --max-requests-jitter MAX_REQUESTS_JITTER β€” this jitter causes the max-requests per worker to be randomized by randint(0, max_requests_jitter)
  • -g, --group GROUP β€” group to own any unix sockets.
  • -k, --worker-class WORKER_CLASS β€” the type of worker to use. options include asyncio, uvloop (pip install hypercorn[uvloop]), and trio (pip install hypercorn[trio]). choose your era ✨
  • --keep-alive KEEP_ALIVE β€” seconds to keep inactive connections alive for. she keeps the convo going even when you're quiet. πŸ’¬
  • --keyfile KEYFILE β€” path to the SSL key file
  • --keyfile-password KEYFILE_PASSWORD β€” password to decrypt 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. this can be prefixed with json: or toml: to load the configuration from a file in that format. default is the logging ini format.
  • --log-level LOG_LEVEL β€” the (error) log level, defaults to info
  • -p, --pid PID β€” location to write the PID (Program ID) to. so you can find her later πŸ₯Ί
  • --quic-bind QUIC_BINDS β€” the UDP/QUIC host/address to bind to. see bind for formatting options.
  • --reload β€” enable automatic reloads on code changes. she notices when you change your fit. πŸ”„
  • --root-path ROOT_PATH β€” the setting for the ASGI root_path variable
  • --server-name SERVER_NAMES β€” the hostnames that can be served. requests to different hosts will be responded to with 404s. strict boundaries, honestly healthy. πŸ’…
  • --statsd-host STATSD_HOST β€” the host:port of the statsd server
  • --statsd-prefix STATSD_PREFIX β€” prefix for all statsd messages
  • -m, --umask UMASK β€” the permissions bit mask to use on any unix sockets.
  • -u, --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.
  • --websocket-ping-interval WEBSOCKET_PING_INTERVAL β€” if set this is the time in seconds between pings sent to the client. this can be used to keep the websocket connection alive. little "you up?" texts, but make it protocol. πŸ“‘
  • -w, --workers WORKERS β€” the number of workers to spawn and use

and that's the whole page, bestie, you made it to the end πŸŽ€ this was hypercorn 0.18.0, dated October 2026, filed under HYPERCORN(1). go configure something gorgeous. mwah πŸ«ΆπŸ’–βœ¨

πŸ“¦ where this page comes from