1
0
mirror of https://github.com/spl0k/supysonic.git synced 2024-12-23 01:16:18 +00:00
supysonic/docs/man/supysonic-server.rst
Louis-Philippe Véronneau 5c969e2f53
Modify the man pages for sphinx.
Closes #225.
2021-12-07 23:32:48 -05:00

58 lines
1.8 KiB
ReStructuredText

supysonic-server
================
SYNOPSIS
--------
supysonic-server [**--server** *gevent* | *gunicorn* | *waitress*] [**--host** <*hostname*>] [**--port** <*port*>] [**--socket** <*path*>] [**--processes** <*n*>] [**--threads** <*n*>]
DESCRIPTION
-----------
**supysonic-server** is the main supysonic's component, allowing to serve
content to clients. It is actually a basic wrapper over **Gevent**, **Gunicorn**
or **Waitress**, requiring at least one of them to be installed to run.
OPTIONS
-------
**-S** <*name*>, **--server** <*name*>
Specify which WSGI server to use. <*name*> must be one of ``gevent``,
``gunicorn`` or ``waitress`` and the matching package must then be
installed. If the option isn't provided, the first one available will be
used.
**-h** <*hostname*>, **--host** <*hostname*>
Hostname or IP address on which to listen. The default is ``0.0.0.0`` which
means to listen on all IPv4 interfaces on this host.
Cannot be used with **--socket**.
**-p** <*port*>, **--port** <*port*>
TCP port on which to listen. Default is ``5722``.
Cannot be used with **--socket**.
**-s** <*path*>, **--socket** <*path*>
Path of a Unix socket on which to bind to. If a path is specified, a Unix
domain socket is made instead of the usual inet domain socket.
Cannot be used with **--host** or **--port**.
Not available on Windows.
**--processes** <*n*>
Number of worker processes to spawn. Only applicable when using the
**Gunicorn** WSGI server.
**--threads** <*n*>
The number of worker threads for handling requests. Only applicable when
using the **Gunicorn** or **Waitress** WSGI server.
BUGS
----
Bugs can be reported to your distribution's bug tracker or upstream at
https://github.com/spl0k/supysonic/issues.
SEE ALSO
--------
``supysonic-cli (1)``