1
0
mirror of https://github.com/spl0k/supysonic.git synced 2024-11-10 04:02:17 +00:00
supysonic/docs/man/supysonic-server.rst
2021-11-06 17:52:49 +01:00

69 lines
2.0 KiB
ReStructuredText

================
supysonic-server
================
------------------------------------------------
Python implementation of the Subsonic server API
------------------------------------------------
:Author: Alban Féron
:Date: 2021
:Manual section: 1
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 (``--server gunicorn``).
--threads n
The number of worker threads for handling requests. Only applicable when
using the ``Gunicorn`` or ``Waitress`` WSGI server (``--server gunicorn`` or
``--server waitress``)
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)