README.rst 1.82 KB
Newer Older
Eliot Berriot's avatar
Eliot Berriot committed
1
2
3
4
================
mopidy-funkwhale
================

Eliot Berriot's avatar
Eliot Berriot committed
5
A small `Mopidy`_ backend extension to stream music from a Funkwhale server.
Eliot Berriot's avatar
Eliot Berriot committed
6
7


Eliot Berriot's avatar
Eliot Berriot committed
8
9
Features
--------
Eliot Berriot's avatar
Eliot Berriot committed
10

Eliot Berriot's avatar
Eliot Berriot committed
11
* Searching for tracks, albums and artists available in your Funkwhale instance
12
* Browse all libraries, artists and albums
13
* Browse your favorites
Eliot Berriot's avatar
Eliot Berriot committed
14
* Simple configuration
Eliot Berriot's avatar
Eliot Berriot committed
15

Eliot Berriot's avatar
Eliot Berriot committed
16
17
Installation
------------
Eliot Berriot's avatar
Eliot Berriot committed
18

Georg Krause's avatar
Georg Krause committed
19
We assume you have a Mopidy server available (version 3 or greater required).
Eliot Berriot's avatar
Eliot Berriot committed
20

Eliot Berriot's avatar
Eliot Berriot committed
21
.. code-block:: shell
Eliot Berriot's avatar
Eliot Berriot committed
22

23
    apt-get install libcairo2-dev libgirepository1.0-dev python3-dev
Antipiot's avatar
Antipiot committed
24
    sudo python3 -m pip install mopidy-funkwhale
Antipiot's avatar
Antipiot committed
25

Eliot Berriot's avatar
Eliot Berriot committed
26

Eliot Berriot's avatar
Eliot Berriot committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
.. 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
Eliot Berriot's avatar
Eliot Berriot committed
41
42
43
44
45
46
47
48
49
50
    # 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

51
52
53
    # duration of cache entries before they are removed, in seconds
    # 0 to cache forever, empty to disable cache
    cache_duration = 600
Eliot Berriot's avatar
Eliot Berriot committed
54
55
56

Of course, replace the demo values with your actual info (but you can
try using the demo server).
Eliot Berriot's avatar
Eliot Berriot committed
57

Eliot Berriot's avatar
Eliot Berriot committed
58
After that, reload your mopidy daemon, and you should be good!
59

Eliot Berriot's avatar
Eliot Berriot committed
60
61
62
63
64
65
66
Authorization
-------------

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

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

Eliot Berriot's avatar
Eliot Berriot committed
67
68
69
.. _Mopidy: https://www.mopidy.com/
.. _ncmpcpp: https://wiki.archlinux.org/index.php/ncmpcpp
.. _iris: https://github.com/jaedb/iris