Mopidy-HTTP — Mopidy 2.1.0 documentation

# 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.

When it is enabled it starts a web server at the port specified by the `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 `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.

## Hosting web clients

Mopidy-HTTP’s web server can also host Tornado apps or any static files, for example the HTML, CSS, JavaScript, and images needed for a web based Mopidy client. See HTTP server side API for how to make static files or server-side functionality from a Mopidy extension available through Mopidy’s web server.

If you’re making a web based client and want to do server side development using some other technology than Tornado, you are of course free to run your own web server and just use Mopidy’s web server to host the API endpoints. But, for clients implemented purely in JavaScript, letting Mopidy host the files is a simpler solution.

See HTTP JSON-RPC 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 HTTP clients.

## Configuration

See Configuration for general help on configuring Mopidy.

    [http]
    enabled = true
    hostname = 127.0.0.1
    port = 6680
    static_dir =
    zeroconf = Mopidy HTTP server on $hostname

`http/enabled`

  If the HTTP extension should be enabled or not.

`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

`http/port`

  Which TCP port the HTTP server should listen to.

`http/static_dir`

  Deprecated: This config is deprecated and will be removed in a future version of Mopidy.

  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, but any other Mopidy webclient installed with pip to be served at “/ext_name” will stop working if you set this config.

  You’re strongly encouraged to make Mopidy extensions which use the the HTTP server side API to host static files on Mopidy’s web server instead of using `http/static_dir`. That way, installation of your web client will be a lot easier for your end users, and multiple web clients can easily share the same web server.

`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.