You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Georg Krause 3a89cff4b5
Bump version number 1.1.0
4 months ago
.changelog Bump version number 1.1.0 4 months ago
mopidy_funkwhale Bump version number 1.1.0 4 months ago
tests Fix config tests 8 months ago
.editorconfig IInitial commit 4 years ago
.gitignore IInitial commit 4 years ago
.gitlab-ci.yml Install job dependencies 8 months ago
CHANGELOG.md Bump version number 1.1.0 4 months ago
HISTORY.rst IInitial commit 4 years ago
LICENSE IInitial commit 4 years ago
MANIFEST.in Better documentation 4 years ago
README.rst Document installation of python3-dev in README 2 years ago
pyproject.toml Configure right directory for changelog snippets 8 months ago
setup.cfg Lint codebase and add CI job 8 months ago
setup.py Lint codebase and add CI job 8 months ago

README.rst

================
mopidy-funkwhale
================

A small `Mopidy`_ backend extension to stream music from a Funkwhale server.


Features
--------

* Searching for tracks, albums and artists available in your Funkwhale instance
* Browse all libraries, artists and albums
* Browse your favorites
* Simple configuration

Installation
------------

We assume you have a Mopidy server available (version 3 or greater required).

.. code-block:: shell

apt-get install libcairo2-dev libgirepository1.0-dev python3-dev
sudo python3 -m pip install mopidy-funkwhale


.. note::

Depending on your setup, you may want to run this comand with ``sudo`` or ``--user``


Configuration
-------------

To enable the extension, add the following to your ``mopidy.conf`` file::

[funkwhale]
enabled = true
# URL of your funkwhale instance
url = https://demo.funkwhale.audio
# Application credentials (leave empty fo anonymous access)
# If you don't now what to put here, just run `mopidy funkwhale login` for
# the instructions
client_id =
client_secret =
# If for some reason, you want to use the legacy password-based auth,
# uncomment the variables below
# username = demo
# password = demo

# duration of cache entries before they are removed, in seconds
# 0 to cache forever, empty to disable cache
cache_duration = 600

Of course, replace the demo values with your actual info (but you can
try using the demo server).

After that, reload your mopidy daemon, and you should be good!

Authorization
-------------

This plugin support the OAuth authorization workflow that is included in Funkwhale 0.19.

Run ``mopidy funkwhale login`` to perform authorization.

.. _Mopidy: https://www.mopidy.com/
.. _ncmpcpp: https://wiki.archlinux.org/index.php/ncmpcpp
.. _iris: https://github.com/jaedb/iris