.TH "UVICORN" "1" 
.SH "NAME" 
uvicorn \(em ASGI server implementation 
.SH "SYNOPSIS" 
.PP 
\fBuvicorn\fR [\fB\-\-host \fIHOST\fR\fP]  [\fB\-\-port \fIPORT\fR\fP]  [\fB\-\-uds \fIUNIX_SOCKET\fR\fP]  [\fB\-\-fd \fIFILE_DESCRIPTOR\fR\fP]  [\fB\-\-log-level \fILOG_LEVEL\fR\fP]  [\fB\-\-no-access-log\fP]  [\fB\-\-debug\fP]  [\fB\-\-loop \fILOOP\fR\fP]  [\fB\-\-http \fIHTTP_IMPLEMENTATION\fR\fP]  [\fB\-\-ws \fIWEBSOCKET_IMPLEMENTATION\fR\fP]  [\fB\-\-wsgi\fP]  [\fB\-\-ping-interval \fIPING_INTERVAL\fR\fP]  [\fB\-\-root-path \fIPATH\fR\fP]  [\fB\-\-proxy-headers\fP]  [\fB\-\-limit-concurrency \fICONNECTIONS\fR\fP]  [\fB\-\-limit-max-requests \fIREQUESTS\fR\fP]  [\fB\-\-timeout-keep-alive \fISECONDS\fR\fP]  [APP]  
.SH "DESCRIPTION" 
.PP 
This manual page documents briefly the 
\fBuvicorn\fR command. 
.PP 
This manual page was written for the \fBDebian\fP distribution 
because the original program does not have a manual page. 
.PP 
\fBuvicorn\fR is a program that provides an ASGI server implementation. 
 
.SH "OPTIONS" 
.PP 
This program follows the usual GNU command line syntax, 
with long options starting with two dashes (`\-').  A summary of 
options is included below. 
.IP "                    \fB\-\-host \fIHOST\fR\fP                 " 10 
Bind socket to this host. Use \-\-host 0.0.0.0 to make the application available on your local network. Default: '127.0.0.1'. 
.IP "                    \fB\-\-port \fIPORT\fR\fP                 " 10 
Bind to a socket with this port. Default: 8000. 
.IP "                    \fB\-\-uds \fIUNIX_SOCKET\fR\fP                 " 10 
Bind to a UNIX domain socket. Useful if you want to run Uvicorn behind a reverse proxy. 
.IP "                    \fB\-\-fd \fIFILE_DESCRIPTOR\fR\fP                 " 10 
Bind to socket from this file descriptor. Useful if you want to run Uvicorn within a process manager. 
.IP "                    \fB\-\-debug\fP                 " 10 
Enable debug mode. Provides error tracebacks in the browser, and enables auto-reloading. 
.IP "                    \fB\-\-log-level \fILOG_LEVEL\fR\fP                 " 10 
Set the log level. Options: 'critical', 'error', 'warning', 'info', 'debug'. Default: 'info'. 
.IP "                    \fB\-\-no-access-log\fP                 " 10 
Disable access log only, without changing log level. 
.IP "                    \fB\-\-loop \fILOOP\fR\fP                 " 10 
Set the event loop implementation. The uvloop implementation provides greater performance, but is not compatible with Windows or PyPy. 
Options: 'auto', 'asyncio', 'uvloop'. Default: 'auto'. 
.IP "                    \fB\-\-http \fIHTTP_IMPLEMENTATION\fR\fP                 " 10 
Set the HTTP protocol implementation. The httptools implementation provides greater performance, but it not compatible with PyPy, and 
requires compilation on Windows. Options: 'auto', 'h11', 'httptools'. Default: 'auto'. 
.IP "                    \fB\-\-ws \fIWEBSOCKET_IMPLEMENTATION\fR\fP                 " 10 
Set the WebSockets protocol implementation. Either of the websockets and wsproto packages are supported. Use 'none' to deny all 
websocket requests. Options: 'auto', 'none', 'websockets', 'wsproto'. Default: 'auto'. 
.IP "                    \fB\-\-wsgi\fP                 " 10 
Use WSGI as the application interface rather than ASGI. Note that WSGI mode always disables WebSocket support, as it is not supported 
by the WSGI interface. 
.IP "                    \fB\-\-root-path \fIPATH\fR\fP                 " 10 
Set the ASGI root_path for applications submounted below a given URL path. 
.IP "                    \fB\-\-proxy-headers\fP                 " 10 
Use the X-Forwarded-Proto and X-Forwarded-For headers to populate remote scheme/address info. 
.IP "                  \fB\-\-limit-concurrency \fICONNECTIONS\fR\fP                 " 10 
Maximum number of concurrent connections or tasks to allow, before issuing HTTP 503 responses. Useful for ensuring known memory usage 
patterns even under over-resourced loads. 
.IP "                  \fB\-\-limit-max-requests \fIREQUESTS\fR\fP                 " 10 
Maximum number of requests to service before terminating the process. Useful when running together with a process manager, for 
preventing memory leaks from impacting long-running processes. 
.IP "                  \fB\-\-timeout-keep-alive \fISECONDS\fR\fP                 " 10 
Close Keep-Alive connections if no new data is received within this timeout. Default: 5. 
.SH "ARGUMENTS" 
.IP "APP" 10 
The ASGI application to run, in the format "module:attribute". 
.SH "AUTHOR" 
.PP 
This manual page was written by fladi fladi@debian.org for 
the \fBDebian\fP system (and may be used by others).  Permission is 
granted to copy, distribute and/or modify this document under 
the terms of the GNU General Public License, Version 2 any 
later version published by the Free Software Foundation. 
 
.PP 
On Debian systems, the complete text of the GNU General Public 
License can be found in /usr/share/common-licenses/GPL. 
 
.\" created by instant / docbook-to-man