2979de0f94
Builds upon #725 to: - Remove extra config for Mopidy-HTTP Zeroconf service - Refactor Zeroconf setup code in the HTTP frontend a bit - Add documentation
115 lines
3.7 KiB
ReStructuredText
115 lines
3.7 KiB
ReStructuredText
.. _ext-http:
|
|
|
|
***********
|
|
Mopidy-HTTP
|
|
***********
|
|
|
|
Mopidy-HTTP is an extension that lets you control Mopidy through HTTP and
|
|
WebSockets, for example from a web client. It is bundled with Mopidy and
|
|
enabled by default if all dependencies are available.
|
|
|
|
When it is enabled it starts a web server at the port specified by the
|
|
:confval:`http/port` config value.
|
|
|
|
.. warning::
|
|
|
|
As a simple security measure, the web server is by default only available
|
|
from localhost. To make it available from other computers, change the
|
|
:confval:`http/hostname` config value. Before you do so, note that the HTTP
|
|
extension does not feature any form of user authentication or
|
|
authorization. Anyone able to access the web server can use the full core
|
|
API of Mopidy. Thus, you probably only want to make the web server
|
|
available from your local network or place it behind a web proxy which
|
|
takes care or user authentication. You have been warned.
|
|
|
|
|
|
Using a web based Mopidy client
|
|
===============================
|
|
|
|
Mopidy-HTTP's web server can also host any static files, for example the HTML,
|
|
CSS, JavaScript, and images needed for a web based Mopidy client. To host
|
|
static files, change the :confval:`http/static_dir` config value to point to
|
|
the root directory of your web client, for example::
|
|
|
|
[http]
|
|
static_dir = /home/alice/dev/the-client
|
|
|
|
If the directory includes a file named ``index.html``, it will be served on the
|
|
root of Mopidy's web server.
|
|
|
|
If you're making a web based client and wants to do server side development as
|
|
well, you are of course free to run your own web server and just use Mopidy's
|
|
web server to host the API end points. But, for clients implemented purely in
|
|
JavaScript, letting Mopidy host the files is a simpler solution.
|
|
|
|
See :ref:`http-api` for details on how to integrate with Mopidy over HTTP. If
|
|
you're looking for a web based client for Mopidy, go check out
|
|
:ref:`http-clients`.
|
|
|
|
|
|
Dependencies
|
|
============
|
|
|
|
In addition to Mopidy's dependencies, Mopidy-HTTP requires the following:
|
|
|
|
- cherrypy >= 3.2.2. Available as python-cherrypy3 in Debian/Ubuntu.
|
|
|
|
- ws4py >= 0.2.3. Available as python-ws4py in newer Debian/Ubuntu and from
|
|
`apt.mopidy.com <http://apt.mopidy.com/>`__ for older releases of
|
|
Debian/Ubuntu.
|
|
|
|
If you're installing Mopidy with pip, you can run the following command to
|
|
install Mopidy with the extra dependencies for required for Mopidy-HTTP::
|
|
|
|
pip install --upgrade Mopidy[http]
|
|
|
|
If you're installing Mopidy from APT, the additional dependencies needed for
|
|
Mopidy-HTTP are always included.
|
|
|
|
|
|
Configuration
|
|
=============
|
|
|
|
See :ref:`config` for general help on configuring Mopidy.
|
|
|
|
.. literalinclude:: ../../mopidy/http/ext.conf
|
|
:language: ini
|
|
|
|
.. confval:: http/enabled
|
|
|
|
If the HTTP extension should be enabled or not.
|
|
|
|
.. confval:: http/hostname
|
|
|
|
Which address the HTTP server should bind to.
|
|
|
|
``127.0.0.1``
|
|
Listens only on the IPv4 loopback interface
|
|
``::1``
|
|
Listens only on the IPv6 loopback interface
|
|
``0.0.0.0``
|
|
Listens on all IPv4 interfaces
|
|
``::``
|
|
Listens on all interfaces, both IPv4 and IPv6
|
|
|
|
.. confval:: http/port
|
|
|
|
Which TCP port the HTTP server should listen to.
|
|
|
|
.. confval:: http/static_dir
|
|
|
|
Which directory the HTTP server should serve at "/"
|
|
|
|
Change this to have Mopidy serve e.g. files for your JavaScript client.
|
|
"/mopidy" will continue to work as usual even if you change this setting.
|
|
|
|
.. confval:: http/zeroconf
|
|
|
|
Name of the HTTP service when published through Zeroconf. The variables
|
|
``$hostname`` and ``$port`` can be used in the name.
|
|
|
|
If set, the Zeroconf services ``_http._tcp`` and ``_mopidy-http._tcp`` will
|
|
be published.
|
|
|
|
Set to an empty string to disable Zeroconf for HTTP.
|