An open API service indexing awesome lists of open source software.

https://github.com/mopidy/mopidy-beets

Mopidy extension for playing music from a Beets collection
https://github.com/mopidy/mopidy-beets

beets mopidy mopidy-backend python

Last synced: 22 days ago
JSON representation

Mopidy extension for playing music from a Beets collection

Awesome Lists containing this project

README

        

************
Mopidy-Beets
************

.. image:: https://img.shields.io/pypi/v/Mopidy-Beets
:target: https://pypi.org/project/Mopidy-Beets/
:alt: Latest PyPI version

.. image:: https://img.shields.io/github/actions/workflow/status/mopidy/mopidy-beets/ci.yml?branch=main
:target: https://github.com/mopidy/mopidy-beets/actions
:alt: CI build status

.. image:: https://img.shields.io/codecov/c/gh/mopidy/mopidy-beets
:target: https://codecov.io/gh/mopidy/mopidy-beets
:alt: Test coverage

`Mopidy `_ extension for browsing, searching and
playing music from a music collection managed via `Beets `_.
This extension uses the
`Beets plugin "web" `_.

Installation
============

Install by running::

sudo python3 -m pip install Mopidy-Beets

See https://mopidy.com/ext/beets/ for alternative installation methods.

Configuration
=============

#. Setup the `Beets web plugin
`_.

#. Tell Mopidy where to find the Beets web interface by adding the following to
your ``mopidy.conf``::

[beets]
hostname = 127.0.0.1
port = 8337

#. Restart Mopidy.

#. The Beets library is now accessible in the "browser" section of your Mopidy
client. Additionally searches in Mopidy return results from your Beets
library.

Proxy configuration for OGG files (optional)
--------------------------------------------

In case you use a beets version older than 1.6.1, you may need to configure
an HTTP reverse-proxy server in front of the Beets web plugin (not mopidy)
because `it does not handle HTTP "Range" requests properly `_.
If you don't apply this workaround, mopidy may not be able to stream/play
large audio files and/or does not allow you to seek.
The is the case for OGG files in particular.

The following Nginx configuration snippet is sufficient::

server {
listen 127.0.0.1:8338;
root /usr/share/beets/beetsplug/web;
server_name beets.local;
location / {
proxy_pass http://localhost:8337;
# this statement forces Nginx to emulate "Range" responses
proxy_force_ranges on;
# Hide Range header from beets/flask, preventing range handling
proxy_set_header "Range" "";
}
}

Now you should change the mopidy configuration accordingly to point to the
Nginx port above instead of the Beets port. Afterwards mopidy will be able to
play file formats that require seeking.

Usage
=====

#. Run ``beet web`` to start the Beets web interface.

#. Start Mopidy and access your Beets library via any Mopidy client:

* Browse your collection by album

* Search for tracks or albums

* Let the music play!

Project resources
=================

- `Source code `_
- `Issue tracker `_
- `Changelog `_

Credits
=======

- Original author: `Janez Troha `_
- Current maintainer: `Lars Kruse `_
- `Contributors `_