Go to file
Renovate Bot e9ae1860ed chore(deps): update python docker tag to v3.13 2024-10-08 00:33:50 +00:00
.changelog Bump version number 1.1.0 2022-06-12 17:47:02 +02:00
mopidy_funkwhale Bump version number 1.1.0 2022-06-12 17:47:02 +02:00
tests tests: Adjust assertion to work with python 3.12 2023-12-04 15:18:06 +01:00
.editorconfig IInitial commit 2018-10-03 18:34:45 +02:00
.gitignore IInitial commit 2018-10-03 18:34:45 +02:00
.gitlab-ci.yml chore(deps): update python docker tag to v3.13 2024-10-08 00:33:50 +00:00
CHANGELOG.md Bump version number 1.1.0 2022-06-12 17:47:02 +02:00
HISTORY.rst IInitial commit 2018-10-03 18:34:45 +02:00
LICENSE IInitial commit 2018-10-03 18:34:45 +02:00
MANIFEST.in Better documentation 2018-10-03 22:42:42 +02:00
README.rst Document installation of python3-dev in README 2021-03-16 10:35:35 +01:00
pyproject.toml Configure right directory for changelog snippets 2022-02-14 14:26:01 +01:00
renovate.json Add renovate.json 2023-06-28 08:58:38 +00:00
setup.cfg Lint codebase and add CI job 2022-02-06 11:59:20 +01:00
setup.py Lint codebase and add CI job 2022-02-06 11:59:20 +01:00

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