AIOWSGI-SERVE(1)

📦 version 0.7, in ubuntu jammy

✨ NAME ✨

aiowsgi-serve is a minimalist WSGI server that uses async 🦋 It's filed under User Commands, obviously 💅

aiowsgi-serve — minimalist WSGI server using async 🌈

🎀 DESCRIPTION 🎀

okay so this is how you call it, bestie 💖

aiowsgi-serve [OPTS] MODULE:OBJECT

💅 Standard options 💅

  • --help — pulls up this whole info dump again 🙈
  • --call — calls the given object to get the WSGI application ✨
  • --host=ADDR — the hostname or IP address to listen on 🌸 The default is '0.0.0.0', which means "all IP addresses on this host" 🌍
    • ⚠️ Note: may not be used together with --listen 🙅‍♀️
  • --port=PORT — the TCP port to listen on 🍓 The default is '8080'
    • ⚠️ Note: may not be used together with --listen 🙅‍♀️
  • --listen=ip:port — tells waitress to listen on an ip + port combo 🦋 Here's the vibe:
--listen=127.0.0.1:8080 --listen=[::1]:8080 --listen=*:8080

This option can be used multiple times to listen on multiple sockets, iconic 👑 A wildcard for the hostname is supported too, and it'll bind to both IPv4 and IPv6 depending on whether they're enabled or disabled.

  • --[no-]ipv4 — toggles IPv4 support on or off 🌷 Like, here's how you turn it off:
--no-ipv4

This disables IPv4 socket support. It also affects wildcard matching when generating the list of sockets.

  • --[no-]ipv6 — toggles IPv6 support on or off 🧚 Here's how you turn it on:
--no-ipv6

This turns on IPv6 socket support. It also affects wildcard matching when generating a list of sockets.

  • --unix-socket=PATH — the path of a Unix socket 🔌 If you specify a socket path, a Unix domain socket gets made instead of the usual inet domain socket.
    • > 😭 Not available on Windows, sorry bestie.
  • --unix-socket-perms=PERMS — octal permissions for the Unix domain socket 🔐 The default is '600'.
  • --url-scheme=STR — the default wsgi.url_scheme value 🌐 The default is 'http'.
  • --url-prefix=STR — this sets the SCRIPT_NAME WSGI environment value 💫 Setting it to anything except the empty string makes the WSGI SCRIPT_NAME value the value you passed, minus any trailing slashes you add. It also strips that prefix off the PATH_INFO of any request that starts with it. The default is the empty string.
  • --ident=STR — the server identity used in the 'Server' header in responses 🎀 The default is 'waitress'.

🔥 Tuning options 🔥

  • --threads=INT — the number of threads used to process application logic 🧵 The default is 4.
  • --backlog=INT — the connection backlog for the server 📥 The default is 1024.
  • --recv-bytes=INT — how many bytes to request when calling socket.recv() 📦 The default is 8192.
  • --send-bytes=INT — how many bytes to send to socket.send() 📤 The default is 18000. Multiples of 9000 should avoid partly-filled TCP packets, which is giving efficiency 💅
  • --outbuf-overflow=INT — a temporary file gets created if the pending output is larger than this 🗂️ The default is 1048576 (1MB).
  • --inbuf-overflow=INT — a temporary file gets created if the pending input is larger than this 🗃️ The default is 524288 (512KB).
  • --connection-limit=INT — stops creating new channels if too many are already active 🚦 The default is 100.
  • --cleanup-interval=INT — the minimum number of seconds between cleaning up inactive channels 🧹 The default is 30. See '--channel-timeout'.
  • --channel-timeout=INT — the maximum number of seconds to leave inactive connections open ⏳ The default is 120. "Inactive" is defined as "has received no data from the client and has sent no data to the client" 🫥
  • --[no-]log-socket-errors — toggles whether premature client disconnect tracebacks get logged 🪵 It's on by default.
  • --max-request-header-size=INT — the maximum size of all request headers combined 📜 The default is 262144 (256KB).
  • --max-request-body-size=INT — the maximum size of a request body 🍱 The default is 1073741824 (1GB).
  • --[no-]expose-tracebacks — toggles whether tracebacks of unhandled exceptions get exposed to the client 🙈 It's off by default.
  • --asyncore-loop-timeout=INT — the timeout value in seconds passed to asyncore.loop() ⏱️ The default is 1.
  • --asyncore-use-poll — the use_poll argument passed to asyncore.loop() 🦋 It helps overcome the open file descriptors limit. The default is False.

🌈 LICENSE 🌈

MIT 🌸

👑 AUTHOR 👑

Gael Pasgrimaud 💜

🦋 aiowsgi-serve 0.7 · November 2018 · love you, bestie 💖

📦 where this page comes from