Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
cutelyst-wsgi2(1)	    General Commands Manual	     cutelyst-wsgi2(1)

NAME
       cutelyst-wsgi2  - Fast, developer-friendly WSGI server for Cutelyst ap-
       plications.

SYNOPSIS
       cutelyst-wsgi2 [OPTIONS]

DESCRIPTION
       cutelyst-wsgi2 is a Web Service Gateway	Interface  (WSGI)  server  for
       Cutelyst	applications that can either be	used as	standalone HTTP	server
       or as a gateway between your Cutelyst application and another webserver
       like Apache or nginx.

OPTIONS
   Generic Program Information
       -h, --help
	      Output a usage message and exit

       -v, --version
	      Output the version number	of cutelyst-wsgi2 and exit.

   Load	Application
       -a, --application file
	      Application to load.

       -r, --auto-restart
	      Automatically restart when the application file changes.

       --pidfile file
	      Create pid file (before privileges drop).

       --pidfile2 file
	      Create pid file (after privileges	drop).

       --stop pidfile
	      Stop an instance identified by pidfile.

   Directories and Mountpoints
       --chdir directory
	      Change to	the specified directory	before the application loads.

       --chdir2	directory
	      Change  to the specifie directory	after the application has been
	      loaded.

       --static-map mountpoint=path
	      Map mountpoint to	static directory (or file).

       --static-map2 mountpoint=path
	      Like static-map but completely appending the requested  resource
	      to the docroot.

   Load	Configuration
       --ini file
	      Load configuration from ini file.

       -j, --json file
	      Load configuration from JSON file.

       --touch-reload file
	      Reload   the   application   if  the  specified  file  is	 modi-
	      fied/touched.

   Threads and Processes
       -M, --master
	      Enable master process.

       --lazy Set lazy mode (load application in workers instead of master).

       -p, --processes processes
	      Spawn the	specified number of processes.

       -t, --threads threads
	      Number of	threads	to use.

       --cpu-affinity core count
	      Set CPU affinity with the	number	of  CPUs  available  for  each
	      wokrker core.

       --experimental-thread-balancer
	      Balances new connections to threads using	round-robin.

   Sockets
       --h1, --http-socket address
	      Bind to the specified TCP	socket using HTTP protocol.

       --upgrade-h2c
	      Defines  if  an HTTP/1 connection	can be upgraded	to H2C (HTTP 2
	      Clear Text)

       --hs1, --https-socket address
	      Bind to the specified TCP	socket using HTTPS protocol

       --https-h2
	      Defines if HTTPS sockect should use ALPN to negotiate HTTP/2

       --h2, --http2-socket address
	      Bind to the specified TCP	socket using HTTP/2 only protocol.

       --http2-header-table-size  size
	      Defines the HTTP2	header table size (SETTINGS_HEADER_TABLE_SIZE)
	      default value: 4096

       --fastcgi-socket	address
	      Bind to the specified UNIX/TCP socket using FastCGI protocol.

       --socket-access options
	      Set  the	LOCAL  socket access, such as 'ugo' standing for User,
	      Group, Other access.

       --chown-socket uid:gid
	      Chown unix sockets.

       --reuse-port
	      Enable SO_REUSEPORT flag on socket (Linux	3.9+)

       -z, --socket-timeout seconds
	      Set internal sockets timeout in seconds.

   User	and Group
       --uid user/uid
	      Setuid to	the specified user/uid.

       --gid group/gid
	      Setgid to	the specified group/gid.

       --no-initgroups
	      Disable additional groups	set via	initgroups().

       --umask mode
	      Set file mode creation mask.

   TCP Settings
       --tcp-nodelay
	      Enable TCP NODELAY on each request.

       --so-keepalive
	      Enable TCP KEEPALIVEs.

   Buffer Sizes
       -b, --buffer-size bytes
	      Set internal buffer size in bytes.

       --post-buffering	bytes
	      Set size in bytes	after which will buffer	to disk	insted of mem-
	      ory.

       --post-buffering-bufsize	bytes
	      Set buff size in bytes for read()	in post	buffering mode.

       --socket-sndbuf bytes
	      Set SO_SNDBUF in bytes.

       --socket-rcvbuf bytes
	      Set SO_RCVBUF in bytes.

       --websocket-max-size Kbytes
	      Set  the	socket	receive	 buffer	size in	bytes at the OS	level.
	      This maps	to the SO_RCVBUF socket	option.

EXIT STATUS
       0 on success and	1 if something failed.

BUGS
       File  bug  reports  to  the  issue  system  of	the   GitHub   project
       <https://github.com/cutelyst/cutelyst/issues>.

EXAMPLE
   Start application with HTTP socket and load ini config file
       cutelyst-wsgi2  -M -a /path/to/cutelystapp.so --h1 localhost:3000 --ini
       /path/to/appconfig.ini

   Start application on	local FastCGI socket and protect socket	file
       cutelyst-wsgi2	-M   -a	   /path/to/cutelystapp.so    --fastcgi-socket
       /run/cutelystapp.sock   --chown-socket  myuser:www  --socket-access  ug
       --uid myuser

   Start application on	local FastCGI socket and store PID in file
       cutelyst-wsgi2	-M   -a	   /path/to/cutelystapp.so    --fastcgi-socket
       /run/cutelystapp.sock --pidfile /run/cutelystapp.pid

   Stop	application using pid file
       cutelyst-wsgi2 --stop /run/cutelystapp.pid

SEE ALSO
       cutelyst2(1)

cutelyst-wsgi2 2.11.0		  2018-03-20		     cutelyst-wsgi2(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXIT STATUS | BUGS | EXAMPLE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=cutelyst-wsgi2&sektion=1&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help